savings_plan_order

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

Overview

Name	savings_plan_order
Type	Resource
Id	azure.billing_benefits.savings_plan_order

Fields

The following fields are returned by SELECT queries:

get

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 savings plan benefit started.
billingAccountId	string	Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. "P1M" (P1M)
billingProfileId	string	Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.
billingScopeId	string	Subscription that will be charged for purchasing the benefit.
customerId	string	Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
displayName	string	Display name.
expiryDateTime	string (date-time)	Expiry date time.
extendedStatusInfo	object	:vartype extended_status_info: ~azure.mgmt.billingbenefits.models.ExtendedStatusInfo
planInformation	object	Information describing the type of billing plan for this savings plan.
provisioningState	string	Provisioning state. Known values are: "Creating", "PendingBilling", "ConfirmedBilling", "Created", "Succeeded", "Cancelled", "Expired", and "Failed". (Creating, PendingBilling, ConfirmedBilling, Created, Succeeded, Cancelled, Expired, Failed)
savingsPlans	array	:vartype savings_plans: list[str]
sku	object	Savings plan SKU. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
term	string	Represent benefit term in ISO 8601 format. Known values are: "P1M", "P1Y", "P3Y", and "P5Y". (P1M, P1Y, P3Y, P5Y)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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 savings plan benefit started.
billingAccountId	string	Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. "P1M" (P1M)
billingProfileId	string	Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.
billingScopeId	string	Subscription that will be charged for purchasing the benefit.
customerId	string	Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
displayName	string	Display name.
expiryDateTime	string (date-time)	Expiry date time.
extendedStatusInfo	object	:vartype extended_status_info: ~azure.mgmt.billingbenefits.models.ExtendedStatusInfo
planInformation	object	Information describing the type of billing plan for this savings plan.
provisioningState	string	Provisioning state. Known values are: "Creating", "PendingBilling", "ConfirmedBilling", "Created", "Succeeded", "Cancelled", "Expired", and "Failed". (Creating, PendingBilling, ConfirmedBilling, Created, Succeeded, Cancelled, Expired, Failed)
savingsPlans	array	:vartype savings_plans: list[str]
sku	object	Savings plan SKU. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
term	string	Represent benefit term in ISO 8601 format. Known values are: "P1M", "P1Y", "P3Y", and "P5Y". (P1M, P1Y, P3Y, P5Y)
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	savings_plan_order_id	$expand	Get a savings plan order.
list	select			List all Savings plan orders.
elevate	exec	savings_plan_order_id		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
savings_plan_order_id	string	Order ID of the savings plan. Required.
$expand	string

SELECT examples

get

Get a savings plan order.

SELECT
id,
name,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
billingScopeId,
customerId,
displayName,
expiryDateTime,
extendedStatusInfo,
planInformation,
provisioningState,
savingsPlans,
sku,
systemData,
term,
type
FROM azure.billing_benefits.savings_plan_order
WHERE savings_plan_order_id = '{{ savings_plan_order_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List all Savings plan orders.

SELECT
id,
name,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
billingScopeId,
customerId,
displayName,
expiryDateTime,
extendedStatusInfo,
planInformation,
provisioningState,
savingsPlans,
sku,
systemData,
term,
type
FROM azure.billing_benefits.savings_plan_order
;

Lifecycle Methods

elevate

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

EXEC azure.billing_benefits.savings_plan_order.elevate 
@savings_plan_order_id='{{ savings_plan_order_id }}' --required
;