Sdílet prostřednictvím

Služba Microsoft.ApiManagement/apiVersionSets

  • Článek

Definice prostředku Bicep

Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apiVersionSets, přidejte do šablony následující bicep.

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

Hodnoty vlastností

service/apiVersionSets

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu service
properties Vlastnosti kontraktu API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Název Description Hodnota
description Popis sady verzí rozhraní API. řetězec
displayName Název sady verzí rozhraní API string (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na headerhodnotu . řetězec
správa verzíScheme Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API. 'Header'
Dotaz
Segment (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzíScheme nastavená na query. řetězec

Definice prostředku šablony ARM

Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apiVersionSets, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

service/apiVersionSets

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/apiVersionSets
apiVersion Verze rozhraní API prostředku 2023-05-01-preview
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
properties Vlastnosti kontraktu API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Název Description Hodnota
description Popis sady verzí rozhraní API. řetězec
displayName Název sady verzí rozhraní API string (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na headerhodnotu . řetězec
správa verzíScheme Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API. 'Header'
Dotaz
Segment (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na queryhodnotu . řetězec

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apiVersionSets, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

service/apiVersionSets

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: service
properties Vlastnosti kontraktu API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Název Description Hodnota
description Popis sady verzí rozhraní API řetězec
displayName Název sady verzí rozhraní API string (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je funkce VersioningScheme nastavená na headerhodnotu . řetězec
správa verzíScheme Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API. Hlavička
"Dotaz"
"Segment" (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na queryhodnotu . řetězec