Pools

Changes the number of compute nodes that are assigned to a pool.

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 nodes to remove. To remove specific nodes, use the pool remove nodes API instead.

post/pools/{poolId}/resize

Path parameters

poolIdstring required

The ID of the pool to resize.

Query parameters

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

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-rfc1123

The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

If-Matchstring

An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.

If-None-Matchstring

An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.

If-Modified-Sincestring date-time-rfc1123

Specify this header to perform the operation only if the resource has been modified since the specified date/time.

If-Unmodified-Sincestring date-time-rfc1123

Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

Response

The request to the Batch service was successful.

Changes