Api Version Set - Get
Hämtar information om api-versionsuppsättningen som anges av dess identifierare.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Reguljärt uttrycksmönster: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
version
|
path | True |
string |
Api-versionsuppsättningsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Reguljärt uttrycksmönster: |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Hämtar den angivna api-versionsuppsättningsentiteten. Sidhuvuden ETag: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementGetApiVersionSet
Exempelbegäran
Exempelsvar
{
"id": "/subscriptions/subid/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"
}
}
Definitioner
Name | Description |
---|---|
Api |
Kontraktsinformation för API-versionsuppsättning. |
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
versioning |
Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. |
ApiVersionSetContract
Kontraktsinformation för API-versionsuppsättning.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.description |
string |
Beskrivning av API-versionsuppsättning. |
properties.displayName |
string |
Namn på API-versionsuppsättning |
properties.versionHeaderName |
string |
Namnet på HTTP-huvudparametern som anger API-versionen om versioningScheme har angetts till |
properties.versionQueryName |
string |
Namnet på frågeparametern som anger API-versionen om versioningScheme är inställt på |
properties.versioningScheme |
Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
versioningScheme
Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.
Name | Typ | Description |
---|---|---|
Header |
string |
API-versionen skickas i ett HTTP-huvud. |
Query |
string |
API-versionen skickas i en frågeparameter. |
Segment |
string |
API-versionen skickas i ett sökvägssegment. |