savings_plan_orders

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

Overview

Name	savings_plan_orders
Type	Resource
Id	azure.billing.savings_plan_orders

Fields

The following fields are returned by SELECT queries:

get_by_billing_account

The request is completed.

Name	Datatype	Description
properties	object	Savings plan order properties
sku	object	The resource model definition representing SKU
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list_by_billing_account

The request is completed.

Name	Datatype	Description
properties	object	Savings plan order properties
sku	object	The resource model definition representing SKU
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_billing_account	select	billingAccountName, savingsPlanOrderId	expand	Get a savings plan order by billing account.
list_by_billing_account	select	billingAccountName	filter, orderBy, skiptoken	List all Savings plan orders 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.
savingsPlanOrderId	string	Order ID of the savings plan
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.
skiptoken	number	The number of savings plans to skip from the list before returning results

SELECT examples

get_by_billing_account

Get a savings plan order by billing account.

SELECT
properties,
sku,
tags
FROM azure.billing.savings_plan_orders
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND savingsPlanOrderId = '{{ savingsPlanOrderId }}' -- required
AND expand = '{{ expand }}'
;

list_by_billing_account

List all Savings plan orders by billing account.

SELECT
properties,
sku,
tags
FROM azure.billing.savings_plan_orders
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND skiptoken = '{{ skiptoken }}'
;