access_policies

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

Overview

Name	access_policies
Type	Resource
Id	azure_isv.redis.access_policies

Fields

The following fields are returned by SELECT queries:

get

Response of get access policy.

Name	Datatype	Description
properties	object	Properties of an access policy.

list

Response of list access policies.

Name	Datatype	Description
properties	object	Properties of an access policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, cacheName, accessPolicyName, subscriptionId		Gets the detailed information about an access policy of a redis cache
list	select	resourceGroupName, cacheName, subscriptionId		Gets the list of access policies associated with this redis cache
create_update	insert	resourceGroupName, cacheName, accessPolicyName, subscriptionId		Adds an access policy to the redis cache
delete	delete	resourceGroupName, cacheName, accessPolicyName, subscriptionId		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
accessPolicyName	string	The name of the access policy that is being added to the Redis cache.
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 detailed information about an access policy of a redis cache

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

list

Gets the list of access policies associated with this redis cache

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

INSERT examples

create_update

Adds an access policy to the redis cache

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

Manifest

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

DELETE examples

delete

Deletes the access policy from a redis cache

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