savings_plans

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

Overview

Name	savings_plans
Type	Resource
Id	azure.billing.savings_plans

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.
appliedScopeProperties	object	Properties specific to applied scope type. Not required if not applicable.
appliedScopeType	string	Type of the Applied Scope. Known values are: "Single", "Shared", and "ManagementGroup". (Single, Shared, ManagementGroup)
benefitStartTime	string (date-time)	This is the DateTime when the savings plan benefit starts.
billingAccountId	string	Fully-qualified identifier of the billing account where the savings plan is applied.
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly purchases. "P1M" (P1M)
billingProfileId	string	Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
billingScopeId	string	Subscription that will be charged for purchasing SavingsPlan.
commitment	object	Commitment towards 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.
displayProvisioningState	string	The provisioning state of the savings plan for display, e.g. Succeeded.
effectiveDateTime	string (date-time)	DateTime of the savings plan starting when this version is effective from.
expiryDateTime	string (date-time)	This is the date-time when the savings plan will expire.
extendedStatusInfo	object	Extended status information.
productCode	string	Represents UPN.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
purchaseDateTime	string (date-time)	Date time when the savings plan was purchased.
renew	boolean	Setting this to true will automatically purchase a new benefit on the expiration date time.
renewDestination	string	SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renewProperties	object	Properties specific to renew.
renewSource	string	SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
sku	object	Savings plan SKU. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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 < > % & \ ? /.
term	string	Represents the Savings plan term in ISO 8601 format. Known values are: "P1Y", "P3Y", and "P5Y". (P1Y, P3Y, P5Y)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userFriendlyAppliedScopeType	string	The applied scope type of the savings plan for display, e.g. Shared.
utilization	object	Savings plan utilization.

list_by_savings_plan_order

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.
appliedScopeProperties	object	Properties specific to applied scope type. Not required if not applicable.
appliedScopeType	string	Type of the Applied Scope. Known values are: "Single", "Shared", and "ManagementGroup". (Single, Shared, ManagementGroup)
benefitStartTime	string (date-time)	This is the DateTime when the savings plan benefit starts.
billingAccountId	string	Fully-qualified identifier of the billing account where the savings plan is applied.
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly purchases. "P1M" (P1M)
billingProfileId	string	Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
billingScopeId	string	Subscription that will be charged for purchasing SavingsPlan.
commitment	object	Commitment towards 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.
displayProvisioningState	string	The provisioning state of the savings plan for display, e.g. Succeeded.
effectiveDateTime	string (date-time)	DateTime of the savings plan starting when this version is effective from.
expiryDateTime	string (date-time)	This is the date-time when the savings plan will expire.
extendedStatusInfo	object	Extended status information.
productCode	string	Represents UPN.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
purchaseDateTime	string (date-time)	Date time when the savings plan was purchased.
renew	boolean	Setting this to true will automatically purchase a new benefit on the expiration date time.
renewDestination	string	SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renewProperties	object	Properties specific to renew.
renewSource	string	SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
sku	object	Savings plan SKU. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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 < > % & \ ? /.
term	string	Represents the Savings plan term in ISO 8601 format. Known values are: "P1Y", "P3Y", and "P5Y". (P1Y, P3Y, P5Y)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userFriendlyAppliedScopeType	string	The applied scope type of the savings plan for display, e.g. Shared.
utilization	object	Savings plan utilization.

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.
appliedScopeProperties	object	Properties specific to applied scope type. Not required if not applicable.
appliedScopeType	string	Type of the Applied Scope. Known values are: "Single", "Shared", and "ManagementGroup". (Single, Shared, ManagementGroup)
benefitStartTime	string (date-time)	This is the DateTime when the savings plan benefit starts.
billingAccountId	string	Fully-qualified identifier of the billing account where the savings plan is applied.
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly purchases. "P1M" (P1M)
billingProfileId	string	Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
billingScopeId	string	Subscription that will be charged for purchasing SavingsPlan.
commitment	object	Commitment towards 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.
displayProvisioningState	string	The provisioning state of the savings plan for display, e.g. Succeeded.
effectiveDateTime	string (date-time)	DateTime of the savings plan starting when this version is effective from.
expiryDateTime	string (date-time)	This is the date-time when the savings plan will expire.
extendedStatusInfo	object	Extended status information.
productCode	string	Represents UPN.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
purchaseDateTime	string (date-time)	Date time when the savings plan was purchased.
renew	boolean	Setting this to true will automatically purchase a new benefit on the expiration date time.
renewDestination	string	SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renewProperties	object	Properties specific to renew.
renewSource	string	SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
sku	object	Savings plan SKU. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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 < > % & \ ? /.
term	string	Represents the Savings plan term in ISO 8601 format. Known values are: "P1Y", "P3Y", and "P5Y". (P1Y, P3Y, P5Y)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userFriendlyAppliedScopeType	string	The applied scope type of the savings plan for display, e.g. Shared.
utilization	object	Savings plan utilization.

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, savings_plan_order_id, savings_plan_id	expand	Get savings plan by billing account.
list_by_savings_plan_order	select	billing_account_name, savings_plan_order_id		List savings plans in an order by billing account.
list_by_billing_account	select	billing_account_name	filter, orderBy, skiptoken, take, selectedState, refreshSummary	List savings plans by billing account.
update_by_billing_account	update	billing_account_name, savings_plan_order_id, savings_plan_id		Update savings plan by billing account.
validate_update_by_billing_account	exec	billing_account_name, savings_plan_order_id, savings_plan_id		Validate savings plan patch 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
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
savings_plan_id	string	ID of the savings plan. Required.
savings_plan_order_id	string	Order ID of the savings plan. Required.
expand	string	May be used to expand the planInformation. 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.
refreshSummary	string	To indicate whether to refresh the roll up counts of the savings plans group by provisioning states. Default value is None.
selectedState	string	The selected provisioning state. Default value is None.
skiptoken	number	The number of savings plans to skip from the list before returning results. Default value is None.
take	number	The number of savings plans to return. Default value is None.

