通过

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

Microsoft.ApiManagement 服务/组 2021-08-01

  • 项目

Bicep 资源定义

可以使用针对以下操作部署服务/组资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/groups@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

属性值

service/groups

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“服务”的资源的符号名称
properties 提供给“创建组”操作的属性。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名称 说明 值
description 组说明。 字符串
displayName 组名称。 字符串 (必需)
externalId 外部组的标识符，此属性包含来自外部标识提供者的组 ID，例如对于 Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id};否则值为 null。 字符串
type 组类型。 “custom”
“external”
“system”

快速入门模板

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

模板 说明
使用模板创建 API 管理实例和所有子资源

部署到 Azure		 此模板演示如何创建API 管理服务和配置子实体

ARM 模板资源定义

可以使用针对以下操作部署服务/组资源类型：

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

属性值

service/groups

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/groups”
apiVersion 资源 API 版本 '2021-08-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
properties 提供给“创建组”操作的属性。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名称 说明 值
description 组说明。 字符串
displayName 组名称。 字符串 (必需)
externalId 外部组的标识符，此属性包含来自外部标识提供者的组 ID，例如 Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id};否则值为 null。 字符串
type 组类型。 'custom'
'external'
“system”

快速入门模板

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

模板 说明
使用模板创建 API 管理实例和所有子资源

部署到 Azure		 此模板演示如何创建API 管理服务和配置子实体

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

可以使用面向以下操作部署服务/组资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

属性值

service/groups

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/groups@2021-08-01”
name 资源名称 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
parent_id 此资源的父资源的 ID。 类型为：service 的资源的 ID
properties 提供给“创建组”操作的属性。 GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

名称 说明 值
description 组说明。 字符串
displayName 组名称。 字符串 (必需)
externalId 外部组的标识符，此属性包含来自外部标识提供者的组 ID，例如 Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id};否则值为 null。 字符串
type 组类型。 "custom"
“external”
“system”