Pools

Changes the number of Compute Nodes that are assigned to a Pool.

Changed on

You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.

post/pools/{poolId}/resize

Request

  • Base URL
    {endpoint}
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/v2.0/authorize
    Scopeshttps://batch.core.windows.net//.default

Path parameters

poolIdstring required

The ID of the Pool to get.

Query parameters

api-versionstring required

The API version to use for this operation.

timeOutinteger

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.".

Headers

client-request-idstring

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.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc7231

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.

If-Modified-Sincestring date-time-rfc7231

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.

If-Unmodified-Sincestring date-time-rfc7231

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.

If-Matchstring

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.

If-None-Matchstring

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.

Request body

targetDedicatedNodesinteger

The desired number of dedicated Compute Nodes in the Pool.

targetLowPriorityNodesinteger

The desired number of Spot/Low-priority Compute Nodes in the Pool.

resizeTimeoutstring duration

The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). The time duration is specified in ISO 8601 format.

nodeDeallocationOption'requeue' | 'terminate' | 'taskcompletion' | 'retaineddata'

BatchNodeDeallocationOption enums

Response

The request has been accepted for processing, but processing has not yet completed.

Changes

    • warning

      deleted the query request parameter timeout

    • info

      api operation id Pool_Resize removed and replaced with Pools_ResizePool

    • info

      added the new optional query request parameter timeOut