az redisenterprise

  • Reference

Note

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

Manage the redisenterprise cache.

Commands

Name Description Type Status
az redisenterprise create

Create an existing (overwrite/recreate, with potential downtime) cache cluster.

 Extension GA
az redisenterprise database

Manage Redis Enterprise databases.

 Extension GA
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 delete

Delete a RedisEnterprise cache cluster.

 Extension GA
az redisenterprise list

List all RedisEnterprise clusters in the specified subscription.

 Extension GA
az redisenterprise operation-status

Get the status of an operation.

 Extension GA
az redisenterprise operation-status show

Get the status of operation.

 Extension GA
az redisenterprise show

Get information about a RedisEnterprise cluster.

 Extension GA
az redisenterprise update

Update an existing (overwrite/recreate, with potential downtime) cache cluster.

 Extension GA
az redisenterprise wait

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

 Extension GA

az redisenterprise create

Create an existing (overwrite/recreate, with potential downtime) cache cluster.

az redisenterprise create --cluster-name
                          --resource-group
                          --sku {EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50}
                          [--assigned-identities]
                          [--capacity]
                          [--client-protocol {Encrypted, Plaintext}]
                          [--clustering-policy {EnterpriseCluster, OSSCluster}]
                          [--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
                          [--group-nickname]
                          [--identity-resource-id]
                          [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                          [--key-encryption-identity-type {systemAssignedIdentity, userAssignedIdentity}]
                          [--key-encryption-key-url]
                          [--linked-databases]
                          [--location]
                          [--minimum-tls-version {1.0, 1.1, 1.2}]
                          [--module]
                          [--no-database]
                          [--no-wait]
                          [--persistence]
                          [--port]
                          [--tags]
                          [--zones]

Examples

create cache

az redisenterprise create --cluster-name "cache1" --location "East US" --minimum-tls-version "1.2" --sku "Enterprise_E20" --capacity 4 --tags tag1="value1" --zones "1" "2" "3" --client-protocol "Encrypted" --clustering-policy "EnterpriseCluster" --eviction-policy "NoEviction" --modules name="RedisBloom" args="ERROR_RATE 0.02 INITIAL_SIZE 400" --persistence aof-enabled=true aof-frequency="1s" --port 10000 --resource-group "rg1"

Required Parameters

--cluster-name --name -n

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

--sku

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).

accepted values: EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50

Optional Parameters

--assigned-identities --user-assigned-identities

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

--capacity

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

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

--identity-resource-id --user-assigned-identity-resource-id

User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.

--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--key-encryption-identity-type --key-identity-type

Only userAssignedIdentity is supported in this API version; other types may be supported in the future.

accepted values: systemAssignedIdentity, userAssignedIdentity
--key-encryption-key-url

Key encryption key Url, versioned only.Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

--linked-databases

List of database resources to link with this database.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--minimum-tls-version

The minimum TLS version for the cluster to support, e.g. '1.2'.

accepted values: 1.0, 1.1, 1.2
--module --modules

Optional set of redis modules to enable in this database - modules can only be added at creation time.

--no-database

Advanced. Do not automatically create a default database. Warning: the cache will not be usable until you create a database.

default value: False
--no-wait

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

default value: False
--persistence

Persistence settings.

--port

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zones -z

The Availability Zones where this cluster will be deployed.

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 delete

Delete a RedisEnterprise cache cluster.

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

Optional Parameters

--cluster-name --name -n

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 list

List all RedisEnterprise clusters in the specified subscription.

az redisenterprise list [--resource-group]

Optional Parameters

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

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

Get information about a RedisEnterprise cluster.

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

Optional Parameters

--cluster-name --name -n

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 update

Update an existing (overwrite/recreate, with potential downtime) cache cluster.

az redisenterprise update [--add]
                          [--assigned-identities]
                          [--capacity]
                          [--cluster-name]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--identity-resource-id]
                          [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                          [--ids]
                          [--key-encryption-identity-type {systemAssignedIdentity, userAssignedIdentity}]
                          [--key-encryption-key-url]
                          [--minimum-tls-version {1.0, 1.1, 1.2}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--sku {EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50}]
                          [--subscription]
                          [--tags]
                          [--zones]

Optional Parameters

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

--assigned-identities --user-assigned-identities

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--capacity

The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

--cluster-name --name -n

The name of the RedisEnterprise cluster.

--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
--identity-resource-id --user-assigned-identity-resource-id

User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.

--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--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.

--key-encryption-identity-type --key-identity-type

Only userAssignedIdentity is supported in this API version; other types may be supported in the future.

accepted values: systemAssignedIdentity, userAssignedIdentity
--key-encryption-key-url

Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

--minimum-tls-version

The minimum TLS version for the cluster to support, e.g. '1.2'.

accepted values: 1.0, 1.1, 1.2
--no-wait

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

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

--sku

The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).

accepted values: EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50
--subscription

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

--tags

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

--zones

The Availability Zones where this cluster will be deployed. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 wait

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

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