Share via

az redisenterprise database access-policy-assignment

  • Preview

Note

This reference is part of the redisenterprise extension for the Azure CLI (version 2.70.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 --name
                                                            --cluster-name
                                                            --database-name
                                                            --resource-group
                                                            [--access-policy-name]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--object-id]

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.

--resource-group -g

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

Optional Parameters

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

--access-policy-name

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

Property Value
Parameter group: Properties Arguments
Default value: default
--no-wait

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

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

The object ID of the user.

Property Value
Parameter group: User 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.

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

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

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

The name of the Redis Enterprise database access policy assignment.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the Redis Enterprise cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the Redis Enterprise database.

Property Value
Parameter group: Resource Id Arguments
--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
--no-wait

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

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

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
--yes -y

Do not prompt for confirmation.

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

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

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination 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.

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

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

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

The name of the Redis Enterprise database access policy assignment.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the Redis Enterprise cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the Redis Enterprise database.

Property Value
Parameter group: Resource Id Arguments
--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
--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 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 --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

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

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

The name of the Redis Enterprise database access policy assignment.

Property Value
Parameter group: Resource Id Arguments
--access-policy-name

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

Property Value
Parameter group: Properties Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--cluster-name

The name of the Redis Enterprise cluster.

Property Value
Parameter group: Resource Id Arguments
--database-name

The name of the Redis Enterprise database.

Property Value
Parameter group: Resource Id Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

The object ID of the user.

Property Value
Parameter group: User Arguments
--remove

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

Property Value
Parameter group: Generic Update 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
--set

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

Property Value
Parameter group: Generic Update 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 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 --name]
                                                          [--cluster-name]
                                                          [--created]
                                                          [--custom]
                                                          [--database-name]
                                                          [--deleted]
                                                          [--exists]
                                                          [--ids]
                                                          [--interval]
                                                          [--resource-group]
                                                          [--subscription]
                                                          [--timeout]
                                                          [--updated]

Optional Parameters

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

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

The name of the Redis Enterprise database access policy assignment.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the Redis Enterprise cluster.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--database-name

The name of the Redis Enterprise database.

Property Value
Parameter group: Resource Id Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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