Databases - Regenerate Key

Service:

Redis Cache

API-versie:

2024-10-01

Hiermee worden de toegangssleutels van de RedisEnterprise-database opnieuw gegenereerd.

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

URI-parameters

Name	In	Vereist	Type	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	De naam van het Redis Enterprise-cluster. De naam moet 1 tot 60 tekens lang zijn. Toegestane tekens (A-Z, a-z, 0-9) en afbreekstreepje(-). Er kunnen geen voorloop- of volgstreepjes of opeenvolgende afbreekstreepjes zijn
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	De naam van de Redis Enterprise-database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
keyType	True	AccessKeyType	Welke toegangssleutel opnieuw moet worden gegenereerd.

Antwoorden

Name	Type	Description
200 OK	AccessKeys	Retourneert de nieuwe toegangssleutels voor de database
202 Accepted		De updatebewerking van het cluster is gestart. HAAL de URL op in de Azure-AsyncOperation- of Locatieheaders om de bijgewerkte status op te halen. Kopteksten Location: string Azure-AsyncOperation: 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

RedisEnterpriseDatabasesRegenerateKey

Voorbeeldaanvraag

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

Voorbeeldrespons

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...

Definities

Name	Description
AccessKeys	Toegangssleutels
AccessKeyType	Welke toegangssleutel opnieuw moet worden gegenereerd.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
RegenerateKeyParameters	Aanvraag voor toegangssleutels opnieuw genereren

AccessKeys

Object

Toegangssleutels

Name	Type	Description
primaryKey	string	De huidige primaire sleutel die clients kunnen gebruiken om te verifiëren
secondaryKey	string	De huidige secundaire sleutel die clients kunnen gebruiken om te verifiëren

AccessKeyType

Inventarisatie

Welke toegangssleutel opnieuw moet worden gegenereerd.

Waarde	Description
Primary
Secondary

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

RegenerateKeyParameters

Object

Aanvraag voor toegangssleutels opnieuw genereren

Name	Type	Description
keyType	AccessKeyType	Welke toegangssleutel opnieuw moet worden gegenereerd.