Gateway - List Keys
Načte klíče brány.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identifikátor entity brány. Musí být v aktuální instanci služby API Management jedinečná. Nesmí mít hodnotu "managed". |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Regex pattern: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Tělo odpovědi obsahuje zadané klíče brány. Headers ETag: string |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
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"
}
Definice
Name | Description |
---|---|
Error |
Chyba Kontrakt pole. |
Error |
Odpověď na chybu. |
Gateway |
Ověřovací klíče brány. |
ErrorFieldContract
Chyba Kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Čitelné znázornění chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v žádosti v případě chyby ověření. |
|
error.message |
string |
Znázornění chyby čitelné pro člověka |
GatewayKeysContract
Ověřovací klíče brány.
Name | Typ | Description |
---|---|---|
primary |
string |
Primární klíč brány. |
secondary |
string |
Sekundární klíč brány. |