Api Version Set - List By Service

Zobrazí kolekci sad verzí rozhraní API v zadané instanci služby.

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

Parametry identifikátoru URI

Name In Required Type Description
resourceGroupName
path True
  • string

Název skupiny prostředků.

serviceName
path True
  • string

Název služby API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují Microsoft Azure předplatné. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API, která se má použít s požadavkem klienta.

$filter
query
  • string

| | polí | využití Podporované operátory | Podporované funkce |
|-------------|-------------|-------------|-------------|

$skip
query
  • integer
int32

Počet záznamů, které se mají přeskočit

$top
query
  • integer
int32

Počet vrácených záznamů.

Odpovědi

Name Type Description
200 OK

Zobrazí kolekci entit sady verzí rozhraní API.

Other Status Codes

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementListApiVersionSets

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets?api-version=2021-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/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/subid/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": ""
}

Definice

ApiVersionSetCollection

Reprezentace seznamu sady verzí stránkovaného rozhraní API

ApiVersionSetContract

Podrobnosti kontraktu sady verzí rozhraní API

ErrorFieldContract

Kontrakt pole chyby.

ErrorResponse

Odpověď na chybu.

versioningScheme

Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP.

ApiVersionSetCollection

Reprezentace seznamu sady verzí stránkovaného rozhraní API

Name Type Description
count
  • integer

Celkový počet záznamů na všech stránkách

nextLink
  • string

Odkaz na další stránku, pokud existuje.

value

Hodnoty stránky.

ApiVersionSetContract

Podrobnosti kontraktu sady verzí rozhraní API

Name Type Description
id
  • string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Název prostředku

properties.description
  • string

Popis sady verzí rozhraní API

properties.displayName
  • string

Název sady verzí rozhraní API

properties.versionHeaderName
  • string

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je nastavena hodnota headerversioningScheme .

properties.versionQueryName
  • string

Název parametru dotazu, který označuje verzi rozhraní API, pokud je nastavena hodnota queryversioningScheme .

properties.versioningScheme

Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP.

type
  • string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft. Storage/storageAccounts

ErrorFieldContract

Kontrakt pole chyby.

Name Type Description
code
  • string

Kód chyby na úrovni vlastnosti.

message
  • string

Čitelné znázornění chyby na úrovni vlastností

target
  • string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Type Description
error.code
  • string

Kód chyby definovaný službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

Seznamneplatných

error.message
  • string

Čitelné znázornění chyby člověkem

versioningScheme

Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP.

Name Type Description
Header
  • string

Verze rozhraní API se předává v hlavičce HTTP.

Query
  • string

Verze rozhraní API se předává v parametru dotazu.

Segment
  • string

Verze rozhraní API se předává v segmentu cesty.