az redisenterprise
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 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-link-to-replication-group |
Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group. |
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 upgrade-db-redis-version |
Upgrades the database Redis version to the latest available. |
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 list-skus-for-scaling |
Lists the available SKUs for scaling the Redis Enterprise cluster. |
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 --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 --access-keys-authentication {Disabled, Enabled}]
[--assigned-identities --user-assigned-identities]
[--capacity]
[--client-protocol {Encrypted, Plaintext}]
[--clustering-policy {EnterpriseCluster, NoCluster, OSSCluster}]
[--eviction-policy {AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL}]
[--group-nickname]
[--high-availability {Disabled, Enabled}]
[--identity-resource-id --user-assigned-identity-resource-id]
[--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
[--key-encryption-identity-type --key-identity-type {systemAssignedIdentity, userAssignedIdentity}]
[--key-encryption-key-url]
[--linked-databases]
[--location]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--module --modules]
[--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.).
Property | Value |
---|---|
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
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.
Property | Value |
---|---|
Parameter group: | Identity Arguments |
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.
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
Property | Value |
---|---|
Accepted values: | Encrypted, Plaintext |
Clustering policy - default is OSSCluster. Specified at create time.
Property | Value |
---|---|
Accepted values: | EnterpriseCluster, NoCluster, OSSCluster |
Redis eviction policy - default is VolatileLRU.
Property | Value |
---|---|
Accepted values: | AllKeysLFU, AllKeysLRU, AllKeysRandom, NoEviction, VolatileLFU, VolatileLRU, VolatileRandom, VolatileTTL |
Name for the group of linked database resources.
Property | Value |
---|---|
Parameter group: | Geo Replication Arguments |
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.
Property | Value |
---|---|
Accepted values: | Disabled, Enabled |
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId
.
Property | Value |
---|---|
Parameter group: | KeyEncryptionKeyIdentity Arguments |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Property | Value |
---|---|
Parameter group: | Identity Arguments |
Accepted values: | None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned |
Only userAssignedIdentity is supported in this API version; other types may be supported in the future.
Property | Value |
---|---|
Parameter group: | KeyEncryptionKeyIdentity Arguments |
Accepted values: | systemAssignedIdentity, userAssignedIdentity |
Key encryption key Url, versioned only.Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
.
Property | Value |
---|---|
Parameter group: | Encryption Arguments |
List of database resources to link with this database.
Property | Value |
---|---|
Parameter group: | Geo Replication Arguments |
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'.
Property | Value |
---|---|
Accepted values: | 1.0, 1.1, 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.
Property | Value |
---|---|
Default value: | False |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az redisenterprise delete
Delete a RedisEnterprise cache cluster.
az redisenterprise delete [--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the RedisEnterprise cluster.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az redisenterprise list
List all RedisEnterprise clusters in the specified subscription.
az redisenterprise list [--resource-group]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az redisenterprise list-skus-for-scaling
Lists the available SKUs for scaling the Redis Enterprise cluster.
az redisenterprise list-skus-for-scaling [--cluster-name]
[--ids]
[--resource-group]
[--subscription]
Examples
RedisEnterpriseListSkusForScaling
az redisenterprise list-skus-for-scaling --resource-group rg1 --cluster-name cache1
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az redisenterprise show
Get information about a RedisEnterprise cluster.
az redisenterprise show [--cluster-name --name]
[--ids]
[--resource-group]
[--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.
The name of the RedisEnterprise cluster.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az redisenterprise update
Update an existing (overwrite/recreate, with potential downtime) cache cluster.
az redisenterprise update [--add]
[--assigned-identities --user-assigned-identities]
[--capacity]
[--cluster-name --name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--high-availability {Disabled, Enabled}]
[--identity-resource-id --user-assigned-identity-resource-id]
[--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
[--ids]
[--key-encryption-identity-type --key-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
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.
Property | Value |
---|---|
Parameter group: | Identity Arguments |
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.
Property | Value |
---|---|
Parameter group: | Sku Arguments |
The name of the RedisEnterprise cluster.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Disabled, Enabled |
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId
.
Property | Value |
---|---|
Parameter group: | KeyEncryptionKeyIdentity Arguments |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Property | Value |
---|---|
Parameter group: | Identity Arguments |
Accepted values: | None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned |
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 |
Only userAssignedIdentity is supported in this API version; other types may be supported in the future.
Property | Value |
---|---|
Parameter group: | KeyEncryptionKeyIdentity Arguments |
Accepted values: | systemAssignedIdentity, userAssignedIdentity |
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
.
Property | Value |
---|---|
Parameter group: | Encryption Arguments |
The minimum TLS version for the cluster to support, e.g. '1.2'.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 1.0, 1.1, 1.2 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).
Property | Value |
---|---|
Parameter group: | Sku Arguments |
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 |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
The Availability Zones where this cluster will be deployed. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az redisenterprise wait
Place the CLI in a waiting state until a condition is met.
az redisenterprise wait [--cluster-name --name]
[--created]
[--custom]
[--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.
The name of the RedisEnterprise cluster.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |