Udostępnij za pośrednictwem

Usługa Microsoft.ApiManagement/apiVersionSets 2019-12-01-wersja zapoznawcza

Definicja zasobu Bicep

Typ zasobu service/apiVersionSets można wdrożyć przy użyciu operacji docelowych:

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@2019-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/apiVersionSets

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
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. Właściwości ApiVersionSetContractProperties

Właściwości ApiVersionSetContractProperties

Nazwa Opis Wartość
opis Opis zestawu wersji interfejsu API. struna
nazwa wyświetlana Nazwa zestawu wersji interfejsu API struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100 (wymagana)
versionHeaderName (nazwa_nagłówka) 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 (schemat wersji) Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. "Nagłówek"
"Zapytanie"
"Segment" (wymagany)
versionQueryName (nazwa_zapytania) 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:

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": "2019-12-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/apiVersionSets

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2019-12-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości kontraktu Zestawu wersji interfejsu API. Właściwości ApiVersionSetContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apiVersionSets"

Właściwości ApiVersionSetContractProperties

Nazwa Opis Wartość
opis Opis zestawu wersji interfejsu API. struna
nazwa wyświetlana Nazwa zestawu wersji interfejsu API struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100 (wymagana)
versionHeaderName (nazwa_nagłówka) 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 (schemat wersji) Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. "Nagłówek"
"Zapytanie"
"Segment" (wymagany)
versionQueryName (nazwa_zapytania) 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

Przykłady użycia

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@2019-12-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/apiVersionSets

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id (identyfikator rodzica) 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. Właściwości ApiVersionSetContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apiVersionSets@2019-12-01-preview"

Właściwości ApiVersionSetContractProperties

Nazwa Opis Wartość
opis Opis zestawu wersji interfejsu API. struna
nazwa wyświetlana Nazwa zestawu wersji interfejsu API struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100 (wymagana)
versionHeaderName (nazwa_nagłówka) 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 (schemat wersji) Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. "Nagłówek"
"Zapytanie"
"Segment" (wymagany)
versionQueryName (nazwa_zapytania) 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