Microsoft.Subscription aliases

مقالة
02/23/2022
قراءة خلال 2 دقائق

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.

For Bicep, see Set scope on extension resources in Bicep.
For JSON, see Set scope on extension resources in ARM templates.

Valid deployment scopes for the aliases resource are:

Tenant

Template format

To create a Microsoft.Subscription/aliases resource, add the following Bicep or JSON to your template.

Bicep
JSON

resource symbolicname 'Microsoft.Subscription/aliases@2021-10-01' = {
  name: 'string'
  scope: tenant()
  properties: {
    additionalProperties: {
      managementGroupId: 'string'
      subscriptionOwnerId: 'string'
      subscriptionTenantId: 'string'
      tags: {}
    }
    billingScope: 'string'
    displayName: 'string'
    resellerId: 'string'
    subscriptionId: 'string'
    workload: 'string'
  }
}

{
  "type": "Microsoft.Subscription/aliases",
  "apiVersion": "2021-10-01",
  "name": "string",
  "scope": "/",
  "properties": {
    "additionalProperties": {
      "managementGroupId": "string",
      "subscriptionOwnerId": "string",
      "subscriptionTenantId": "string",
      "tags": {}
    },
    "billingScope": "string",
    "displayName": "string",
    "resellerId": "string",
    "subscriptionId": "string",
    "workload": "string"
  }
}

Property values

aliases

Name	Description	Value
type	The resource type For Bicep, set this value in the resource declaration.	'Microsoft.Subscription/aliases'
apiVersion	The resource api version For Bicep, set this value in the resource declaration.	'2021-10-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 Bicep: `tenant()`. For JSON: `/`.
properties	Put subscription properties.	PutAliasRequestProperties

PutAliasRequestProperties

Name	Description	Value
additionalProperties	Put subscription 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'

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	object

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.