Pools

Updates the properties of the specified Pool.

Changed on

This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.

post/pools/{poolId}/updateproperties

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

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.

Request body

Response

There is no content to send for this request, but the headers may be useful.

Changes

    • warning

      deleted the query request parameter timeout

    • info

      api operation id Pool_UpdateProperties removed and replaced with Pools_ReplacePoolProperties

    • info

      added the new optional query request parameter timeOut