reservation_order_alias

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

Overview

Name	reservation_order_alias
Type	Resource
Id	azure.billing_benefits.reservation_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.
displayName	string	Display name.
location	string	The Azure Region where the reserved resource lives.
provisioningState	string	Provisioning state. Known values are: "Creating", "PendingBilling", "ConfirmedBilling", "Created", "Succeeded", "Cancelled", "Expired", and "Failed". (Creating, PendingBilling, ConfirmedBilling, Created, Succeeded, Cancelled, Expired, Failed)
quantity	integer	Total Quantity of the SKUs purchased in the Reservation.
renew	boolean	Setting this to true will automatically purchase a new benefit on the expiration date time.
reservationOrderId	string	Identifier of the reservation order created.
reservedResourceProperties	object	Properties specific to each reserved resource type. Not required if not applicable.
reservedResourceType	string	The type of the resource that is being reserved. Known values are: "VirtualMachines", "SqlDatabases", "SuseLinux", "CosmosDb", "RedHat", "SqlDataWarehouse", "VMwareCloudSimple", "RedHatOsa", "Databricks", "AppService", "ManagedDisk", "BlockBlob", "RedisCache", "AzureDataExplorer", "MySql", "MariaDb", "PostgreSql", "DedicatedHost", "SapHana", "SqlAzureHybridBenefit", "AVS", "DataFactory", "NetAppStorage", "AzureFiles", "SqlEdge", and "VirtualMachineSoftware". (VirtualMachines, SqlDatabases, SuseLinux, CosmosDb, RedHat, SqlDataWarehouse, VMwareCloudSimple, RedHatOsa, Databricks, AppService, ManagedDisk, BlockBlob, RedisCache, AzureDataExplorer, MySql, MariaDb, PostgreSql, DedicatedHost, SapHana, SqlAzureHybridBenefit, AVS, DataFactory, NetAppStorage, AzureFiles, SqlEdge, VirtualMachineSoftware)
reviewDateTime	string (date-time)	This is the date-time when the Reservation needs to be reviewed.
sku	object	Reservation order 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	reservation_order_alias_name		Get a reservation order alias.
create	insert	reservation_order_alias_name, sku		Create a reservation order alias.

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
reservation_order_alias_name	string	Name of the reservation order alias. Required.

SELECT examples

get

Get a reservation order alias.

SELECT
id,
name,
appliedScopeProperties,
appliedScopeType,
billingPlan,
billingScopeId,
displayName,
location,
provisioningState,
quantity,
renew,
reservationOrderId,
reservedResourceProperties,
reservedResourceType,
reviewDateTime,
sku,
systemData,
term,
type
FROM azure.billing_benefits.reservation_order_alias
WHERE reservation_order_alias_name = '{{ reservation_order_alias_name }}' -- required
;

INSERT examples

create

Create a reservation order alias.

INSERT INTO azure.billing_benefits.reservation_order_alias (
sku,
location,
properties,
reservation_order_alias_name
)
SELECT 
'{{ sku }}' /* required */,
'{{ location }}',
'{{ properties }}',
'{{ reservation_order_alias_name }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: reservation_order_alias
props:
  - name: reservation_order_alias_name
    value: "{{ reservation_order_alias_name }}"
    description: Required parameter for the reservation_order_alias resource.
  - name: sku
    description: |
      Reservation order SKU. Required.
    value:
      name: "{{ name }}"
  - name: location
    value: "{{ location }}"
    description: |
      The Azure Region where the reservation benefits are applied to.
  - name: properties
    description: |
      Reservation order alias request properties.
    value:
      displayName: "{{ displayName }}"
      billingScopeId: "{{ billingScopeId }}"
      term: "{{ term }}"
      billingPlan: "{{ billingPlan }}"
      appliedScopeType: "{{ appliedScopeType }}"
      appliedScopeProperties:
        tenantId: "{{ tenantId }}"
        managementGroupId: "{{ managementGroupId }}"
        subscriptionId: "{{ subscriptionId }}"
        resourceGroupId: "{{ resourceGroupId }}"
        displayName: "{{ displayName }}"
      quantity: {{ quantity }}
      renew: {{ renew }}
      reservedResourceType: "{{ reservedResourceType }}"
      reviewDateTime: "{{ reviewDateTime }}"
      reservedResourceProperties:
        instanceFlexibility: "{{ instanceFlexibility }}"