Databases - Regenerate Key

Serviço:

Redis Cache

Versão da API:

2024-10-01

Regenera as chaves de acesso do banco de dados RedisEnterprise.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
clusterName	path	True	string	O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hífen(-). Não pode haver liderança, nem descida, nem hífenes consecutivas Padrão Regex: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	O nome do banco de dados Redis Enterprise. Padrão Regex: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
keyType	True	AccessKeyType	Qual chave de acesso para regenerar.

Respostas

Name	Tipo	Description
200 OK	AccessKeys	Retorna as novas chaves de acesso para o banco de dados
202 Accepted		A operação de atualização do cluster foi iniciada. OBTENHA o URL nos cabeçalhos Azure-AsyncOperation ou Localização para recuperar o status atualizado. Cabeçalhos Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

RedisEnterpriseDatabasesRegenerateKey

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

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

Código de estado:

202

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

Definições

Name	Description
AccessKeys	Teclas de acesso
AccessKeyType	Qual chave de acesso para regenerar.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
RegenerateKeyParameters	Regenerar o pedido de chaves de acesso

AccessKeys

Teclas de acesso

Name	Tipo	Description
primaryKey	string	A chave primária atual que os clientes podem usar para autenticar
secondaryKey	string	A chave secundária atual que os clientes podem usar para autenticar

AccessKeyType

Qual chave de acesso para regenerar.

Name	Tipo	Description
Primary	string
Secondary	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

RegenerateKeyParameters

Regenerar o pedido de chaves de acesso

Name	Tipo	Description
keyType	AccessKeyType	Qual chave de acesso para regenerar.