Microsoft.Subscription aliases 2019-10-01-preview

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@2019-10-01-preview' = {
  name: 'string'
  scope: tenant()
  properties: {
    billingScope: 'string'
    displayName: 'string'
    subscriptionId: 'string'
    workload: 'string'
  }
}

Property values

aliases

PutAliasRequestPropertiesOrPutAliasResponsePropertie...

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": "2019-10-01-preview",
  "name": "string",
  "scope": "/",
  "properties": {
    "billingScope": "string",
    "displayName": "string",
    "subscriptionId": "string",
    "workload": "string"
  }
}

Property values

aliases

PutAliasRequestPropertiesOrPutAliasResponsePropertie...

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@2019-10-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      billingScope = "string"
      displayName = "string"
      subscriptionId = "string"
      workload = "string"
    }
  })
}

Property values

aliases

PutAliasRequestPropertiesOrPutAliasResponsePropertie...