Microsoft Azure Pools API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Pools API
tags:
- name: Pools
paths:
  /pools:
    get:
      operationId: microsoftAzureBatchListpools
      summary: Microsoft Azure Lists All Of The Pools In The Specified Account
      description: Lists all of the Pools in the specified Account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: maxresults
        in: query
        description: 'The maximum number of items to return in the response. A maximum of 1000

          applications can be returned.'
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
          maximum: 1000
          minimum: 1
      - name: $filter
        in: query
        description: 'An OData $filter clause. For more information on constructing this filter, see

          https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.'
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPoolListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Pool list:
          $ref: ./examples/PoolList_Basic.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      tags:
      - Pools
    post:
      operationId: microsoftAzureBatchCreatepool
      summary: Microsoft Azure Creates A Pool To The Specified Account
      description: When naming Pools, avoid including sensitive information such as user names or<br>secret project names. This information may appear in telemetry logs accessible<br>to Microsoft Support engineers.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Creates a CloudServiceConfiguration pool:
          $ref: ./examples/PoolCreate_CloudServiceConfiguration.json
        Creates a VirtualMachineConfiguration pool:
          $ref: ./examples/PoolCreate_VirtualMachineConfiguration.json
        Creates a VirtualMachineConfiguration pool with OS disk:
          $ref: ./examples/PoolCreate_OSDisk.json
        Creates a VirtualMachineConfiguration pool with ServiceArtifactReference:
          $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithServiceArtifactReference.json
        Creates a VirtualMachineConfiguration pool with containers:
          $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithContainers.json
        Creates a VirtualMachineConfiguration pool with extensions:
          $ref: ./examples/PoolCreate_VirtualMachineConfigurationWithExtensions.json
        Creates a pool with SecurityProfile:
          $ref: ./examples/PoolCreate_SecurityProfile.json
        Creates a pool with accelerated networking:
          $ref: ./examples/PoolCreate_AcceleratedNetworking.json
        Creates a pool with mount drive specified:
          $ref: ./examples/PoolCreate_MountConfiguration.json
        Creates a simple pool with resourceTags:
          $ref: ./examples/PoolCreate_ResourceTags.json
      tags:
      - Pools
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchPoolCreateContent'
        description: The Pool to be created.
        required: true
  /pools/{poolId}:
    get:
      operationId: microsoftAzureBatchGetpool
      description: Gets information about the specified Pool.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: poolId
        in: path
        description: The ID of the Pool to get.
        required: true
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchPool'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Add a VirtualMachineConfiguration pool with OS disk:
          $ref: ./examples/PoolGet_VirtualMachineConfigurationWithOSDisk.json
        Get a VirtualMachineConfiguration pool with SecurityProfile:
          $ref: ./examples/PoolGet_SecurityProfile.json
        Get a VirtualMachineConfiguration pool with ServiceArtifactReference:
          $ref: ./examples/PoolGet_VirtualMachineConfigurationWithServiceArtifactReference.json
        Get a VirtualMachineConfiguration pool with extensions:
          $ref: ./examples/PoolGet_VirtualMachineConfigurationWithExtensions.json
        Get a pool with AcceleratedNetworking:
          $ref: ./examples/PoolGet_AcceleratedNetworking.json
        Pool get:
          $ref: ./examples/PoolGet_Basic.json
      summary: Microsoft Azure Get Pools Poolid
      tags:
      - Pools
    patch:
      operationId: microsoftAzureBatchUpdatepool
      summary: Microsoft Azure Updates The Properties Of The Specified Pool
      description: This only replaces the Pool properties specified in the request. For example,<br>if the Pool has a StartTask associated with it, and a request does not specify<br>a StartTask element, then the Pool keeps the existing StartTask.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: poolId
        in: path
        description: The ID of the Pool to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Patch the Pool:
          $ref: ./examples/PoolPatch.json
      tags:
      - Pools
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchPoolUpdateContent'
        description: The pool properties to update.
        required: true
    delete:
      operationId: microsoftAzureBatchDeletepool
      summary: Microsoft Azure Deletes A Pool From The Specified Account
      description: 'When you request that a Pool be deleted, the following actions occur: the Pool<br>state is set to deleting; any ongoing resize operation on the Pool are stopped;<br>the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks<br>running on existing Compute Nodes are terminated and requeued (as if a resize<br>Pool operation had been requested with the default requeue option); finally,<br>the Pool is removed from the system. Because running Tasks are requeued, the<br>user can rerun these Tasks by updating their Job to target a different Pool.<br>The Tasks can then run on the new Pool. If you want to override the requeue<br>behavior, then you should call resize Pool explicitly to shrink the Pool to<br>zero size before deleting the Pool. If you call an Update, Patch or Delete API<br>on a Pool in the deleting state, it will fail with HTTP status code 409 with<br>error code PoolBeingDeleted.'
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: poolId
        in: path
        description: The ID of the Pool to get.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Pool delete:
          $ref: ./examples/PoolDelete.json
      tags:
      - Pools
    head:
      operationId: microsoftAzureBatchPoolexists
      description: Gets basic properties of a Pool.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: poolId
        in: path
        description: The ID of the Pool to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides

# --- truncated at 32 KB (380 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-pools-api-openapi.yml