Gateway - List Keys
Pobiera klucze bramy.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2024-05-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
gateway
|
path | True |
string minLength: 1maxLength: 80 |
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej" |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Nazwa usługi API Management. |
subscription
|
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. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Treść odpowiedzi zawiera określone klucze bramy. Nagłówki ETag: string |
|
Other Status Codes |
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
ApiManagementGatewayListKeys
Przykładowe żądanie
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2024-05-01
Przykładowa odpowiedź
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
Definicje
Nazwa | Opis |
---|---|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Gateway |
Klucze uwierzytelniania bramy. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
GatewayKeysContract
Klucze uwierzytelniania bramy.
Nazwa | Typ | Opis |
---|---|---|
primary |
string |
Klucz bramy podstawowej. |
secondary |
string |
Pomocniczy klucz bramy. |