az redisenterprise
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
az redisenterprise create |
Create an existing (overwrite/recreate, with potential downtime) cache cluster. |
az redisenterprise database |
Manage Redis Enterprise databases. |
az redisenterprise database create |
Create a database. |
az redisenterprise database delete |
Delete a single database. |
az redisenterprise database export |
Exports a database file from target database. |
az redisenterprise database flush |
Flushes all the keys in this database and also from its linked databases. |
az redisenterprise database force-unlink |
Forcibly removes the link to the specified database resource. |
az redisenterprise database import |
Imports database files to target database. |
az redisenterprise database list |
List all databases in the specified RedisEnterprise cluster. |
az redisenterprise database list-keys |
Retrieves the access keys for the RedisEnterprise database. |
az redisenterprise database regenerate-key |
Regenerates the RedisEnterprise database's access keys. |
az redisenterprise database show |
Get information about a database in a RedisEnterprise cluster. |
az redisenterprise database update |
Update a database. |
az redisenterprise database wait |
Place the CLI in a waiting state until a condition is met. |
az redisenterprise delete |
Delete a RedisEnterprise cache cluster. |
az redisenterprise list |
List all RedisEnterprise clusters in the specified subscription. |
az redisenterprise operation-status |
Get the status of an operation. |
az redisenterprise operation-status show |
Get the status of operation. |
az redisenterprise show |
Get information about a RedisEnterprise cluster. |
az redisenterprise update |
Update an existing (overwrite/recreate, with potential downtime) cache cluster. |
az redisenterprise wait |
Place the CLI in a waiting state until a condition is met. |
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_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
The name of the RedisEnterprise cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).
Optional Parameters
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.
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.
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
Clustering policy - default is OSSCluster. Specified at create time.
Redis eviction policy - default is VolatileLRU.
Name for the group of linked database resources.
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Only userAssignedIdentity is supported in this API version; other types may be supported in the future.
Key encryption key Url, versioned only.Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.
List of database resources to link with this database.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The minimum TLS version for the cluster to support, e.g. '1.2'.
Optional set of redis modules to enable in this database - modules can only be added at creation time.
Advanced. Do not automatically create a default database. Warning: the cache will not be usable until you create a database.
Do not wait for the long-running operation to finish.
Persistence settings.
TCP port of the database endpoint. Specified at create time. Defaults to an available port.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The Availability Zones where this cluster will be deployed.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the RedisEnterprise cluster.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the RedisEnterprise cluster.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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_E50}]
[--subscription]
[--tags]
[--zones]
Optional Parameters
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>.
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.
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.
The name of the RedisEnterprise cluster.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
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.
Only userAssignedIdentity is supported in this API version; other types may be supported in the future.
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.
The minimum TLS version for the cluster to support, e.g. '1.2'.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try ??
to show more.
The Availability Zones where this cluster will be deployed. Support shorthand-syntax, json-file and yaml-file. Try ??
to show more.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the RedisEnterprise cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for