keys
Creates, updates, deletes, gets or lists a keys resource.
Overview
| Name | keys |
| Type | Resource |
| Id | azure_isv.redis.keys |
Fields
The following fields are returned by SELECT queries:
- list
Lists the keys for the specified Redis cache.
| Name | Datatype | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | resourceGroupName, name, subscriptionId | Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the Redis cache. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
SELECT examples
- list
Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.
SELECT
primaryKey,
secondaryKey
FROM azure_isv.redis.keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;