Sign in

v22

latestSwagger 2.02026-07-1372236814.0 KB
Pools

Gets information about the specified Pool.

get/pools/{poolId}

Path parameters

poolIdstring required

The ID of the Pool to get.

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

$selectstring[]

An OData $select clause.

$expandstring[]

An OData $expand clause.

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.

If-Modified-Sincestring date-time-rfc7231

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

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.

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.

Response

The request has succeeded.

idstring required

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. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).

displayNamestring

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

urlstring uri required

The URL of the Pool.

eTagstring required

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.

It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".

lastModifiedstring date-time required

The last modified time of the Pool. 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.

creationTimestring date-time required

The creation time of the Pool.

state'active' | 'deleting' required

BatchPoolState enums

stateTransitionTimestring date-time required

The time at which the Pool entered its current state.

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

AllocationState enums

allocationStateTransitionTimestring date-time

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

vmSizestring required

The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

resizeTimeoutstring duration

The timeout for allocation of Compute Nodes to the Pool. 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. The time duration is specified in ISO 8601 format.

currentDedicatedNodesinteger required

The number of dedicated Compute Nodes currently in the Pool.

currentLowPriorityNodesinteger required

The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count.

targetDedicatedNodesinteger

The desired number of dedicated Compute Nodes in the Pool.

targetLowPriorityNodesinteger

The desired number of Spot/Low-priority Compute Nodes in the Pool.

enableAutoScaleboolean

Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes 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.

autoScaleFormulastring

A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

autoScaleEvaluationIntervalstring duration

The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. The time duration is specified in ISO 8601 format.

enableInterNodeCommunicationboolean

Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.

taskSlotsPerNodeinteger

The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.