access_policy_assignments

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

Overview

Name	access_policy_assignments
Type	Resource
Id	azure_isv.redis.access_policy_assignments

Fields

The following fields are returned by SELECT queries:

get

Response of get access policy assignments.

Name	Datatype	Description
properties	object	Properties of an access policy assignment

list

Response of list access policy assignments.

Name	Datatype	Description
properties	object	Properties of an access policy assignment

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, cacheName, accessPolicyAssignmentName, subscriptionId		Gets the list of assignments for an access policy of a redis cache
list	select	resourceGroupName, cacheName, subscriptionId		Gets the list of access policy assignments associated with this redis cache
create_update	insert	resourceGroupName, cacheName, accessPolicyAssignmentName, subscriptionId		Adds the access policy assignment to the specified users
delete	delete	resourceGroupName, cacheName, accessPolicyAssignmentName, subscriptionId		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
accessPolicyAssignmentName	string	The name of the access policy assignment.
cacheName	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

get

Gets the list of assignments for an access policy of a redis cache

SELECT
properties
FROM azure_isv.redis.access_policy_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND cacheName = '{{ cacheName }}' -- required
AND accessPolicyAssignmentName = '{{ accessPolicyAssignmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

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

SELECT
properties
FROM azure_isv.redis.access_policy_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND cacheName = '{{ cacheName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_update

Adds the access policy assignment to the specified users

INSERT INTO azure_isv.redis.access_policy_assignments (
data__properties,
resourceGroupName,
cacheName,
accessPolicyAssignmentName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ cacheName }}',
'{{ accessPolicyAssignmentName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: access_policy_assignments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the access_policy_assignments resource.
    - name: cacheName
      value: string
      description: Required parameter for the access_policy_assignments resource.
    - name: accessPolicyAssignmentName
      value: string
      description: Required parameter for the access_policy_assignments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the access_policy_assignments resource.
    - name: properties
      value: object
      description: |
        Properties of an access policy assignment

DELETE examples

delete

Deletes the access policy assignment from a redis cache

DELETE FROM azure_isv.redis.access_policy_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND cacheName = '{{ cacheName }}' --required
AND accessPolicyAssignmentName = '{{ accessPolicyAssignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;