通过

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

Microsoft.ApiManagement service/apiVersionSets

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

属性值

service/apiVersionSets

名字 描述 价值
名字 资源名称

了解如何在 Bicep中设置子资源的名称和类型。		 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
性能 API VersionSet 协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 价值
描述 API 版本集的说明。 字符串
displayName API 版本集的名称 string （必需）

约束：
最小长度 = 1
最大长度 = 100
versionHeaderName 如果 versioningScheme 设置为 header，则表示 API 版本的 HTTP 标头参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100
versioningScheme 一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。 “Header”
“Query”
“Segment”（必需）
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

属性值

service/apiVersionSets

名字 描述 价值
类型 资源类型 “Microsoft.ApiManagement/service/apiVersionSets”
apiVersion 资源 API 版本 '2023-09-01-preview'
名字 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 string （必需）
性能 API VersionSet 协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 价值
描述 API 版本集的说明。 字符串
displayName API 版本集的名称 string （必需）

约束：
最小长度 = 1
最大长度 = 100
versionHeaderName 如果 versioningScheme 设置为 header，则表示 API 版本的 HTTP 标头参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100
versioningScheme 一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。 “Header”
“Query”
“Segment”（必需）
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

属性值

service/apiVersionSets

名字 描述 价值
类型 资源类型 “Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview”
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 API VersionSet 协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 价值
描述 API 版本集的说明。 字符串
displayName API 版本集的名称 string （必需）

约束：
最小长度 = 1
最大长度 = 100
versionHeaderName 如果 versioningScheme 设置为 header，则表示 API 版本的 HTTP 标头参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100
versioningScheme 一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。 “Header”
“Query”
“段”（必需）
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串

约束：
最小长度 = 1
最大长度 = 100