SELECT examples

get_by_billing_account

Get savings plan by billing account.

SELECT
id,
name,
appliedScopeProperties,
appliedScopeType,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
billingScopeId,
commitment,
customerId,
displayName,
displayProvisioningState,
effectiveDateTime,
expiryDateTime,
extendedStatusInfo,
productCode,
provisioningState,
purchaseDateTime,
renew,
renewDestination,
renewProperties,
renewSource,
sku,
systemData,
tags,
term,
type,
userFriendlyAppliedScopeType,
utilization
FROM azure.billing.savings_plans
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND savings_plan_order_id = '{{ savings_plan_order_id }}' -- required
AND savings_plan_id = '{{ savings_plan_id }}' -- required
AND expand = '{{ expand }}'
;

list_by_savings_plan_order

List savings plans in an order by billing account.

SELECT
id,
name,
appliedScopeProperties,
appliedScopeType,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
billingScopeId,
commitment,
customerId,
displayName,
displayProvisioningState,
effectiveDateTime,
expiryDateTime,
extendedStatusInfo,
productCode,
provisioningState,
purchaseDateTime,
renew,
renewDestination,
renewProperties,
renewSource,
sku,
systemData,
tags,
term,
type,
userFriendlyAppliedScopeType,
utilization
FROM azure.billing.savings_plans
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND savings_plan_order_id = '{{ savings_plan_order_id }}' -- required
;

list_by_billing_account

List savings plans by billing account.

SELECT
id,
name,
appliedScopeProperties,
appliedScopeType,
benefitStartTime,
billingAccountId,
billingPlan,
billingProfileId,
billingScopeId,
commitment,
customerId,
displayName,
displayProvisioningState,
effectiveDateTime,
expiryDateTime,
extendedStatusInfo,
productCode,
provisioningState,
purchaseDateTime,
renew,
renewDestination,
renewProperties,
renewSource,
sku,
systemData,
tags,
term,
type,
userFriendlyAppliedScopeType,
utilization
FROM azure.billing.savings_plans
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND skiptoken = '{{ skiptoken }}'
AND take = '{{ take }}'
AND selectedState = '{{ selectedState }}'
AND refreshSummary = '{{ refreshSummary }}'
;

UPDATE examples

update_by_billing_account

Update savings plan by billing account.

UPDATE azure.billing.savings_plans
SET 
properties = '{{ properties }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
billing_account_name = '{{ billing_account_name }}' --required
AND savings_plan_order_id = '{{ savings_plan_order_id }}' --required
AND savings_plan_id = '{{ savings_plan_id }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
tags,
type;

Lifecycle Methods

validate_update_by_billing_account

Validate savings plan patch by billing account.

EXEC azure.billing.savings_plans.validate_update_by_billing_account 
@billing_account_name='{{ billing_account_name }}' --required, 
@savings_plan_order_id='{{ savings_plan_order_id }}' --required, 
@savings_plan_id='{{ savings_plan_id }}' --required 
@@json=
'{
"benefits": "{{ benefits }}"
}'
;