Databases - Regenerate Key

Служба:

Redis Cache

Версия API:

2024-10-01

Повторно создает ключи доступа к базе данных RedisEnterprise.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
clusterName	path	True	string	Имя кластера Redis Enterprise. Имя должно иметь длину 1–60 символов. Допустимые символы (A-Z, a-z, 0-9) и дефис(-). Не может быть ни ведущих, ни конечных, ни последовательных дефисов Шаблон регулярного выражения: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	Имя базы данных Redis Enterprise. Шаблон регулярного выражения: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
keyType	True	AccessKeyType	Какой ключ доступа для повторного создания.

Ответы

Имя	Тип	Описание
200 OK	AccessKeys	Возвращает новые ключи доступа для базы данных
202 Accepted		Была запущена операция обновления кластера. ПОЛУЧЕНИЕ URL-адреса в заголовках Azure-AsyncOperation или расположения для получения обновленного состояния. Заголовки Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

RedisEnterpriseDatabasesRegenerateKey

Образец запроса

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

Пример ответа

Код состояния:

200

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

Код состояния:

202

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

Определения

Имя	Описание
AccessKeys	Ключи доступа
AccessKeyType	Какой ключ доступа для повторного создания.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
RegenerateKeyParameters	Повторное создание запроса ключей доступа

AccessKeys

Ключи доступа

Имя	Тип	Описание
primaryKey	string	Текущий первичный ключ, который клиенты могут использовать для проверки подлинности
secondaryKey	string	Текущий вторичный ключ, который клиенты могут использовать для проверки подлинности

AccessKeyType

Какой ключ доступа для повторного создания.

Имя	Тип	Описание
Primary	string
Secondary	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

RegenerateKeyParameters

Повторное создание запроса ключей доступа

Имя	Тип	Описание
keyType	AccessKeyType	Какой ключ доступа для повторного создания.