Pools

Deletes a pool from the specified account.

When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.

delete/pools/{poolId}

Path parameters

poolIdstring required

The ID of the pool to delete.

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