Pool - List Usage Metrics

Service:

Batch Service

API Version:

2024-07-01.20.0

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 {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0

With optional parameters:

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
api-version	query	True	string	Client API Version.
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://docs.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	The maximum number of items to return in the response. A maximum of 1000 results will 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

Media Types: "application/json; odata=minimalmetadata"

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

Responses

Name	Type	Description
200 OK	PoolListUsageMetricsResult	A response containing the list of Pool usage details. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

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

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Pool list usage metrics

Sample request

HTTP

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

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.
ErrorMessage	An error message received in an Azure Batch error response.
PoolListUsageMetricsResult	The result of a listing the usage metrics for an Account.
PoolUsageMetrics	Usage metrics for a Pool across an aggregation interval.

BatchError

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

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.

ErrorMessage

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.

PoolListUsageMetricsResult

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

Name	Type	Description
odata.nextLink	string	The URL to get the next set of results.
value	PoolUsageMetrics[]	The Pool usage metrics data.

PoolUsageMetrics

Usage metrics for a Pool across an aggregation interval.

Name	Type	Description
endTime	string	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	The start time of the aggregation interval covered by this entry.
totalCoreHours	number	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://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).