Gateway - Regenerate Key
Régénère la clé de passerelle spécifiée invalidant tous les jetons créés avec elle.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2022-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
gateway
|
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' |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
service
|
path | True |
string |
Nom du service Gestion des API. Regex pattern: |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
keyType | True |
Clé régénérée. |
Réponses
Nom | Type | Description |
---|---|---|
204 No Content |
Clé correctement régénérée |
|
Other Status Codes |
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
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
ApiManagementGatewayRegenerateKey
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gwId/regenerateKey?api-version=2022-08-01
{
"keyType": "primary"
}
Sample Response
Définitions
Nom | Description |
---|---|
Error |
Contrat champ d’erreur. |
Error |
Réponse d’erreur. |
Gateway |
Propriétés du contrat de demande de régénération de clé de passerelle. |
Key |
Clé régénérée. |
ErrorFieldContract
Contrat 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 de la propriété. |
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 |
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. |
GatewayKeyRegenerationRequestContract
Propriétés du contrat de demande de régénération de clé de passerelle.
Nom | Type | Description |
---|---|---|
keyType |
Clé régénérée. |
KeyType
Clé régénérée.
Nom | Type | Description |
---|---|---|
primary |
string |
|
secondary |
string |