reservations_summaries

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

Overview

Name	reservations_summaries
Type	Resource
Id	azure.consumption.reservations_summaries

Fields

The following fields are returned by SELECT queries:

list_by_reservation_order_and_reservation

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties of the reservation summary. (title: Reservation Summary properties)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_reservation_order

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties of the reservation summary. (title: Reservation Summary properties)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties of the reservation summary. (title: Reservation Summary properties)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_reservation_order_and_reservation	select	reservationOrderId, reservationId, grain	$filter	Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
list_by_reservation_order	select	reservationOrderId, grain	$filter	Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
list	select	resourceScope, grain	startDate, endDate, $filter, reservationId, reservationOrderId	Lists the reservations summaries for the defined scope daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

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
grain	string	Can be daily or monthly
reservationId	string	Id of the reservation
reservationOrderId	string	Order Id of the reservation
resourceScope	string	The scope associated with reservations summaries operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern).
$filter	string	Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile
endDate	string	End date. Only applicable when querying with billing profile
reservationId	string	Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation
reservationOrderId	string	Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order
startDate	string	Start date. Only applicable when querying with billing profile

SELECT examples

list_by_reservation_order_and_reservation

Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

SELECT
id,
name,
properties,
type
FROM azure.consumption.reservations_summaries
WHERE reservationOrderId = '{{ reservationOrderId }}' -- required
AND reservationId = '{{ reservationId }}' -- required
AND grain = '{{ grain }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_reservation_order

Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

SELECT
id,
name,
properties,
type
FROM azure.consumption.reservations_summaries
WHERE reservationOrderId = '{{ reservationOrderId }}' -- required
AND grain = '{{ grain }}' -- required
AND $filter = '{{ $filter }}'
;

list

Lists the reservations summaries for the defined scope daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

SELECT
id,
name,
properties,
type
FROM azure.consumption.reservations_summaries
WHERE resourceScope = '{{ resourceScope }}' -- required
AND grain = '{{ grain }}' -- required
AND startDate = '{{ startDate }}'
AND endDate = '{{ endDate }}'
AND $filter = '{{ $filter }}'
AND reservationId = '{{ reservationId }}'
AND reservationOrderId = '{{ reservationOrderId }}'
;