Gateway - List Keys
Lekéri az átjárókulcsokat.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Regex pattern: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A válasz törzse tartalmazza a megadott átjárókulcsokat. Headers ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ApiManagementGatewayListKeys
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01
Sample Response
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
Definíciók
Name | Description |
---|---|
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Gateway |
Átjáró-hitelesítési kulcsok. |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
GatewayKeysContract
Átjáró-hitelesítési kulcsok.
Name | Típus | Description |
---|---|---|
primary |
string |
Elsődleges átjárókulcs. |
secondary |
string |
Másodlagos átjárókulcs. |