Microsoft.ApiManagement service/apiVersionSets 2021-08-01

  • 發行項

Bicep 資源定義

服務/apiVersionSets 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/apiVersionSets 資源，請將下列 Bicep 新增至範本。

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

屬性值

service/apiVersionSets

名字 描述 價值
名字 資源名稱

請參閱如何在 Bicep 中設定子資源的名稱和類型。		 字串 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 API VersionSet 合約屬性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 價值
描述 API 版本集的描述。 字串
displayName API 版本集的名稱 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串

約束：
最小長度 = 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": "2021-08-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

屬性值

service/apiVersionSets

名字 描述 價值
類型 資源類型 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion 資源 API 版本 '2021-08-01'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。		 字串 （必要）
性能 API VersionSet 合約屬性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 價值
描述 API 版本集的描述。 字串
displayName API 版本集的名稱 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串

約束：
最小長度 = 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@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

屬性值

service/apiVersionSets

名字 描述 價值
類型 資源類型 “Microsoft.ApiManagement/service/apiVersionSets@2021-08-01”
名字 資源名稱 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 API VersionSet 合約屬性。 ApiVersionSetContractProperties

ApiVersionSetContractProperties

名字 描述 價值
描述 API 版本集的描述。 字串
displayName API 版本集的名稱 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
versionHeaderName 如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。 字串

約束：
最小長度 = 1
最大長度 = 100
versioningScheme 值，決定 API 版本識別碼在 HTTP 要求中的位置。 “Header”
“Query”
“Segment” （必要）
versionQueryName 如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。 字串

約束：
最小長度 = 1
最大長度 = 100