Redis - List Keys

Service:
Redis Cache
API Version:
2016-04-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=2016-04-01

URI Parameters

Name In Required Type Description
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.
resourceGroupName
 path True
  • string

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

The name of the Redis cache.
api-version
 query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Lists the keys for the specified Redis cache.

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=2016-04-01

Sample Response

Status code:
200 
{
  "primaryKey": "secretkey1",
  "secondaryKey": "secretKey2"
}

Definitions

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.