Delen via


Gateway - List Keys

Hiermee worden gatewaysleutels opgehaald.

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

URI-parameters

Name In Vereist Type Description
gatewayId
path True

string

minLength: 1
maxLength: 80

Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben

resourceGroupName
path True

string

De naam van de resourcegroep.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

De naam van de API Management-service.

subscriptionId
path True

string

Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name Type Description
200 OK

GatewayKeysContract

De hoofdtekst van het antwoord bevat de opgegeven gatewaysleutels.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGatewayListKeys

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutreactie.

GatewayKeysContract

Gatewayverificatiesleutels.

ErrorFieldContract

Foutveldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Leesbare weergave van fout op eigenschapsniveau.

target

string

Eigenschapsnaam.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.

error.message

string

Leesbare weergave van de fout.

GatewayKeysContract

Gatewayverificatiesleutels.

Name Type Description
primary

string

Primaire gatewaysleutel.

secondary

string

Secundaire gatewaysleutel.