Partager via


Gateway - List Keys

Récupère les clés de passerelle.

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

Paramètres URI

Nom Dans Obligatoire Type Description
gatewayId
path True

string

Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'

resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API à utiliser avec la demande du client.

Réponses

Nom Type Description
200 OK

GatewayKeysContract

Le corps de la réponse contient les clés de passerelle spécifiées.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGatewayListKeys

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GatewayKeysContract

Clés d’authentification de passerelle.

ErrorFieldContract

Contrat de champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

Représentation lisible par l’homme de l’erreur au niveau des propriétés.

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation contrôlable de visu de l’erreur.

GatewayKeysContract

Clés d’authentification de passerelle.

Nom Type Description
primary

string

Clé de passerelle primaire.

secondary

string

Clé de passerelle secondaire.