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

OK

idstring

A string that uniquely identifies the pool within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.

displayNamestring

The display name for the pool.

urlstring

The URL of the pool.

eTagstring

The ETag of the pool.

lastModifiedstring date-time

The last modified time of the pool.

creationTimestring date-time

The creation time of the pool.

state'active' | 'deleting' | 'upgrading'

The current state of the pool.

stateTransitionTimestring date-time

The time at which the pool entered its current state.

allocationState'steady' | 'resizing' | 'stopping'

Whether the pool is resizing.

allocationStateTransitionTimestring date-time

The time at which the pool entered its current allocation state.

vmSizestring

The size of virtual machines in the pool. All virtual machines in a pool are the same size.

resizeTimeoutstring duration

The timeout for allocation of compute nodes to the pool. In a Get Pool operation, this is the timeout for the most recent resize operation. The default value is 10 minutes.

currentDedicatedinteger

The number of compute nodes currently in the pool.

targetDedicatedinteger

The desired number of compute nodes in the pool. This property must have the default value if EnableAutoScale is true. It is required if EnableAutoScale is false.

enableAutoScaleboolean

Whether the pool size should automatically adjust over time. If true, the AutoScaleFormula property must be set. If false, the TargetDedicated property must be set.

autoScaleFormulastring

A formula for the desired number of compute nodes in the pool.

autoScaleEvaluationIntervalstring duration

A time interval for the desired AutoScale evaluation period in the pool.

enableInterNodeCommunicationboolean

Whether the pool permits direct communication between nodes.

maxTasksPerNodeinteger

The maximum number of tasks that can run concurrently on a single compute node in the pool.

Changes