Redis - List Keys

Service:
Redis Cache
API Version:
2020-06-01

Retrieve a 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}/listKeys?api-version=2020-06-01

URI Parameters

Name In Required Type Description
name
 path True
  • string

The name of the Redis cache.
resourceGroupName
 path True
  • string

The name of the resource group.
subscriptionId
 path True
  • string

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Lists the keys for the specified 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

RedisCacheListKeys

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/listKeys?api-version=2020-06-01

Sample Response

Status code:
200 
{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definitions

ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
RedisAccessKeys

Redis cache access keys.

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.