通过

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

Microsoft.ApiManagement 服务/租户 2022-08-01

  • 项目

Bicep 资源定义

可以使用目标操作部署服务/租户资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/tenant@2022-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    enabled: bool
    primaryKey: 'string'
    principalId: 'string'
    secondaryKey: 'string'
  }
}

属性值

AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties

名字 描述 价值
启用 确定是否启用了直接访问。 bool
primaryKey 主访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串
principalId 主体（用户）标识符。 字符串
secondaryKey 辅助访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

Microsoft.ApiManagement/service/tenant

名字 描述 价值
名字 资源名称 “access”
“gitAccess”（必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
性能 租户访问信息更新参数属性。 AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties

ARM 模板资源定义

可以使用目标操作部署服务/租户资源类型：

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/tenant",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "enabled": "bool",
    "primaryKey": "string",
    "principalId": "string",
    "secondaryKey": "string"
  }
}

属性值

AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties

名字 描述 价值
启用 确定是否启用了直接访问。 bool
primaryKey 主访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串
principalId 主体（用户）标识符。 字符串
secondaryKey 辅助访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

Microsoft.ApiManagement/service/tenant

名字 描述 价值
apiVersion API 版本 '2022-08-01'
名字 资源名称 “access”
“gitAccess”（必需）
性能 租户访问信息更新参数属性。 AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/tenant”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/租户资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/tenant@2022-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      primaryKey = "string"
      principalId = "string"
      secondaryKey = "string"
    }
  })
}

属性值

AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties

名字 描述 价值
启用 确定是否启用了直接访问。 bool
primaryKey 主访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串
principalId 主体（用户）标识符。 字符串
secondaryKey 辅助访问密钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

Microsoft.ApiManagement/service/tenant

名字 描述 价值
名字 资源名称 “access”
“gitAccess”（必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 租户访问信息更新参数属性。 AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/tenant@2022-08-01”