Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The savingsPlanOrderAliases resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BillingBenefits/savingsPlanOrderAliases resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.BillingBenefits/savingsPlanOrderAliases@2024-11-01-preview' = {
kind: 'string'
name: 'string'
properties: {
appliedScopeProperties: {
displayName: 'string'
managementGroupId: 'string'
resourceGroupId: 'string'
subscriptionId: 'string'
tenantId: 'string'
}
appliedScopeType: 'string'
billingPlan: 'string'
billingScopeId: 'string'
commitment: {
amount: int
currencyCode: 'string'
grain: 'string'
}
displayName: 'string'
renew: bool
term: 'string'
}
sku: {
name: 'string'
}
}
Property Values
Microsoft.BillingBenefits/savingsPlanOrderAliases
| Name | Description | Value |
|---|---|---|
| kind | Resource provider kind | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_\-\.]+$ (required) |
| properties | Savings plan order alias properties | SavingsPlanOrderAliasProperties |
| sku | Savings plan SKU | ResourceSku (required) |
AppliedScopeProperties
| Name | Description | Value |
|---|---|---|
| displayName | Display name | string |
| managementGroupId | Fully-qualified identifier of the management group where the benefit must be applied. | string |
| resourceGroupId | Fully-qualified identifier of the resource group. | string |
| subscriptionId | Fully-qualified identifier of the subscription. | string |
| tenantId | Tenant ID where the benefit is applied. | string |
Commitment
| Name | Description | Value |
|---|---|---|
| amount | int | |
| currencyCode | The ISO 4217 3-letter currency code for the currency used by this purchase record. | string |
| grain | Commitment grain. | 'FullTerm' 'Hourly' 'Unknown' |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU to be applied | string |
SavingsPlanOrderAliasProperties
| Name | Description | Value |
|---|---|---|
| appliedScopeProperties | Properties specific to applied scope type. Not required if not applicable. | AppliedScopeProperties |
| appliedScopeType | Type of the Applied Scope. | 'ManagementGroup' 'Shared' 'Single' |
| billingPlan | Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. | 'P1M' |
| billingScopeId | Subscription that will be charged for purchasing the benefit | string |
| commitment | Commitment towards the benefit. | Commitment |
| displayName | Display name | string |
| renew | Setting this to true will automatically purchase a new benefit on the expiration date time. | bool |
| term | Represent benefit term in ISO 8601 format. | 'P1Y' 'P3Y' 'P5Y' |
ARM template resource definition
The savingsPlanOrderAliases resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BillingBenefits/savingsPlanOrderAliases resource, add the following JSON to your template.
{
"type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
"apiVersion": "2024-11-01-preview",
"name": "string",
"kind": "string",
"properties": {
"appliedScopeProperties": {
"displayName": "string",
"managementGroupId": "string",
"resourceGroupId": "string",
"subscriptionId": "string",
"tenantId": "string"
},
"appliedScopeType": "string",
"billingPlan": "string",
"billingScopeId": "string",
"commitment": {
"amount": "int",
"currencyCode": "string",
"grain": "string"
},
"displayName": "string",
"renew": "bool",
"term": "string"
},
"sku": {
"name": "string"
}
}
Property Values
Microsoft.BillingBenefits/savingsPlanOrderAliases
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-11-01-preview' |
| kind | Resource provider kind | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_\-\.]+$ (required) |
| properties | Savings plan order alias properties | SavingsPlanOrderAliasProperties |
| sku | Savings plan SKU | ResourceSku (required) |
| type | The resource type | 'Microsoft.BillingBenefits/savingsPlanOrderAliases' |
AppliedScopeProperties
| Name | Description | Value |
|---|---|---|
| displayName | Display name | string |
| managementGroupId | Fully-qualified identifier of the management group where the benefit must be applied. | string |
| resourceGroupId | Fully-qualified identifier of the resource group. | string |
| subscriptionId | Fully-qualified identifier of the subscription. | string |
| tenantId | Tenant ID where the benefit is applied. | string |
Commitment
| Name | Description | Value |
|---|---|---|
| amount | int | |
| currencyCode | The ISO 4217 3-letter currency code for the currency used by this purchase record. | string |
| grain | Commitment grain. | 'FullTerm' 'Hourly' 'Unknown' |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU to be applied | string |
SavingsPlanOrderAliasProperties
| Name | Description | Value |
|---|---|---|
| appliedScopeProperties | Properties specific to applied scope type. Not required if not applicable. | AppliedScopeProperties |
| appliedScopeType | Type of the Applied Scope. | 'ManagementGroup' 'Shared' 'Single' |
| billingPlan | Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. | 'P1M' |
| billingScopeId | Subscription that will be charged for purchasing the benefit | string |
| commitment | Commitment towards the benefit. | Commitment |
| displayName | Display name | string |
| renew | Setting this to true will automatically purchase a new benefit on the expiration date time. | bool |
| term | Represent benefit term in ISO 8601 format. | 'P1Y' 'P3Y' 'P5Y' |
Usage Examples
Terraform (AzAPI provider) resource definition
The savingsPlanOrderAliases resource type can be deployed with operations that target:
- Tenant
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BillingBenefits/savingsPlanOrderAliases resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.BillingBenefits/savingsPlanOrderAliases@2024-11-01-preview"
name = "string"
parent_id = "string"
body = {
kind = "string"
properties = {
appliedScopeProperties = {
displayName = "string"
managementGroupId = "string"
resourceGroupId = "string"
subscriptionId = "string"
tenantId = "string"
}
appliedScopeType = "string"
billingPlan = "string"
billingScopeId = "string"
commitment = {
amount = int
currencyCode = "string"
grain = "string"
}
displayName = "string"
renew = bool
term = "string"
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.BillingBenefits/savingsPlanOrderAliases
| Name | Description | Value |
|---|---|---|
| kind | Resource provider kind | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_\-\.]+$ (required) |
| properties | Savings plan order alias properties | SavingsPlanOrderAliasProperties |
| sku | Savings plan SKU | ResourceSku (required) |
| type | The resource type | "Microsoft.BillingBenefits/savingsPlanOrderAliases@2024-11-01-preview" |
AppliedScopeProperties
| Name | Description | Value |
|---|---|---|
| displayName | Display name | string |
| managementGroupId | Fully-qualified identifier of the management group where the benefit must be applied. | string |
| resourceGroupId | Fully-qualified identifier of the resource group. | string |
| subscriptionId | Fully-qualified identifier of the subscription. | string |
| tenantId | Tenant ID where the benefit is applied. | string |
Commitment
| Name | Description | Value |
|---|---|---|
| amount | int | |
| currencyCode | The ISO 4217 3-letter currency code for the currency used by this purchase record. | string |
| grain | Commitment grain. | 'FullTerm' 'Hourly' 'Unknown' |
ResourceSku
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU to be applied | string |
SavingsPlanOrderAliasProperties
| Name | Description | Value |
|---|---|---|
| appliedScopeProperties | Properties specific to applied scope type. Not required if not applicable. | AppliedScopeProperties |
| appliedScopeType | Type of the Applied Scope. | 'ManagementGroup' 'Shared' 'Single' |
| billingPlan | Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. | 'P1M' |
| billingScopeId | Subscription that will be charged for purchasing the benefit | string |
| commitment | Commitment towards the benefit. | Commitment |
| displayName | Display name | string |
| renew | Setting this to true will automatically purchase a new benefit on the expiration date time. | bool |
| term | Represent benefit term in ISO 8601 format. | 'P1Y' 'P3Y' 'P5Y' |