Share via

Pools - List Pool Usage Metrics

Service:
Batch Service
API Version:
2025-06-01

Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.
If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01
With optional parameters: 
GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$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-account-usage-metrics.
endtime
 query

string (date-time)

The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
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.
startTime
 query

string (date-time)

The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
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 Required 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

BatchPoolListUsageMetricsResult

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

Pool list usage metrics

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

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

The result of a listing the usage metrics for an Account.
BatchPoolUsageMetrics

Usage metrics for a Pool across an aggregation interval.

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.

BatchPoolListUsageMetricsResult

Object

The result of a listing the usage metrics for an Account.

Name Type Description
odata.nextLink

string (uri)

The URL to get the next set of results.
value

BatchPoolUsageMetrics[]

The Pool usage metrics data.

BatchPoolUsageMetrics

Object

Usage metrics for a Pool across an aggregation interval.

Name Type Description
endTime

string (date-time)

The end time of the aggregation interval covered by this entry.
poolId

string

The ID of the Pool whose metrics are aggregated in this entry.
startTime

string (date-time)

The start time of the aggregation interval covered by this entry.
totalCoreHours

number (float)

The total core hours used in the Pool during this aggregation interval.
vmSize

string

The size of virtual machines in the Pool. All VMs 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).