az redisenterprise

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 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 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 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 {Balanced_B0, Balanced_B1, Balanced_B10, Balanced_B100, Balanced_B1000, Balanced_B150, Balanced_B20, Balanced_B250, Balanced_B3, Balanced_B350, Balanced_B5, Balanced_B50, Balanced_B500, Balanced_B700, ComputeOptimized_X10, ComputeOptimized_X100, ComputeOptimized_X150, ComputeOptimized_X20, ComputeOptimized_X250, ComputeOptimized_X3, ComputeOptimized_X350, ComputeOptimized_X5, ComputeOptimized_X50, ComputeOptimized_X500, ComputeOptimized_X700, EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50, FlashOptimized_A1000, FlashOptimized_A1500, FlashOptimized_A2000, FlashOptimized_A250, FlashOptimized_A4500, FlashOptimized_A500, FlashOptimized_A700, MemoryOptimized_M10, MemoryOptimized_M100, MemoryOptimized_M1000, MemoryOptimized_M150, MemoryOptimized_M1500, MemoryOptimized_M20, MemoryOptimized_M2000, MemoryOptimized_M250, MemoryOptimized_M350, MemoryOptimized_M50, MemoryOptimized_M500, MemoryOptimized_M700}
                          [--access-keys-auth {Disabled, Enabled}]
                          [--assigned-identities]
                          [--capacity]
                          [--client-protocol {Encrypted, Plaintext}]
                          [--clustering-policy {EnterpriseCluster, OSSCluster}]
                          [--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
                          [--group-nickname]
                          [--high-availability {Disabled, Enabled}]
                          [--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: Balanced_B0, Balanced_B1, Balanced_B10, Balanced_B100, Balanced_B1000, Balanced_B150, Balanced_B20, Balanced_B250, Balanced_B3, Balanced_B350, Balanced_B5, Balanced_B50, Balanced_B500, Balanced_B700, ComputeOptimized_X10, ComputeOptimized_X100, ComputeOptimized_X150, ComputeOptimized_X20, ComputeOptimized_X250, ComputeOptimized_X3, ComputeOptimized_X350, ComputeOptimized_X5, ComputeOptimized_X50, ComputeOptimized_X500, ComputeOptimized_X700, EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50, FlashOptimized_A1000, FlashOptimized_A1500, FlashOptimized_A2000, FlashOptimized_A250, FlashOptimized_A4500, FlashOptimized_A500, FlashOptimized_A700, MemoryOptimized_M10, MemoryOptimized_M100, MemoryOptimized_M1000, MemoryOptimized_M150, MemoryOptimized_M1500, MemoryOptimized_M20, MemoryOptimized_M2000, MemoryOptimized_M250, MemoryOptimized_M350, MemoryOptimized_M50, MemoryOptimized_M500, MemoryOptimized_M700

Optional Parameters

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

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

--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 or not applicable depending on SKU.Valid values are (2, 4, 6, ...) for Enterprise_* SKUs and (3, 9, 15, ...) for EnterpriseFlash_* SKUs. For other SKUs capacity argument is not supported.

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

--high-availability

Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.

Accepted values: Disabled, Enabled

--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}]
                          [--high-availability {Disabled, Enabled}]
                          [--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 {Balanced_B0, Balanced_B1, Balanced_B10, Balanced_B100, Balanced_B1000, Balanced_B150, Balanced_B20, Balanced_B250, Balanced_B3, Balanced_B350, Balanced_B5, Balanced_B50, Balanced_B500, Balanced_B700, ComputeOptimized_X10, ComputeOptimized_X100, ComputeOptimized_X150, ComputeOptimized_X20, ComputeOptimized_X250, ComputeOptimized_X3, ComputeOptimized_X350, ComputeOptimized_X5, ComputeOptimized_X50, ComputeOptimized_X500, ComputeOptimized_X700, EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50, FlashOptimized_A1000, FlashOptimized_A1500, FlashOptimized_A2000, FlashOptimized_A250, FlashOptimized_A4500, FlashOptimized_A500, FlashOptimized_A700, MemoryOptimized_M10, MemoryOptimized_M100, MemoryOptimized_M1000, MemoryOptimized_M150, MemoryOptimized_M1500, MemoryOptimized_M20, MemoryOptimized_M2000, MemoryOptimized_M250, MemoryOptimized_M350, MemoryOptimized_M50, MemoryOptimized_M500, MemoryOptimized_M700}]
                          [--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 or not applicable depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise_* SKUs and (3, 9, 15, ...) for EnterpriseFlash_* SKUs. For other SKUs capacity argument is not supported.

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

--high-availability

Preview

Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.

Accepted values: Disabled, Enabled

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

--sku

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

Accepted values: Balanced_B0, Balanced_B1, Balanced_B10, Balanced_B100, Balanced_B1000, Balanced_B150, Balanced_B20, Balanced_B250, Balanced_B3, Balanced_B350, Balanced_B5, Balanced_B50, Balanced_B500, Balanced_B700, ComputeOptimized_X10, ComputeOptimized_X100, ComputeOptimized_X150, ComputeOptimized_X20, ComputeOptimized_X250, ComputeOptimized_X3, ComputeOptimized_X350, ComputeOptimized_X5, ComputeOptimized_X50, ComputeOptimized_X500, ComputeOptimized_X700, EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50, FlashOptimized_A1000, FlashOptimized_A1500, FlashOptimized_A2000, FlashOptimized_A250, FlashOptimized_A4500, FlashOptimized_A500, FlashOptimized_A700, MemoryOptimized_M10, MemoryOptimized_M100, MemoryOptimized_M1000, MemoryOptimized_M150, MemoryOptimized_M1500, MemoryOptimized_M20, MemoryOptimized_M2000, MemoryOptimized_M250, MemoryOptimized_M350, MemoryOptimized_M50, MemoryOptimized_M500, MemoryOptimized_M700

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