Share via

az redisenterprise database access-policy-assignment

  • Preview
  • Reference

Note

This reference is part of the redisenterprise extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az redisenterprise database access-policy-assignment command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage database access policy assignment for redis enterprise databases.

Commands

Name Description Type Status
az redisenterprise database access-policy-assignment create

Create access policy assignment for database.

 Extension Preview
az redisenterprise database access-policy-assignment delete

Delete a single access policy assignment.

 Extension Preview
az redisenterprise database access-policy-assignment list

List all databases in the specified Redis Enterprise cluster.

 Extension Preview
az redisenterprise database access-policy-assignment show

Get information about access policy assignment for database.

 Extension Preview
az redisenterprise database access-policy-assignment update

Update access policy assignment for database.

 Extension Preview
az redisenterprise database access-policy-assignment wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az redisenterprise database access-policy-assignment create

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create access policy assignment for database.

az redisenterprise database access-policy-assignment create --access-policy-assignment-name
                                                            --cluster-name
                                                            --database-name
                                                            --object-id
                                                            --resource-group
                                                            [--access-policy-name]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Configure Redis User for role based access control

az redisenterprise database access-policy-assignment create --resource-group rg1 --cluster-name cache1 --database-name default --access-policy-assignment-name defaultTestEntraApp1 --access-policy-name default --object-id 6497c918-11ad-41e7-1b0f-7c518a87d0b0

Required Parameters

--access-policy-assignment-name --name -n

The name of the Redis Enterprise database access policy assignment.

--cluster-name

The name of the Redis Enterprise cluster.

--database-name

The name of the Redis Enterprise database.

--object-id

The object ID of the user.

--resource-group -g

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

Optional Parameters

--access-policy-name

Name of access policy under specific access policy assignment. Only "default" policy is supported for now.

Default value: default
--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az redisenterprise database access-policy-assignment delete

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a single access policy assignment.

az redisenterprise database access-policy-assignment delete [--access-policy-assignment-name]
                                                            [--cluster-name]
                                                            [--database-name]
                                                            [--ids]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--resource-group]
                                                            [--subscription]
                                                            [--yes]

Examples

Delete the Redis User

az redisenterprise database access-policy-assignment delete --resource-group rg1 --cluster-name cache1 --database-name default --access-policy-assignment-name defaultTestEntraApp1

Optional Parameters

--access-policy-assignment-name --name -n

The name of the Redis Enterprise database access policy assignment.

--cluster-name

The name of the Redis Enterprise cluster.

--database-name

The name of the Redis Enterprise database.

--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.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az redisenterprise database access-policy-assignment list

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all databases in the specified Redis Enterprise cluster.

az redisenterprise database access-policy-assignment list --cluster-name
                                                          --database-name
                                                          --resource-group
                                                          [--max-items]
                                                          [--next-token]

Examples

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

az redisenterprise database access-policy-assignment list --resource-group rg1 --cluster-name cache1 --database-name default

Required Parameters

--cluster-name

The name of the Redis Enterprise cluster.

--database-name

The name of the Redis Enterprise database.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az redisenterprise database access-policy-assignment show

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get information about access policy assignment for database.

az redisenterprise database access-policy-assignment show [--access-policy-assignment-name]
                                                          [--cluster-name]
                                                          [--database-name]
                                                          [--ids]
                                                          [--resource-group]
                                                          [--subscription]

Examples

Get the Access Policy assignment information

az redisenterprise database access-policy-assignment show --resource-group rg1 --cluster-name cache1 --database-name default --access-policy-assignment-name accessPolicyAssignmentName1

Optional Parameters

--access-policy-assignment-name --name -n

The name of the Redis Enterprise database access policy assignment.

--cluster-name

The name of the Redis Enterprise cluster.

--database-name

The name of the Redis Enterprise database.

--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.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az redisenterprise database access-policy-assignment update

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update access policy assignment for database.

az redisenterprise database access-policy-assignment update [--access-policy-assignment-name]
                                                            [--access-policy-name]
                                                            [--add]
                                                            [--cluster-name]
                                                            [--database-name]
                                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--ids]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--object-id]
                                                            [--remove]
                                                            [--resource-group]
                                                            [--set]
                                                            [--subscription]

Optional Parameters

--access-policy-assignment-name --name -n

The name of the Redis Enterprise database access policy assignment.

--access-policy-name

Name of access policy under specific access policy assignment. Only "default" policy is supported for now.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--cluster-name

The name of the Redis Enterprise cluster.

--database-name

The name of the Redis Enterprise database.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--object-id

The object ID of the user.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az redisenterprise database access-policy-assignment wait

Preview

Command group 'az redisenterprise database access-policy-assignment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az redisenterprise database access-policy-assignment wait [--access-policy-assignment-name]
                                                          [--cluster-name]
                                                          [--created]
                                                          [--custom]
                                                          [--database-name]
                                                          [--deleted]
                                                          [--exists]
                                                          [--ids]
                                                          [--interval]
                                                          [--resource-group]
                                                          [--subscription]
                                                          [--timeout]
                                                          [--updated]

Optional Parameters

--access-policy-assignment-name --name -n

The name of the Redis Enterprise database access policy assignment.

--cluster-name

The name of the Redis Enterprise cluster.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--database-name

The name of the Redis Enterprise database.

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.