Microsoft.Subscription aliases 2021-10-01
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.
Bicep resource definition
The aliases 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.Subscription/aliases resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Subscription/aliases@2021-10-01' = {
name: 'string'
properties: {
additionalProperties: {
managementGroupId: 'string'
subscriptionOwnerId: 'string'
subscriptionTenantId: 'string'
tags: {
{customized property}: 'string'
}
}
billingScope: 'string'
displayName: 'string'
resellerId: 'string'
subscriptionId: 'string'
workload: 'string'
}
}
Property values
Microsoft.Subscription/aliases
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties |
PutAliasRequestAdditionalProperties
| Name | Description | Value |
|---|---|---|
| managementGroupId | Management group Id for the subscription. | string |
| subscriptionOwnerId | Owner Id of the subscription | string |
| subscriptionTenantId | Tenant Id of the subscription | string |
| tags | Tags for the subscription | PutAliasRequestAdditionalPropertiesTags |
PutAliasRequestAdditionalPropertiesTags
| Name | Description | Value |
|---|
PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Put alias request additional properties. | PutAliasRequestAdditionalProperties |
| billingScope | Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} |
string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller 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 samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| 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 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.Subscription/aliases resource, add the following JSON to your template.
{
"type": "Microsoft.Subscription/aliases",
"apiVersion": "2021-10-01",
"name": "string",
"properties": {
"additionalProperties": {
"managementGroupId": "string",
"subscriptionOwnerId": "string",
"subscriptionTenantId": "string",
"tags": {
"{customized property}": "string"
}
},
"billingScope": "string",
"displayName": "string",
"resellerId": "string",
"subscriptionId": "string",
"workload": "string"
}
}
Property values
Microsoft.Subscription/aliases
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-10-01' |
| name | The resource name | string (required) |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties |
| type | The resource type | 'Microsoft.Subscription/aliases' |
PutAliasRequestAdditionalProperties
| Name | Description | Value |
|---|---|---|
| managementGroupId | Management group Id for the subscription. | string |
| subscriptionOwnerId | Owner Id of the subscription | string |
| subscriptionTenantId | Tenant Id of the subscription | string |
| tags | Tags for the subscription | PutAliasRequestAdditionalPropertiesTags |
PutAliasRequestAdditionalPropertiesTags
| Name | Description | Value |
|---|
PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Put alias request additional properties. | PutAliasRequestAdditionalProperties |
| billingScope | Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} |
string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller 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 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.Subscription/aliases resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Subscription/aliases@2021-10-01"
name = "string"
body = jsonencode({
properties = {
additionalProperties = {
managementGroupId = "string"
subscriptionOwnerId = "string"
subscriptionTenantId = "string"
tags = {
{customized property} = "string"
}
}
billingScope = "string"
displayName = "string"
resellerId = "string"
subscriptionId = "string"
workload = "string"
}
})
}
Property values
Microsoft.Subscription/aliases
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Put alias request properties. | PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties |
| type | The resource type | "Microsoft.Subscription/aliases@2021-10-01" |
PutAliasRequestAdditionalProperties
| Name | Description | Value |
|---|---|---|
| managementGroupId | Management group Id for the subscription. | string |
| subscriptionOwnerId | Owner Id of the subscription | string |
| subscriptionTenantId | Tenant Id of the subscription | string |
| tags | Tags for the subscription | PutAliasRequestAdditionalPropertiesTags |
PutAliasRequestAdditionalPropertiesTags
| Name | Description | Value |
|---|
PutAliasRequestPropertiesOrSubscriptionAliasResponseProperties
| Name | Description | Value |
|---|---|---|
| additionalProperties | Put alias request additional properties. | PutAliasRequestAdditionalProperties |
| billingScope | Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} |
string |
| displayName | The friendly name of the subscription. | string |
| resellerId | Reseller 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' |