access_policy_assignment

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

Overview

Name	access_policy_assignment
Type	Resource
Id	azure.redis.access_policy_assignment

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.
accessPolicyName	string	The name of the access policy that is being assigned. Required.
objectId	string	Object Id to assign access policy to. Required.
objectIdAlias	string	User friendly name for object id. Also represents username for token based authentication. Required.
provisioningState	string	Provisioning state of an access policy assignment set. 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.
accessPolicyName	string	The name of the access policy that is being assigned. Required.
objectId	string	Object Id to assign access policy to. Required.
objectIdAlias	string	User friendly name for object id. Also represents username for token based authentication. Required.
provisioningState	string	Provisioning state of an access policy assignment set. 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_assignment_name, subscription_id		Gets the list of assignments for an access policy of a redis cache.
list	select	resource_group_name, cache_name, subscription_id		Gets the list of access policy assignments associated with this redis cache.
create_update	insert	resource_group_name, cache_name, access_policy_assignment_name, subscription_id		Adds the access policy assignment to the specified users.
create_update	replace	resource_group_name, cache_name, access_policy_assignment_name, subscription_id		Adds the access policy assignment to the specified users.
delete	delete	resource_group_name, cache_name, access_policy_assignment_name, subscription_id		Deletes the access policy assignment 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_assignment_name	string	The name of the access policy assignment. 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 list of assignments for an access policy of a redis cache.

SELECT
id,
name,
accessPolicyName,
objectId,
objectIdAlias,
provisioningState,
systemData,
type
FROM azure.redis.access_policy_assignment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND access_policy_assignment_name = '{{ access_policy_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of access policy assignments associated with this redis cache.

SELECT
id,
name,
accessPolicyName,
objectId,
objectIdAlias,
provisioningState,
systemData,
type
FROM azure.redis.access_policy_assignment
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 the access policy assignment to the specified users.

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

Manifest

# Description fields are for documentation purposes
- name: access_policy_assignment
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_policy_assignment resource.
  - name: cache_name
    value: "{{ cache_name }}"
    description: Required parameter for the access_policy_assignment resource.
  - name: access_policy_assignment_name
    value: "{{ access_policy_assignment_name }}"
    description: Required parameter for the access_policy_assignment resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_policy_assignment resource.
  - name: properties
    description: |
      Properties of an access policy assignment.
    value:
      provisioningState: "{{ provisioningState }}"
      objectId: "{{ objectId }}"
      objectIdAlias: "{{ objectIdAlias }}"
      accessPolicyName: "{{ accessPolicyName }}"

REPLACE examples

create_update

Adds the access policy assignment to the specified users.

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

DELETE examples

delete

Deletes the access policy assignment from a redis cache.

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