Microsoft.Subscription aliases 2020-09-01
Bicep resource definition
The aliases resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
The aliases resource type can be deployed with operations that target:
- Tenants - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Remarks
You can use the Microsoft.Subscription/aliases resource to create a new subscription, but not to update an existing subscription. if you attempt to update properties through the aliases resource type, those changes aren't retained.
To rename a subscription, use the Rename operation.
Resource format
To create a Microsoft.Subscription/aliases resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Subscription/aliases@2020-09-01' = {
name: 'string'
scope: tenant()
properties: {
billingScope: 'string'
displayName: 'string'
resellerId: 'string'
subscriptionId: 'string'
workload: 'string'
}
}
Property values
aliases
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | For Bicep: tenant(). |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrPutAliasResponsePropertie... (required) |
PutAliasRequestPropertiesOrPutAliasResponsePropertie...
| Name | Description | Value |
|---|---|---|
| billingScope | Determines whether subscription is fieldLed, partnerLed or LegacyEA | string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller ID, basically MPN Id | string |
| subscriptionId | This parameter can be used to create alias for existing subscription Id | string |
| workload | The workload type of the subscription. It can be either Production or DevTest. | 'DevTest' 'Production' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a subscription under an EA account |
This template is a management group template that will create a subscription via an alias. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
| Create a subscription, resourceGroup and storageAccount |
This template is a management group template that will create a subscription, a resourceGroup and a storageAccount in the same template. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
ARM template resource definition
The aliases resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
The aliases resource type can be deployed with operations that target:
- Tenants - See tenant deployment commands
For a list of changed properties in each API version, see change log.
Remarks
You can use the Microsoft.Subscription/aliases resource to create a new subscription, but not to update an existing subscription. if you attempt to update properties through the aliases resource type, those changes aren't retained.
To rename a subscription, use the Rename operation.
Resource format
To create a Microsoft.Subscription/aliases resource, add the following JSON to your template.
{
"type": "Microsoft.Subscription/aliases",
"apiVersion": "2020-09-01",
"name": "string",
"scope": "/",
"properties": {
"billingScope": "string",
"displayName": "string",
"resellerId": "string",
"subscriptionId": "string",
"workload": "string"
}
}
Property values
aliases
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Subscription/aliases' |
| apiVersion | The resource api version | '2020-09-01' |
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | For JSON: /. |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrPutAliasResponsePropertie... (required) |
PutAliasRequestPropertiesOrPutAliasResponsePropertie...
| Name | Description | Value |
|---|---|---|
| billingScope | Determines whether subscription is fieldLed, partnerLed or LegacyEA | string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller ID, basically MPN Id | string |
| subscriptionId | This parameter can be used to create alias for existing subscription Id | string |
| workload | The workload type of the subscription. It can be either Production or DevTest. | 'DevTest' 'Production' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a subscription under an EA account |
This template is a management group template that will create a subscription via an alias. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
| Create a subscription, resourceGroup and storageAccount |
This template is a management group template that will create a subscription, a resourceGroup and a storageAccount in the same template. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
Terraform (AzAPI provider) resource definition
The aliases resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
The aliases resource type can be deployed with operations that target:
- Tenants
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Subscription/aliases resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Subscription/aliases@2020-09-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
billingScope = "string"
displayName = "string"
resellerId = "string"
subscriptionId = "string"
workload = "string"
}
})
}
Property values
aliases
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Subscription/aliases@2020-09-01" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrPutAliasResponsePropertie... (required) |
PutAliasRequestPropertiesOrPutAliasResponsePropertie...
| Name | Description | Value |
|---|---|---|
| billingScope | Determines whether subscription is fieldLed, partnerLed or LegacyEA | string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller ID, basically MPN Id | string |
| subscriptionId | This parameter can be used to create alias for existing subscription Id | string |
| workload | The workload type of the subscription. It can be either Production or DevTest. | "DevTest" "Production" |