reservations

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

Overview

Name	reservations
Type	Resource
Id	azure.billing.reservations

Fields

The following fields are returned by SELECT queries:

get_by_reservation_order

Get Reservation details.

Name	Datatype	Description
etag	integer (int32)
location	string	The location of the reservation.
properties	object	The properties associated to this reservation
sku	object	The sku information associated to this reservation
tags	object	Tags for this reservation

list_by_billing_profile

OK. The request has succeeded.

Name	Datatype	Description
etag	integer (int32)
location	string	The location of the reservation.
properties	object	The properties associated to this reservation
sku	object	The sku information associated to this reservation
tags	object	Tags for this reservation

list_by_reservation_order

List Reservations within a single ReservationOrder.

Name	Datatype	Description
etag	integer (int32)
location	string	The location of the reservation.
properties	object	The properties associated to this reservation
sku	object	The sku information associated to this reservation
tags	object	Tags for this reservation

list_by_billing_account

OK. The request has succeeded.

Name	Datatype	Description
etag	integer (int32)
location	string	The location of the reservation.
properties	object	The properties associated to this reservation
sku	object	The sku information associated to this reservation
tags	object	Tags for this reservation

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_reservation_order	select	billingAccountName, reservationOrderId, reservationId	expand	Get specific Reservation details in the billing account.
list_by_billing_profile	select	billingAccountName, billingProfileName	filter, orderBy, skiptoken, refreshSummary, selectedState, take	Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
list_by_reservation_order	select	billingAccountName, reservationOrderId		List Reservations within a single ReservationOrder in the billing account.
list_by_billing_account	select	billingAccountName	filter, orderBy, skiptoken, refreshSummary, selectedState, take	Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.
update_by_billing_account	exec	billingAccountName, reservationOrderId, reservationId		Update reservation by billing account.

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
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
reservationId	string	Id of the reservation item
reservationOrderId	string	Order Id of the reservation
expand	string	May be used to expand the planInformation.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	string	The orderby query option allows clients to request resources in a particular order.
refreshSummary	string	To indicate whether to refresh the roll up counts of the savings plans group by provisioning states
selectedState	string	The selected provisioning state
skiptoken	number	The number of savings plans to skip from the list before returning results
take	number	The number of savings plans to return

SELECT examples

get_by_reservation_order

Get specific Reservation details in the billing account.

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.billing.reservations
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND reservationOrderId = '{{ reservationOrderId }}' -- required
AND reservationId = '{{ reservationId }}' -- required
AND expand = '{{ expand }}'
;

list_by_billing_profile

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.billing.reservations
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND skiptoken = '{{ skiptoken }}'
AND refreshSummary = '{{ refreshSummary }}'
AND selectedState = '{{ selectedState }}'
AND take = '{{ take }}'
;

list_by_reservation_order

List Reservations within a single ReservationOrder in the billing account.

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.billing.reservations
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND reservationOrderId = '{{ reservationOrderId }}' -- required
;

list_by_billing_account

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

SELECT
etag,
location,
properties,
sku,
tags
FROM azure.billing.reservations
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND skiptoken = '{{ skiptoken }}'
AND refreshSummary = '{{ refreshSummary }}'
AND selectedState = '{{ selectedState }}'
AND take = '{{ take }}'
;

Lifecycle Methods

update_by_billing_account

Update reservation by billing account.

EXEC azure.billing.reservations.update_by_billing_account 
@billingAccountName='{{ billingAccountName }}' --required, 
@reservationOrderId='{{ reservationOrderId }}' --required, 
@reservationId='{{ reservationId }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"sku": "{{ sku }}", 
"tags": "{{ tags }}"
}'
;