Api Version Set - List By Service

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Wyświetla kolekcję zestawów wersji interfejsu API w określonym wystąpieniu usługi.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?api-version=2024-05-01

Z parametrami opcjonalnymi:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje | |-------------|-------------|-------------|-------------|
$skip	query		integer (int32) minimum: 0	Liczba rekordów do pominięcia.
$top	query		integer (int32) minimum: 1	Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiVersionSetCollection	Wyświetla kolekcję jednostek zestawu wersji interfejsu API.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementListApiVersionSets

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets?api-version=2024-05-01

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs1",
      "properties": {
        "displayName": "api set 1",
        "versioningScheme": "Segment",
        "description": "Version configuration"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs2",
      "properties": {
        "displayName": "api set 2",
        "versioningScheme": "Query",
        "description": "Version configuration 2"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definicje

Nazwa	Opis
ApiVersionSetCollection	Reprezentacja listy zestawów wersji interfejsu API stronicowanego.
ApiVersionSetContract	Szczegóły kontraktu zestawu wersji interfejsu API.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

ApiVersionSetCollection

Objekt

Reprezentacja listy zestawów wersji interfejsu API stronicowanego.

Nazwa	Typ	Opis
count	integer (int64)	Łączna liczba rekordów na wszystkich stronach.
nextLink	string	Jeśli istnieje, link następnej strony.
value	ApiVersionSetContract[]	Wartości stron.

ApiVersionSetContract

Objekt

Szczegóły kontraktu zestawu wersji interfejsu API.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.description	string	Opis zestawu wersji interfejsu API.
properties.displayName	string minLength: 1 maxLength: 100	Nazwa zestawu wersji interfejsu API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query.
properties.versioningScheme	versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

versioningScheme

Wyliczanie

Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

Wartość	Opis
Header	Wersja interfejsu API jest przekazywana w nagłówku HTTP.
Query	Wersja interfejsu API jest przekazywana w parametrze zapytania.
Segment	Wersja interfejsu API jest przekazywana w segmencie ścieżki.