az redis access-policy-assignment

Manage Access Policy Assignments (Redis Users) for Redis Cache.

Commands

Name	Description	Type	Status
az redis access-policy-assignment create	Add an Access Policy Assignment (Redis User) to the Redis Cache.	Core	GA
az redis access-policy-assignment delete	Delete the Access Policy Assignment (Redis User).	Core	GA
az redis access-policy-assignment list	Get the list of Access Policy Assignments (Redis Users) associated with the Redis Cache.	Core	GA
az redis access-policy-assignment show	Get the detailed information about an Access Policy Assignment (Redis User) of the Redis Cache.	Core	GA
az redis access-policy-assignment update	Update an Access Policy Assignment (Redis User) of the Redis Cache.	Core	GA

az redis access-policy-assignment create

Add an Access Policy Assignment (Redis User) to the Redis Cache.

az redis access-policy-assignment create --access-policy-name
                                         --name
                                         --object-id
                                         --object-id-alias
                                         --policy-assignment-name
                                         --resource-group

Examples

Configure Redis User for role based access control

az redis access-policy-assignment create -g testResourceGroup -n testCacheName --object-id 932b5c60-66e4-4fbf-b8b0-xxxxxxxxxxxx --object-id-alias testAlias --access-policy-name testAccessPolicy --policy-assignment-name testAccessPolicyAssignment

Required Parameters

--access-policy-name

The name of the access policy that is being assigned.

--name -n

Name of the Redis cache.

--object-id

Object Id to assign access policy to.

--object-id-alias

User friendly name for object id. Also represents username for token based authentication.

--policy-assignment-name

The name of the access policy assignment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis access-policy-assignment delete

Delete the Access Policy Assignment (Redis User).

az redis access-policy-assignment delete --policy-assignment-name
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

Examples

Delete the Redis User

az redis access-policy-assignment delete -g testResourceGroup -n testCacheName --policy-assignment-name testAccessPolicyAssignment

Required Parameters

--policy-assignment-name

The name of the access policy assignment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Redis cache.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis access-policy-assignment list

Get the list of Access Policy Assignments (Redis Users) associated with the Redis Cache.

az redis access-policy-assignment list --name
                                       --resource-group

Examples

List the Redis Users of the Redis Cache

az redis access-policy-assignment list -g testResourceGroup -n testCacheName

Required Parameters

--name -n

Name of the Redis cache.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis access-policy-assignment show

Get the detailed information about an Access Policy Assignment (Redis User) of the Redis Cache.

az redis access-policy-assignment show --policy-assignment-name
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get the Object Id, Object Id Alias and Access Policy assigned to the Redis User

az redis access-policy-assignment show -g testResourceGroup -n testCacheName --policy-assignment-name testAccessPolicyAssignment

Required Parameters

--policy-assignment-name

The name of the access policy assignment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Redis cache.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az redis access-policy-assignment update

Update an Access Policy Assignment (Redis User) of the Redis Cache.

az redis access-policy-assignment update --access-policy-name
                                         --object-id
                                         --object-id-alias
                                         --policy-assignment-name
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

Examples

Update Redis User for role based access control

az redis access-policy-assignment update -g testResourceGroup -n testCacheName --object-id 932b5c60-66e4-4fbf-b8b0-xxxxxxxxxxxx --object-id-alias testAlias --access-policy-name testAccessPolicy --policy-assignment-name testAccessPolicyAssignment

Required Parameters

--access-policy-name

The name of the access policy that is being assigned.

--object-id

Object Id to assign access policy to.

--object-id-alias

User friendly name for object id. Also represents username for token based authentication.

--policy-assignment-name

The name of the access policy assignment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the Redis cache.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False