Databases - Regenerate Key

Service:

Redis Cache

Version d'API:

2024-10-01

Régénère les clés d’accès de la base de données RedisEnterprise.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey?api-version=2024-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string	Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs Modèle d’expression régulière: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	Nom de la base de données Redis Enterprise. Modèle d’expression régulière: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	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	AccessKeyType	Clé d’accès à régénérer.

Réponses

Nom	Type	Description
200 OK	AccessKeys	Retourne les nouvelles clés d’accès pour la base de données
202 Accepted		L’opération de mise à jour du cluster a été démarrée. OBTENez l’URL dans les en-têtes Azure-AsyncOperation ou Location pour récupérer l’état mis à jour. En-têtes Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

RedisEnterpriseDatabasesRegenerateKey

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/regenerateKey?api-version=2024-10-01

{
  "keyType": "Primary"
}

Exemple de réponse

Code d’état:

200

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Code d’état:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult...

Définitions

Nom	Description
AccessKeys	Clés d’accès
AccessKeyType	Clé d’accès à régénérer.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
RegenerateKeyParameters	Régénérer la demande de clés d’accès

AccessKeys

Clés d’accès

Nom	Type	Description
primaryKey	string	Clé primaire actuelle que les clients peuvent utiliser pour s’authentifier
secondaryKey	string	Clé secondaire actuelle que les clients peuvent utiliser pour s’authentifier

AccessKeyType

Clé d’accès à régénérer.

Nom	Type	Description
Primary	string
Secondary	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

RegenerateKeyParameters

Régénérer la demande de clés d’accès

Nom	Type	Description
keyType	AccessKeyType	Clé d’accès à régénérer.