Redis - Regenerate Key
Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/regenerateKey?api-version=2023-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
The name of the Redis cache. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
keyType | True |
The Redis access key to regenerate. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Lists the regenerated keys for Redis Cache |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
RedisCacheRegenerateKey
Sample Request
Sample Response
{
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>"
}
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Redis |
Redis cache access keys. |
Redis |
The Redis access key to regenerate. |
Redis |
Specifies which Redis access keys to reset. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
RedisAccessKeys
Redis cache access keys.
Name | Type | Description |
---|---|---|
primaryKey |
string |
The current primary key that clients can use to authenticate with Redis cache. |
secondaryKey |
string |
The current secondary key that clients can use to authenticate with Redis cache. |
RedisKeyType
The Redis access key to regenerate.
Name | Type | Description |
---|---|---|
Primary |
string |
|
Secondary |
string |
RedisRegenerateKeyParameters
Specifies which Redis access keys to reset.
Name | Type | Description |
---|---|---|
keyType |
The Redis access key to regenerate. |