Microsoft.ApiManagement service/apiVersionSets
Definicja zasobu Bicep
Typ zasobu service/apiVersionSets można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apiVersionSets, dodaj następujący kod Bicep do szablonu.
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'
}
}
Wartości właściwości
service/apiVersionSets
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep. |
ciąg (wymagany) |
| rodzic | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: usługi |
| Właściwości | Właściwości kontraktu zestawu wersji interfejsu API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| displayName | Nazwa zestawu wersji interfejsu API | ciąg (wymagany) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" (wymagany) |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
Definicja zasobu szablonu usługi ARM
Typ zasobu service/apiVersionSets można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apiVersionSets, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/apiVersionSets",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Wartości właściwości
service/apiVersionSets
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apiVersionSets" |
| apiVersion | Wersja interfejsu API zasobów | "2023-09-01-preview" |
| nazwa | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON. |
ciąg (wymagany) |
| Właściwości | Właściwości kontraktu zestawu wersji interfejsu API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| displayName | Nazwa zestawu wersji interfejsu API | ciąg (wymagany) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" (wymagany) |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu service/apiVersionSets można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apiVersionSets, dodaj następujący program Terraform do szablonu.
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"
}
})
}
Wartości właściwości
service/apiVersionSets
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview" |
| nazwa | Nazwa zasobu | ciąg (wymagany) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Właściwości kontraktu zestawu wersji interfejsu API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| displayName | Nazwa zestawu wersji interfejsu API | ciąg (wymagany) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" (wymagany) |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 |