pool_usage_metrics

Creates, updates, deletes, gets or lists a pool_usage_metrics resource.

Overview

Name	pool_usage_metrics
Type	Resource
Id	azure.batch_dataplane.pool_usage_metrics

Fields

The following fields are returned by SELECT queries:

list_pool_usage_metrics

Name	Datatype	Description
endTime	string (date-time)	The end time of the aggregation interval covered by this entry. Required.
poolId	string	The ID of the Pool whose metrics are aggregated in this entry. Required.
startTime	string (date-time)	The start time of the aggregation interval covered by this entry. Required.
totalCoreHours	number	The total core hours used in the Pool during this aggregation interval. Required.
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 _). Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pool_usage_metrics	select	endpoint	timeOut, ocp-date, maxresults, startTime, endtime, $filter	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
$filter	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 _. Default value is None.
endtime	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. Default value is None.
maxresults	integer	The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value is None.
ocp-date	string	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. Default value is None.
startTime	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. Default value is None.
timeOut	integer	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.". Default value is None.

SELECT examples

list_pool_usage_metrics

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.

SELECT
endTime,
poolId,
startTime,
totalCoreHours,
vmSize
FROM azure.batch_dataplane.pool_usage_metrics
WHERE endpoint = '{{ endpoint }}' -- required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
AND maxresults = '{{ maxresults }}'
AND startTime = '{{ startTime }}'
AND endtime = '{{ endtime }}'
AND $filter = '{{ $filter }}'
;