reservation_orders

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

Overview

Name	reservation_orders
Type	Resource
Id	azure.billing.reservation_orders

Fields

The following fields are returned by SELECT queries:

get_by_billing_account

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.
benefitStartTime	string (date-time)	This is the DateTime when the reservation benefit started.
billingAccountId	string	Billing account Id associated to this reservation order.
billingPlan	string	Represent the billing plans. Known values are: "Upfront" and "Monthly". (Upfront, Monthly)
billingProfileId	string	Billing profile Id associated to this reservation order.
createdDateTime	string (date-time)	This is the DateTime when the reservation order was created.
customerId	string	Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers.
displayName	string	Friendly name for user to easily identified the reservation order.
enrollmentId	string	Enrollment id of the reservation order.
etag	integer	:vartype etag: int
expiryDate	string (date)	This is the date when the reservation order will expire.
expiryDateTime	string (date-time)	This is the date-time when the reservation order will expire.
extendedStatusInfo	object	Extended status information for the reservation.
originalQuantity	integer	Total original quantity of the skus purchased in the reservation order.
planInformation	object	Information describing the type of billing plan for this reservation order.
productCode	string	Represents UPN.
provisioningState	string	The provisioning state of the reservation, e.g. Succeeded.
requestDateTime	string (date-time)	This is the DateTime when the reservation order was initially requested for purchase.
reservations	array	:vartype reservations: list[~azure.mgmt.billing.models.Reservation]
reviewDateTime	string (date-time)	This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags for this reservation.
term	string	The term of the reservation, e.g. P1Y.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_account

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.
benefitStartTime	string (date-time)	This is the DateTime when the reservation benefit started.
billingAccountId	string	Billing account Id associated to this reservation order.
billingPlan	string	Represent the billing plans. Known values are: "Upfront" and "Monthly". (Upfront, Monthly)
billingProfileId	string	Billing profile Id associated to this reservation order.
createdDateTime	string (date-time)	This is the DateTime when the reservation order was created.
customerId	string	Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers.
displayName	string	Friendly name for user to easily identified the reservation order.
enrollmentId	string	Enrollment id of the reservation order.
etag	integer	:vartype etag: int
expiryDate	string (date)	This is the date when the reservation order will expire.
expiryDateTime	string (date-time)	This is the date-time when the reservation order will expire.
extendedStatusInfo	object	Extended status information for the reservation.
originalQuantity	integer	Total original quantity of the skus purchased in the reservation order.
planInformation	object	Information describing the type of billing plan for this reservation order.
productCode	string	Represents UPN.
provisioningState	string	The provisioning state of the reservation, e.g. Succeeded.
requestDateTime	string (date-time)	This is the DateTime when the reservation order was initially requested for purchase.
reservations	array	:vartype reservations: list[~azure.mgmt.billing.models.Reservation]
reviewDateTime	string (date-time)	This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags for this reservation.
term	string	The term of the reservation, e.g. P1Y.
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
get_by_billing_account	select	billing_account_name, reservation_order_id	expand	Get a specific ReservationOrder in the billing account. Get the details of the ReservationOrder in the billing account.
list_by_billing_account	select	billing_account_name	filter, orderBy, skiptoken	Get all `ReservationOrders in the billing account. List all the ReservationOrders in the 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
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
reservation_order_id	string	Order Id of the reservation. Required.
expand	string	May be used to expand the detail information of some properties. Default value is None.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
orderBy	string	The orderby query option allows clients to request resources in a particular order. Default value is None.
skiptoken	number	The number of reservations to skip from the list before returning results. Default value is None.

SELECT examples

get_by_billing_account

Get a specific ReservationOrder in the billing account. Get the details of the ReservationOrder in the billing account.

SELECT
id,
name,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
createdDateTime,
customerId,
displayName,
enrollmentId,
etag,
expiryDate,
expiryDateTime,
extendedStatusInfo,
originalQuantity,
planInformation,
productCode,
provisioningState,
requestDateTime,
reservations,
reviewDateTime,
systemData,
tags,
term,
type
FROM azure.billing.reservation_orders
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND reservation_order_id = '{{ reservation_order_id }}' -- required
AND expand = '{{ expand }}'
;

list_by_billing_account

Get all `ReservationOrders in the billing account. List all the ReservationOrders in the billing account.

SELECT
id,
name,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
createdDateTime,
customerId,
displayName,
enrollmentId,
etag,
expiryDate,
expiryDateTime,
extendedStatusInfo,
originalQuantity,
planInformation,
productCode,
provisioningState,
requestDateTime,
reservations,
reviewDateTime,
systemData,
tags,
term,
type
FROM azure.billing.reservation_orders
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND skiptoken = '{{ skiptoken }}'
;