Microsoft.ApiManagement service/apiVersionSets
- nejnovější
-
2023-09-01-preview - 2022-08-01
-
2021-08-01
Definice prostředku Bicep
Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení 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í 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'
}
}
Hodnoty vlastností
service/apiVersionSets
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku Podívejte se, jak nastavit názvy a typy podřízených prostředků v Bicep. |
string (povinné) |
| rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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: služby |
| vlastnosti | Vlastnosti kontraktu rozhraní API VersionSet | apiVersionSetContractProperties |
ApiVersionSetContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| displayName | Název sady verzí rozhraní API | string (povinné) Omezení: Minimální délka = 1 Maximální délka = 100 |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | Hlavička Dotaz Segment (povinné) |
| versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
Definice prostředku šablony ARM
Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení 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í JSON.
{
"type": "Microsoft.ApiManagement/service/apiVersionSets",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Hodnoty vlastností
service/apiVersionSets
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.ApiManagement/service/apiVersionSets |
| apiVersion | Verze rozhraní API prostředku | 2023-09-01-preview |
| Jméno | Název prostředku Podívejte se, jak nastavit názvy a typy podřízených prostředků v šablonách JSON ARM. |
string (povinné) |
| vlastnosti | Vlastnosti kontraktu rozhraní API VersionSet | apiVersionSetContractProperties |
ApiVersionSetContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| displayName | Název sady verzí rozhraní API | string (povinné) Omezení: Minimální délka = 1 Maximální délka = 100 |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | Hlavička Dotaz Segment (povinné) |
| versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku service/apiVersionSets je možné nasadit s operacemi, které cílí:
- 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-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
})
}
Hodnoty vlastností
service/apiVersionSets
| Jméno | Popis | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview |
| Jméno | Název prostředku | string (povinné) |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: služby |
| vlastnosti | Vlastnosti kontraktu rozhraní API VersionSet | apiVersionSetContractProperties |
ApiVersionSetContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| displayName | Název sady verzí rozhraní API | string (povinné) Omezení: Minimální délka = 1 Maximální délka = 100 |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | "Header" (Záhlaví) Dotaz Segment (povinné) |
| versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |