v8

latestSwagger 2.0raw.githubusercontent.com2023-04-0421317.6 KB
UsageAggregates

Query aggregated Azure subscription consumption data for a date range.

get/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates

Path parameters

subscriptionIdstring required

It uniquely identifies Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query parameters

reportedStartTimestring date-time required

The start of the time range to retrieve data for.

reportedEndTimestring date-time required

The end of the time range to retrieve data for.

showDetailsboolean

True returns usage data in instance-level detail, false causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime).

aggregationGranularity'Daily' | 'Hourly'

Daily (default) returns the data in daily granularity, Hourly returns the data in hourly granularity.

continuationTokenstring

Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in.

api-versionstring required

Client Api Version.

Response

Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.

nextLinkstring

Gets or sets the link to the next set of results.