Api Version Set - Get

Szolgáltatás:

API Management

API-verzió:

2024-05-01

Lekéri az api-verziókészlet azonosítója által megadott adatait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Api-verziókészlet azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	ApiVersionSetContract	Lekéri a megadott Api Verziókészlet entitást. Fejlécek ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementGetApiVersionSet

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

{
  "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": "Version Set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definíciók

Name	Description
ApiVersionSetContract	AZ API-verziókészlet szerződésének részletei.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
versioningScheme	Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.

ApiVersionSetContract

Objektum

AZ API-verziókészlet szerződésének részletei.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.description	string	Az API verziókészletének leírása.
properties.displayName	string minLength: 1 maxLength: 100	AZ API-verziókészlet neve
properties.versionHeaderName	string minLength: 1 maxLength: 100	Az API-verziót jelző HTTP-fejlécparaméter neve, ha a versioningScheme értéke header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Az API-verziót jelző lekérdezési paraméter neve, ha a versioningScheme értéke query.
properties.versioningScheme	versioningScheme	Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

versioningScheme

Enumerálás

Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.

Érték	Description
Header	Az API-verzió egy HTTP-fejlécben lesz átadva.
Query	Az API-verzió egy lekérdezési paraméterben lesz átadva.
Segment	Az API-verzió egy elérésiút-szegmensben lesz átadva.