Upgrades the operating system of the specified pool.
During an upgrade, the Batch service upgrades each compute node in the pool. When a compute node is chosen for upgrade, any tasks running on that node are removed from the node and returned to the queue to be rerun later (or on a different compute node). The node will be unavailable until the upgrade is complete. This operation results in temporarily reduced pool capacity as nodes are taken out of service to be upgraded. Although the Batch service tries to avoid upgrading all compute nodes at the same time, it does not guarantee to do this (particularly on small pools); therefore, the pool may be temporarily unavailable to run tasks. When this operation runs, the pool state changes to upgrading. When all compute nodes have finished upgrading, the pool state returns to active.
Path parameters
The ID of the pool to upgrade.
Query parameters
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
Client API Version.
Headers
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.
Whether the server should return the client-request-id in the response.
The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
An ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified.
An ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag.
Specify this header to perform the operation only if the resource has been modified since the specified date/time.
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.