Microsoft Azure BatchServiceClient — Pools

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure BatchServiceClient — Pools
  description: 'Microsoft Azure BatchServiceClient — Pools. 13 operations. Lead operation: Microsoft Azure Adds A Pool To
    The Specified Account. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Pools
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: batchserviceclient-pools
    baseUri: ''
    description: Microsoft Azure BatchServiceClient — Pools business capability. Self-contained, no shared references.
    resources:
    - name: pools
      path: /pools
      operations:
      - name: microsoftazurepooladd
        method: POST
        description: Microsoft Azure Adds A Pool To The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pool
          in: body
          type: string
          description: The Pool to be added.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
      - name: microsoftazurepoollist
        method: GET
        description: Microsoft Azure Lists All Of The Pools In The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $filter
          in: query
          type: string
          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#lis
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: $expand
          in: query
          type: string
          description: An OData $expand clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Pools can be returned.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId
      path: /pools/{poolId}
      operations:
      - name: microsoftazurepooldelete
        method: DELETE
        description: Microsoft Azure Deletes A Pool From The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to delete.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurepoolexists
        method: HEAD
        description: Microsoft Azure Head Pools Poolid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to get.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurepoolget
        method: GET
        description: Microsoft Azure Get Pools Poolid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to get.
          required: true
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: $expand
          in: query
          type: string
          description: An OData $expand clause.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurepoolpatch
        method: PATCH
        description: Microsoft Azure Updates The Properties Of The Specified Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to update.
          required: true
        - name: poolPatchParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: pools-poolId-disableautoscale
      path: /pools/{poolId}/disableautoscale
      operations:
      - name: microsoftazurepooldisableautoscale
        method: POST
        description: Microsoft Azure Disables Automatic Scaling For A Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool on which to disable automatic scaling.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-enableautoscale
      path: /pools/{poolId}/enableautoscale
      operations:
      - name: microsoftazurepoolenableautoscale
        method: POST
        description: Microsoft Azure Enables Automatic Scaling For A Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool on which to enable automatic scaling.
          required: true
        - name: poolEnableAutoScaleParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: pools-poolId-evaluateautoscale
      path: /pools/{poolId}/evaluateautoscale
      operations:
      - name: microsoftazurepoolevaluateautoscale
        method: POST
        description: Microsoft Azure Gets The Result Of Evaluating An Automatic Scaling Formula On The Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool on which to evaluate the automatic scaling formula.
          required: true
        - name: poolEvaluateAutoScaleParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: pools-poolId-resize
      path: /pools/{poolId}/resize
      operations:
      - name: microsoftazurepoolresize
        method: POST
        description: Microsoft Azure Changes The Number Of Compute Nodes That Are Assigned To A Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to resize.
          required: true
        - name: poolResizeParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: pools-poolId-stopresize
      path: /pools/{poolId}/stopresize
      operations:
      - name: microsoftazurepoolstopresize
        method: POST
        description: Microsoft Azure Stops An Ongoing Resize Operation On The Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool whose resizing you want to stop.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
        - name: If-Match
          in: header
          type: string
          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 servic
        - name: If-None-Match
          in: header
          type: string
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: pools-poolId-updateproperties
      path: /pools/{poolId}/updateproperties
      operations:
      - name: microsoftazurepoolupdateproperties
        method: POST
        description: Microsoft Azure Updates The Properties Of The Specified Pool
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: poolId
          in: path
          type: string
          description: The ID of the Pool to update.
          required: true
        - name: poolUpdatePropertiesParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
    - name: poolusagemetrics
      path: /poolusagemetrics
      operations:
      - name: microsoftazurepoollistusagemetrics
        method: GET
        description: Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual Time Intervals, For The
          Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: starttime
          in: query
          type: string
          description: The earliest time from which to include metrics. This must be at least two and a half hours before
            the current time. If not specified this defaults to the start
        - name: endtime
          in: query
          type: string
          description: The latest time from which to include metrics. This must be at least two hours before the current time.
            If not specified this defaults to the end time of the la
        - name: $filter
          in: query
          type: string
          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#lis
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 results will be returned.
        - name: timeout
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          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.
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          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 directl
  exposes:
  - type: rest
    namespace: batchserviceclient-pools-rest
    port: 8080
    description: REST adapter for Microsoft Azure BatchServiceClient — Pools. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/pools
      name: pools
      description: REST surface for pools.
      operations:
      - method: POST
        name: microsoftazurepooladd
        description: Microsoft Azure Adds A Pool To The Specified Account
        call: batchserviceclient-pools.microsoftazurepooladd
        with:
          pool: rest.pool
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: microsoftazurepoollist
        description: Microsoft Azure Lists All Of The Pools In The Specified Account
        call: batchserviceclient-pools.microsoftazurepoollist
        with:
          $filter: rest.$filter
          $select: rest.$select
          $expand: rest.$expand
          maxresults: rest.maxresults
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pools/{poolid}
      name: pools-poolid
      description: REST surface for pools-poolId.
      operations:
      - method: DELETE
        name: microsoftazurepooldelete
        description: Microsoft Azure Deletes A Pool From The Specified Account
        call: batchserviceclient-pools.microsoftazurepooldelete
        with:
          poolId: rest.poolId
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
          If-Match: rest.If-Match
          If-None-Match: rest.If-None-Match
          If-Modified-Since: rest.If-Modified-Since
          If-Unmodified-Since: rest.If-Unmodified-Since
        outputParameters:
        - type: object
          mapping: $.
      - method: HEAD
        name: microsoftazurepoolexists
        description: Microsoft Azure Head Pools Poolid
        call: batchserviceclient-pools.microsoftazurepoolexists
        with:
          poolId: rest.poolId
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
          If-Match: rest.If-Match
          If-None-Match: rest.If-None-Match
          If-Modified-Since: rest.If-Modified-Since
          If-Unmodified-Since: rest.If-Unm

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/capabilities/batchserviceclient-pools.yaml