Databases - Regenerate Key

Dienst:

Redis Cache

API-Version:

2024-10-01

Generiert die Zugriffstasten der RedisEnterprise-Datenbank neu.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Redis Enterprise-Clusters. Der Name muss 1 bis 60 Zeichen lang sein. Zulässige Zeichen (A-Z, a-z, 0-9) und Bindestrich(-). Es kann weder führende noch nachfolgende Bindestriche oder aufeinander folgende Bindestriche geben. RegEx-Muster: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	Der Name der Redis Enterprise-Datenbank. RegEx-Muster: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
keyType	True	AccessKeyType	Welche Zugriffstaste neu generiert werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AccessKeys	Gibt die neuen Zugriffstasten für die Datenbank zurück.
202 Accepted		Der Clusteraktualisierungsvorgang wurde gestartet. Rufen Sie die URL in den Headern Azure-AsyncOperation oder Speicherort ab, um den aktualisierten Status abzurufen. Header Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RedisEnterpriseDatabasesRegenerateKey

Beispielanforderung

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"
}

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

202

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

Definitionen

Name	Beschreibung
AccessKeys	Zugriffstasten
AccessKeyType	Welche Zugriffstaste neu generiert werden soll.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
RegenerateKeyParameters	Neu generieren der Zugriffstastenanforderung

AccessKeys

Zugriffstasten

Name	Typ	Beschreibung
primaryKey	string	Der aktuelle Primärschlüssel, den Clients zum Authentifizieren verwenden können
secondaryKey	string	Der aktuelle sekundäre Schlüssel, den Clients zum Authentifizieren verwenden können

AccessKeyType

Welche Zugriffstaste neu generiert werden soll.

Name	Typ	Beschreibung
Primary	string
Secondary	string

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

RegenerateKeyParameters

Neu generieren der Zugriffstastenanforderung

Name	Typ	Beschreibung
keyType	AccessKeyType	Welche Zugriffstaste neu generiert werden soll.