你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Subscription 别名

• 最新
• 2021-10-01
• 2020-09-01
• 2019-10-01-preview

Bicep 资源定义

别名资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 Bicep 中设置扩展资源的范围。

别名资源类型可以使用面向以下对象的操作进行部署：

• 租户 - 请参阅 租户部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

注解

可以使用 资源 Microsoft.Subscription/aliases 创建新订阅，但不能更新现有订阅。 如果尝试通过 aliases 资源类型更新属性，则不会保留这些更改。

若要重命名订阅，请使用 重命名操作。

资源格式

若要创建 Microsoft.Subscription/aliases 资源，请将以下 Bicep 添加到模板。

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'
  }
}

属性值

aliases

名称	说明	值
name	资源名称	字符串 (必需)
scope	在不同于部署范围的范围创建扩展资源时使用 。	对于 Bicep： tenant()。
properties	放置别名请求属性。	PutAliasRequestPropertiesOrSubscriptionAliasResponse...

PutAliasRequestPropertiesOrSubscriptionAliasResponse...

名称	说明	值
additionalProperties	放置别名请求其他属性。	PutAliasRequestAdditionalProperties
billingScope	订阅的计费范围。 对于 CustomerLed 和 FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} 对于 PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} 对于旧版 EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}	字符串
displayName	订阅的友好名称。	字符串
resellerId	经销商 ID	字符串
subscriptionId	此参数可用于为现有订阅 ID 创建别名	字符串
workload	订阅的工作负荷类型。 它可以是生产或开发测试。	'DevTest' “生产”

PutAliasRequestAdditionalProperties

名称	说明	值
managementGroupId	订阅的管理组 ID。	字符串
subscriptionOwnerId	订阅的所有者 ID	字符串
subscriptionTenantId	订阅的租户 ID	字符串
标记	订阅的标记	对象 (object)

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 EA 帐户下创建订阅	此模板是一个管理组模板，它将通过别名创建订阅。 它只能用于企业协议计费模式。 官方文档显示了其他类型的帐户所需的修改。
创建订阅、resourceGroup 和 storageAccount	此模板是一个管理组模板，用于在同一模板中创建订阅、resourceGroup 和 storageAccount。 它只能用于企业协议计费模式。 官方文档显示了其他类型的帐户所需的修改。

ARM 模板资源定义

别名资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围。

别名资源类型可以使用面向以下对象的操作进行部署：

• 租户 - 请参阅 租户部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

注解

可以使用 资源 Microsoft.Subscription/aliases 创建新订阅，但不能更新现有订阅。 如果尝试通过 aliases 资源类型更新属性，则不会保留这些更改。

若要重命名订阅，请使用 重命名操作。

资源格式

若要创建 Microsoft.Subscription/aliases 资源，请将以下 JSON 添加到模板。

{
  "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"
  }
}

属性值

aliases

名称	说明	Value
type	资源类型	'Microsoft.Subscription/aliases'
apiVersion	资源 API 版本	'2021-10-01'
name	资源名称	字符串 (必需)
scope	在不同于部署范围的范围创建扩展资源时使用 。	对于 JSON： /。
properties	放置别名请求属性。	PutAliasRequestPropertiesOrSubscriptionAliasResponse...

PutAliasRequestPropertiesOrSubscriptionAliasResponse...

名称	说明	值
additionalProperties	放置别名请求其他属性。	PutAliasRequestAdditionalProperties
billingScope	订阅的计费范围。 对于 CustomerLed 和 FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} 对于 PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} 对于旧版 EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}	字符串
displayName	订阅的友好名称。	字符串
resellerId	经销商 ID	字符串
subscriptionId	此参数可用于为现有订阅 ID 创建别名	字符串
workload	订阅的工作负荷类型。 它可以是生产或开发测试。	'DevTest' “生产”

PutAliasRequestAdditionalProperties

名称	说明	值
managementGroupId	订阅的管理组 ID。	字符串
subscriptionOwnerId	订阅的所有者 ID	字符串
subscriptionTenantId	订阅的租户 ID	字符串
标记	订阅的标记	对象 (object)

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 EA 帐户下创建订阅	此模板是一个管理组模板，它将通过别名创建订阅。 它只能用于企业协议计费模式。 官方文档显示了其他类型的帐户所需的修改。
创建订阅、resourceGroup 和 storageAccount	此模板是一个管理组模板，用于在同一模板中创建订阅、resourceGroup 和 storageAccount。 它只能用于企业协议计费模式。 官方文档显示了其他类型的帐户所需的修改。

Terraform (AzAPI 提供程序) 资源定义

别名资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

别名资源类型可以使用面向以下对象的操作进行部署：

• 租户

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Subscription/aliases 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Subscription/aliases@2021-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      additionalProperties = {
        managementGroupId = "string"
        subscriptionOwnerId = "string"
        subscriptionTenantId = "string"
        tags = {}
      }
      billingScope = "string"
      displayName = "string"
      resellerId = "string"
      subscriptionId = "string"
      workload = "string"
    }
  })
}

属性值

aliases

名称	说明	Value
type	资源类型	“Microsoft.Subscription/aliases@2021-10-01”
name	资源名称	字符串 (必需)
parent_id	要应用此扩展资源的资源的 ID。	字符串 (必需)
properties	放置别名请求属性。	PutAliasRequestPropertiesOrSubscriptionAliasResponse...

PutAliasRequestPropertiesOrSubscriptionAliasResponse...

名称	说明	值
additionalProperties	放置别名请求其他属性。	PutAliasRequestAdditionalProperties
billingScope	订阅的计费范围。 对于 CustomerLed 和 FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} 对于 PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} 对于旧版 EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}	字符串
displayName	订阅的友好名称。	字符串
resellerId	经销商 ID	字符串
subscriptionId	此参数可用于为现有订阅 ID 创建别名	字符串
workload	订阅的工作负荷类型。 它可以是生产或开发测试。	“DevTest” “Production”

PutAliasRequestAdditionalProperties

名称	说明	值
managementGroupId	订阅的管理组 ID。	字符串
subscriptionOwnerId	订阅的所有者 ID	字符串
subscriptionTenantId	订阅的租户 ID	字符串
标记	订阅的标记	对象 (object)