savings_plan_order_alias

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

Overview

Name	savings_plan_order_alias
Type	Resource
Id	azure.billing_benefits.savings_plan_order_alias

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.
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)
billingPlan	string	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. "P1M" (P1M)
billingScopeId	string	Subscription that will be charged for purchasing the benefit.
commitment	object	Commitment towards the benefit.
displayName	string	Display name.
kind	string	Resource provider kind.
provisioningState	string	Provisioning state. Known values are: "Creating", "PendingBilling", "ConfirmedBilling", "Created", "Succeeded", "Cancelled", "Expired", and "Failed". (Creating, PendingBilling, ConfirmedBilling, Created, Succeeded, Cancelled, Expired, Failed)
renew	boolean	Setting this to true will automatically purchase a new benefit on the expiration date time.
savingsPlanOrderId	string	Identifier of the savings plan created.
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_alias_name		Get a savings plan.
create	insert	savings_plan_order_alias_name, sku		Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851 _.

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_alias_name	string	Name of the savings plan order alias. Required.

SELECT examples

get

Get a savings plan.

SELECT
id,
name,
appliedScopeProperties,
appliedScopeType,
billingPlan,
billingScopeId,
commitment,
displayName,
kind,
provisioningState,
renew,
savingsPlanOrderId,
sku,
systemData,
term,
type
FROM azure.billing_benefits.savings_plan_order_alias
WHERE savings_plan_order_alias_name = '{{ savings_plan_order_alias_name }}' -- required
;

INSERT examples

create

Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851 _.

INSERT INTO azure.billing_benefits.savings_plan_order_alias (
properties,
sku,
kind,
savings_plan_order_alias_name
)
SELECT 
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ kind }}',
'{{ savings_plan_order_alias_name }}'
RETURNING
id,
name,
kind,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: savings_plan_order_alias
props:
  - name: savings_plan_order_alias_name
    value: "{{ savings_plan_order_alias_name }}"
    description: Required parameter for the savings_plan_order_alias resource.
  - name: properties
    description: |
      Savings plan order alias properties.
    value:
      displayName: "{{ displayName }}"
      savingsPlanOrderId: "{{ savingsPlanOrderId }}"
      provisioningState: "{{ provisioningState }}"
      billingScopeId: "{{ billingScopeId }}"
      term: "{{ term }}"
      billingPlan: "{{ billingPlan }}"
      appliedScopeType: "{{ appliedScopeType }}"
      appliedScopeProperties:
        tenantId: "{{ tenantId }}"
        managementGroupId: "{{ managementGroupId }}"
        subscriptionId: "{{ subscriptionId }}"
        resourceGroupId: "{{ resourceGroupId }}"
        displayName: "{{ displayName }}"
      commitment:
        currencyCode: "{{ currencyCode }}"
        amount: {{ amount }}
        grain: "{{ grain }}"
      renew: {{ renew }}
  - name: sku
    description: |
      Savings plan SKU. Required.
    value:
      name: "{{ name }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Resource provider kind.