Sign in
Pools

Gets information about the specified pool.

get/pools/{poolId}

Path parameters

poolIdstring required

The ID of the pool to get.

Query parameters

$selectstring

An OData $select clause.

$expandstring

An OData $expand clause.

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

A response containing the pool.

idstring

The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.

displayNamestring

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

urlstring
eTagstring

This is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.

lastModifiedstring date-time

This is the last time at which the pool level data, such as the targetDedicated or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.

creationTimestring date-time
state'active' | 'deleting' | 'upgrading'

Possible values are: active – The pool is available to run tasks subject to the availability of compute nodes. deleting – The user has requested that the pool be deleted, but the delete operation has not yet completed. upgrading – The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed.

stateTransitionTimestring date-time
allocationState'steady' | 'resizing' | 'stopping'

Possible values are: steady – The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes. resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed.

allocationStateTransitionTimestring date-time
vmSizestring

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

resizeTimeoutstring duration

This is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.

currentDedicatedinteger
targetDedicatedinteger

This property is not set if enableAutoScale is true. It is required if enableAutoScale is false.

enableAutoScaleboolean

If true, the autoScaleFormula property must be set. If false, the targetDedicated property must be set.

autoScaleFormulastring

This property is set only if the pool automatically scales, i.e. enableAutoScale is true.

autoScaleEvaluationIntervalstring duration

This property is set only if the pool automatically scales, i.e. enableAutoScale is true.

enableInterNodeCommunicationboolean

This imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.

maxTasksPerNodeinteger

Changes