v4

latestSwagger 2.02026-07-131916.7 KB

Lists the metric values for multiple resources.

post/subscriptions/{subscriptionId}/metrics:getBatch

Path parameters

subscriptionIdstring uuid required

The subscription identifier for the resources in this batch.

Query parameters

api-versionstring required

The API version to use for this operation.

starttimestring

The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then this parameter is required. If only starttime is specified, then endtime defaults to the current time. If no time interval is specified, the default is 1 hour.

endtimestring

The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'.

intervalstring

The interval (i.e. timegrain) of the query in ISO 8601 duration format. Defaults to PT1M. Special case for 'FULL' value that returns single datapoint for entire time span requested. Examples: PT15M, PT1H, P1D, FULL

metricnamespacestring required

Metric namespace that contains the requested metric names.

metricnamesstring[] required

The names of the metrics (comma separated) to retrieve.

aggregationstring

The list of aggregation types (comma separated) to retrieve. Examples: average, minimum, maximum

topinteger

The maximum number of records to retrieve per resource ID in the request. Valid only if filter is specified. Defaults to 10.

orderbystring

The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc

filterstring

The filter is used to reduce the set of metric data returned.<br>Example:<br>Metric contains metadata A, B and C.<br>- Return all time series of C where A = a1 and B = b1 or b2<br>filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’<br>- Invalid variant:<br>filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’<br>This is invalid because the logical or operator cannot separate two different metadata names.<br>- Return all time series where A = a1, B = b1 and C = c1:<br>filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’<br>- Return all time series where A = a1<br>filter=A eq ‘a1’ and B eq ‘’ and C eq ‘.

rollupbystring

Dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

Request body

resourceidsstring[]

The list of resource IDs to query metrics for.

Response

The request has succeeded.