通过

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

Microsoft.ApiManagement service/workspaces/apiVersionSets 2023-03-01-preview

  • 项目

Bicep 资源定义

service/workspaces/apiVersionSets 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

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

属性值

service/workspaces/apiVersionSets

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为资源的符号名称： 工作区
properties API 版本集协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名称 说明 值
description API 版本集的说明。 字符串
displayName API 版本集的名称 字符串 (必需)
versionHeaderName HTTP 标头参数的名称，如果 versioningScheme 设置为 header，则指示 API 版本。 字符串
versioningScheme 一个 值，该值确定 API 版本标识符在 HTTP 请求中的位置。 “Header”
“Query”
“Segment” (必需)
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串

ARM 模板资源定义

service/workspaces/apiVersionSets 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

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

属性值

service/workspaces/apiVersionSets

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/workspaces/apiVersionSets”
apiVersion 资源 API 版本 “2023-03-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
properties API 版本集协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名称 说明 值
description API 版本集的说明。 字符串
displayName API 版本集的名称 字符串 (必需)
versionHeaderName HTTP 标头参数的名称，如果 versioningScheme 设置为 header，则指示 API 版本。 字符串
versioningScheme 一个 值，该值确定 API 版本标识符在 HTTP 请求中的位置。 “Header”
“Query”
“Segment” (必需)
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串

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

service/workspaces/apiVersionSets 资源类型可以使用面向以下对象的操作进行部署：

  • 资源组

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

资源格式

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

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

属性值

service/workspaces/apiVersionSets

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-03-01-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为的资源的 ID： 工作区
properties API 版本集协定属性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名称 说明 值
description API 版本集的说明。 字符串
displayName API 版本集的名称 字符串 (必需)
versionHeaderName HTTP 标头参数的名称，如果 versioningScheme 设置为 header，则指示 API 版本。 字符串
versioningScheme 一个 值，该值确定 API 版本标识符在 HTTP 请求中的位置。 “标头”
“查询”
“Segment” (必需)
versionQueryName 如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。 字符串