Pools - List Pool Node Counts

Service:: Batch Service

API Version:: 2025-06-01

Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.

GET {endpoint}/nodecounts?api-version=2025-06-01

With optional parameters:

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
timeOut	query		integer (int32)	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.".

Request Header

Name	Type	Description
client-request-id	string	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-id	boolean	Whether the server should return the client-request-id in the response.
ocp-date	string (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.

Responses

Name	Type	Description
200 OK	BatchPoolNodeCountsListResult	The request has succeeded. Headers ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	An unexpected error response.

Name

Type

Description

200 OK

BatchPoolNodeCountsListResult

The request has succeeded.

Headers

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://batch.core.windows.net//.default

Examples

NodeCountsPayload

Sample request

HTTP

GET {endpoint}/nodecounts?api-version=2025-06-01

Sample response

Status code:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

Definitions

Name	Description
BatchError	An error response received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
BatchErrorMessage	An error message received in an Azure Batch error response.
BatchNodeCounts	The number of Compute Nodes in each Compute Node state.
BatchPoolNodeCounts	The number of Compute Nodes in each state for a Pool.
BatchPoolNodeCountsListResult	The result of listing the Compute Node counts in the Account.

BatchError

Object

An error response received from the Azure Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	BatchErrorMessage	A message describing the error, intended to be suitable for display in a user interface.
values	BatchErrorDetail[]	A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

Object

An item of additional information included in an Azure Batch error response.

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

BatchErrorMessage

Object

An error message received in an Azure Batch error response.

Name	Type	Description
lang	string	The language code of the error message.
value	string	The text of the message.

BatchNodeCounts

Object

The number of Compute Nodes in each Compute Node state.

Name	Type	Description
creating	integer (int32)	The number of Compute Nodes in the creating state.
deallocated	integer (int32)	The number of Compute Nodes in the deallocated state.
deallocating	integer (int32)	The number of Compute Nodes in the deallocating state.
idle	integer (int32)	The number of Compute Nodes in the idle state.
leavingPool	integer (int32)	The number of Compute Nodes in the leavingPool state.
offline	integer (int32)	The number of Compute Nodes in the offline state.
preempted	integer (int32)	The number of Compute Nodes in the preempted state.
rebooting	integer (int32)	The count of Compute Nodes in the rebooting state.
reimaging	integer (int32)	The number of Compute Nodes in the reimaging state.
running	integer (int32)	The number of Compute Nodes in the running state.
startTaskFailed	integer (int32)	The number of Compute Nodes in the startTaskFailed state.
starting	integer (int32)	The number of Compute Nodes in the starting state.
total	integer (int32)	The total number of Compute Nodes.
unknown	integer (int32)	The number of Compute Nodes in the unknown state.
unusable	integer (int32)	The number of Compute Nodes in the unusable state.
upgradingOS	integer (int32)	The number of Compute Nodes in the upgradingOS state.
waitingForStartTask	integer (int32)	The number of Compute Nodes in the waitingForStartTask state.

BatchPoolNodeCounts

Object

The number of Compute Nodes in each state for a Pool.

Name	Type	Description
dedicated	BatchNodeCounts	The number of dedicated Compute Nodes in each state.
lowPriority	BatchNodeCounts	The number of Spot/Low-priority Compute Nodes in each state.
poolId	string	The ID of the Pool.

BatchPoolNodeCountsListResult

Object

The result of listing the Compute Node counts in the Account.

Name	Type	Description
odata.nextLink	string (uri)	The URL to get the next set of results.
value	BatchPoolNodeCounts[]	A list of Compute Node counts by Pool.

Share via

Pools - List Pool Node Counts

URI Parameters

Request Header

Responses

Security

OAuth2Auth

Scopes

Examples

NodeCountsPayload

Sample request

Sample response

Definitions

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult