access_policy_assignment

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

Overview

Name	access_policy_assignment
Type	Resource
Id	azure_isv.redisenterprise.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	Name of access policy under specific access policy assignment. Only "default" policy is supported for now. Required.
provisioningState	string	Current provisioning status of the access policy assignment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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".
user	object	The user associated with the access policy. Required.

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	Name of access policy under specific access policy assignment. Only "default" policy is supported for now. Required.
provisioningState	string	Current provisioning status of the access policy assignment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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".
user	object	The user associated with the access policy. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, database_name, access_policy_assignment_name, subscription_id		Gets information about access policy assignment for database.
list	select	resource_group_name, cluster_name, database_name, subscription_id		Gets all access policy assignments..
create_update	insert	resource_group_name, cluster_name, database_name, access_policy_assignment_name, subscription_id		Creates/Updates a particular access policy assignment for a database.
delete	delete	resource_group_name, cluster_name, database_name, access_policy_assignment_name, subscription_id		Deletes a single access policy assignment.

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 Redis Enterprise database access policy assignment. Required.
cluster_name	string	The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens. Required.
database_name	string	The name of the Redis Enterprise database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about access policy assignment for database.

SELECT
id,
name,
accessPolicyName,
provisioningState,
systemData,
type,
user
FROM azure_isv.redisenterprise.access_policy_assignment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND access_policy_assignment_name = '{{ access_policy_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all access policy assignments..

SELECT
id,
name,
accessPolicyName,
provisioningState,
systemData,
type,
user
FROM azure_isv.redisenterprise.access_policy_assignment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_update

Creates/Updates a particular access policy assignment for a database.

INSERT INTO azure_isv.redisenterprise.access_policy_assignment (
properties,
resource_group_name,
cluster_name,
database_name,
access_policy_assignment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ database_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: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the access_policy_assignment resource.
  - name: database_name
    value: "{{ database_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 the access policy assignment.
    value:
      provisioningState: "{{ provisioningState }}"
      accessPolicyName: "{{ accessPolicyName }}"
      user:
        objectId: "{{ objectId }}"

DELETE examples

delete

Deletes a single access policy assignment.

DELETE FROM azure_isv.redisenterprise.access_policy_assignment
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND database_name = '{{ database_name }}' --required
AND access_policy_assignment_name = '{{ access_policy_assignment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;