Share via

az redisenterprise database

  • 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 command. Learn more about extensions.

Manage Redis Enterprise databases.

Commands

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

Manage database access policy assignment for redis enterprise databases.

 Extension Preview
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 create

Create a database.

 Extension GA
az redisenterprise database delete

Delete a single database.

 Extension GA
az redisenterprise database export

Exports a database file from target database.

 Extension GA
az redisenterprise database flush

Flushes all the keys in this database and also from its linked databases.

 Extension GA
az redisenterprise database force-unlink

Forcibly removes the link to the specified database resource.

 Extension GA
az redisenterprise database import

Imports database files to target database.

 Extension GA
az redisenterprise database list

List all databases in the specified RedisEnterprise cluster.

 Extension GA
az redisenterprise database list-keys

Retrieves the access keys for the RedisEnterprise database.

 Extension GA
az redisenterprise database regenerate-key

Regenerates the RedisEnterprise database's access keys.

 Extension GA
az redisenterprise database show

Get information about a database in a RedisEnterprise cluster.

 Extension GA
az redisenterprise database update

Update a database.

 Extension GA
az redisenterprise database wait

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

 Extension GA

az redisenterprise database create

Create a database.

az redisenterprise database create --cluster-name
                                   --resource-group
                                   [--access-keys-auth {Disabled, Enabled}]
                                   [--client-protocol {Encrypted, Plaintext}]
                                   [--clustering-policy {EnterpriseCluster, OSSCluster}]
                                   [--defer-upgrade {Deferred, NotDeferred}]
                                   [--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
                                   [--group-nickname]
                                   [--linked-database]
                                   [--mods]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--persistence]
                                   [--port]

Required Parameters

--cluster-name

The name of the RedisEnterprise cluster.

--resource-group -g

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

Optional Parameters

--access-keys-auth --access-keys-authentication
Preview

Access database using keys - default is enabled. This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.

Accepted values: Disabled, Enabled
--client-protocol

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

Accepted values: Encrypted, Plaintext
--clustering-policy

Clustering policy - default is OSSCluster. Specified at create time.

Accepted values: EnterpriseCluster, OSSCluster
--defer-upgrade

Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade.

Accepted values: Deferred, NotDeferred
--eviction-policy

Redis eviction policy - default is VolatileLRU.

Accepted values: AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL
--group-nickname

Name for the group of linked database resources.

--linked-database --linked-databases --linkeddatabase

List of database resources to link with this database Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --linked-database --linked-databases.

--mods --module --modules

Optional set of redis modules to enable in this database - modules can only be added at creation time. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --module --modules.

--no-wait

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

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

Persistence settings Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--port

TCP port of the database endpoint. Specified at create time. Defaults to an available port.

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 delete

Delete a single database.

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

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

Exports a database file from target database.

az redisenterprise database export --sas-uri
                                   [--cluster-name]
                                   [--ids]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]

Required Parameters

--sas-uri

SAS URI for the target directory to export to.

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

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 flush

Flushes all the keys in this database and also from its linked databases.

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

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

--linked-ids

The resource identifiers of all the other database resources in the georeplication group to be flushed Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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.

Forcibly removes the link to the specified database resource.

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

The resource IDs of the database resources to be unlinked. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cluster-name

The name of the RedisEnterprise cluster.

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

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 import

Imports database files to target database.

az redisenterprise database import --sas-uris
                                   [--cluster-name]
                                   [--ids]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]

Required Parameters

--sas-uris

SAS URIs for the target blobs to import from Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

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 list

List all databases in the specified RedisEnterprise cluster.

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

Required Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

Retrieves the access keys for the RedisEnterprise database.

az redisenterprise database list-keys [--cluster-name]
                                      [--ids]
                                      [--resource-group]
                                      [--subscription]

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

Regenerates the RedisEnterprise database's access keys.

az redisenterprise database regenerate-key --key-type {Primary, Secondary}
                                           [--cluster-name]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]

Required Parameters

--key-type

Which access key to regenerate.

Accepted values: Primary, Secondary

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

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 show

Get information about a database in a RedisEnterprise cluster.

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

Optional Parameters

--cluster-name

The name of the RedisEnterprise cluster.

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

Update a database.

az redisenterprise database update [--access-keys-auth {Disabled, Enabled}]
                                   [--add]
                                   [--client-protocol {Encrypted, Plaintext}]
                                   [--cluster-name]
                                   [--defer-upgrade {Deferred, NotDeferred}]
                                   [--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
                                   [--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}]
                                   [--persistence]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]

Optional Parameters

--access-keys-auth --access-keys-authentication
Preview

Access database using keys - default is enabled. This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.

Accepted values: Disabled, Enabled
--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>.

--client-protocol

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

Accepted values: Encrypted, Plaintext
--cluster-name

The name of the RedisEnterprise cluster.

--defer-upgrade

Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade.

Accepted values: Deferred, NotDeferred
--eviction-policy

Redis eviction policy - default is VolatileLRU.

Accepted values: AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL
--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
--persistence

Persistence settings Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

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

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

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

Optional Parameters

--cluster-name --name -n

The name of the RedisEnterprise 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'].

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