Api Version Set - Get

Servizio:

API Management

Versione API:

2024-05-01

Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore del set di versioni api. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiVersionSetContract	Ottiene l'entità set di versioni api specificata. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementGetApiVersionSet

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
  }
}

Definizioni

Nome	Descrizione
ApiVersionSetContract	Dettagli del contratto del set di versioni API.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
versioningScheme	Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.

ApiVersionSetContract

Object

Dettagli del contratto del set di versioni API.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.description	string	Descrizione del set di versioni dell'API.
properties.displayName	string minLength: 1 maxLength: 100	Nome del set di versioni dell'API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query.
properties.versioningScheme	versioningScheme	Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

versioningScheme

Enumerazione

Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.

Valore	Descrizione
Header	La versione dell'API viene passata in un'intestazione HTTP.
Query	La versione dell'API viene passata in un parametro di query.
Segment	La versione DELL'API viene passata in un segmento di percorso.