savings_plan_orders

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

Overview

Name	savings_plan_orders
Type	Resource
Id	azure.billing_benefits.savings_plan_orders

Fields

The following fields are returned by SELECT queries:

get

The request is completed.

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	Savings plan order properties
sku	object	The SKU to be applied for this resource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

The request is completed.

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	Savings plan order properties
sku	object	The SKU to be applied for this resource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	select	savingsPlanOrderId	$expand	Get a savings plan order.
list	select			List all Savings plan orders.
elevate	exec	savingsPlanOrderId		Elevate as owner on savings plan order based on billing permissions.

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
savingsPlanOrderId	string	Order ID of the savings plan
$expand	string	May be used to expand the detail information of some properties.

SELECT examples

get

Get a savings plan order.

SELECT
id,
name,
properties,
sku,
systemData,
type
FROM azure.billing_benefits.savings_plan_orders
WHERE savingsPlanOrderId = '{{ savingsPlanOrderId }}' -- required
AND $expand = '{{ $expand }}'
;

list

List all Savings plan orders.

SELECT
id,
name,
properties,
sku,
systemData,
type
FROM azure.billing_benefits.savings_plan_orders
;

Lifecycle Methods

elevate

Elevate as owner on savings plan order based on billing permissions.

EXEC azure.billing_benefits.savings_plan_orders.elevate 
@savingsPlanOrderId='{{ savingsPlanOrderId }}' --required
;