Sign in

v1

latestSwagger 2.02026-07-1477151580.2 KB
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 uuid

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. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

If-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

If-None-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

If-Modified-Sincestring date-time-rfc1123

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

If-Unmodified-Sincestring date-time-rfc1123

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Response

A response containing the pool.

allocationState'steady' | 'resizing' | 'stopping'
allocationStateTransitionTimestring date-time
applicationLicensesstring[]

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

autoScaleEvaluationIntervalstring duration

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

autoScaleFormulastring

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

creationTimestring date-time
currentDedicatedNodesinteger
currentLowPriorityNodesinteger

Low-priority compute nodes which have been preempted are included in this count.

displayNamestring

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

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.

enableAutoScaleboolean

If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.

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.

idstring

The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

lastModifiedstring date-time

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

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

state'active' | 'deleting' | 'upgrading'
stateTransitionTimestring date-time
targetDedicatedNodesinteger
targetLowPriorityNodesinteger
urlstring
vmSizestring

For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).