access_policy

Creates, updates, deletes, gets or lists an access_policy resource.

Overview

Name	access_policy
Type	Resource
Id	azure.redis.access_policy

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
permissions	string	Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites _. Required.
provisioningState	string	Provisioning state of access policy. Known values are: "Updating", "Succeeded", "Deleting", "Deleted", "Canceled", and "Failed". (Updating, Succeeded, Deleting, Deleted, Canceled, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
permissions	string	Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites _. Required.
provisioningState	string	Provisioning state of access policy. Known values are: "Updating", "Succeeded", "Deleting", "Deleted", "Canceled", and "Failed". (Updating, Succeeded, Deleting, Deleted, Canceled, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cache_name, access_policy_name, subscription_id		Gets the detailed information about an access policy of a redis cache.
list	select	resource_group_name, cache_name, subscription_id		Gets the list of access policies associated with this redis cache.
create_update	insert	resource_group_name, cache_name, access_policy_name, subscription_id		Adds an access policy to the redis cache.
create_update	replace	resource_group_name, cache_name, access_policy_name, subscription_id		Adds an access policy to the redis cache.
delete	delete	resource_group_name, cache_name, access_policy_name, subscription_id		Deletes the access policy from a redis cache.

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
access_policy_name	string	The name of the access policy that is being added to the Redis cache. Required.
cache_name	string	The name of the Redis cache. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the detailed information about an access policy of a redis cache.

SELECT
id,
name,
permissions,
provisioningState,
systemData,
type
FROM azure.redis.access_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND access_policy_name = '{{ access_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of access policies associated with this redis cache.

SELECT
id,
name,
permissions,
provisioningState,
systemData,
type
FROM azure.redis.access_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_update

Adds an access policy to the redis cache.

INSERT INTO azure.redis.access_policy (
properties,
resource_group_name,
cache_name,
access_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cache_name }}',
'{{ access_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_policy
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_policy resource.
  - name: cache_name
    value: "{{ cache_name }}"
    description: Required parameter for the access_policy resource.
  - name: access_policy_name
    value: "{{ access_policy_name }}"
    description: Required parameter for the access_policy resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_policy resource.
  - name: properties
    description: |
      Properties of an access policy.
    value:
      provisioningState: "{{ provisioningState }}"
      type: "{{ type }}"
      permissions: "{{ permissions }}"

REPLACE examples

create_update

Adds an access policy to the redis cache.

REPLACE azure.redis.access_policy
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND access_policy_name = '{{ access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the access policy from a redis cache.

DELETE FROM azure.redis.access_policy
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND access_policy_name = '{{ access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;