Dela via


Gateway - List Keys

Hämtar gatewaynycklar.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01

URI-parametrar

Name I Obligatorisk Typ Description
gatewayId
path True

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterad"

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

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

GatewayKeysContract

Svarstexten innehåller de angivna gatewaynycklarna.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

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

ApiManagementGatewayListKeys

Exempelbegäran

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01

Exempelsvar

{
  "primary": "primary_key_value",
  "secondary": "secondary_key_value"
}

Definitioner

Name Description
ErrorFieldContract

Fel fältkontrakt.

ErrorResponse

Felsvar.

GatewayKeysContract

Autentiseringsnycklar för gateway.

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

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.

error.message

string

Mänsklig läsbar representation av felet.

GatewayKeysContract

Autentiseringsnycklar för gateway.

Name Typ Description
primary

string

Primär gatewaynyckel.

secondary

string

Sekundär gatewaynyckel.