az redis
Manage dedicated Redis caches for your Azure applications.
Commands
az redis create |
Create new Redis Cache instance. |
az redis delete |
Deletes a Redis cache. |
az redis export |
Export data stored in a Redis cache. |
az redis firewall-rules |
Manage Redis firewall rules. |
az redis firewall-rules create |
Create a redis cache firewall rule. |
az redis firewall-rules delete |
Deletes a single firewall rule in a specified redis cache. |
az redis firewall-rules list |
Gets all firewall rules in the specified redis cache. |
az redis firewall-rules show |
Gets a single firewall rule in a specified redis cache. |
az redis firewall-rules update |
Update a redis cache firewall rule. |
az redis force-reboot |
Reboot specified Redis node(s). |
az redis import |
Import data into a Redis cache. |
az redis import-method |
Import data into Redis cache. |
az redis list |
List Redis Caches. |
az redis list-keys |
Retrieve a Redis cache's access keys. |
az redis patch-schedule |
Manage Redis patch schedules. |
az redis patch-schedule create |
Create patching schedule for Redis cache. |
az redis patch-schedule delete |
Deletes the patching schedule of a redis cache (requires Premium SKU). |
az redis patch-schedule show |
Gets the patching schedule of a redis cache (requires Premium SKU). |
az redis patch-schedule update |
Update the patching schedule for Redis cache. |
az redis regenerate-keys |
Regenerate Redis cache's access keys. |
az redis server-link |
Manage Redis server links. |
az redis server-link create |
Adds a server link to the Redis cache (requires Premium SKU). |
az redis server-link delete |
Deletes the linked server from a redis cache (requires Premium SKU). |
az redis server-link list |
Gets the list of linked servers associated with this redis cache (requires Premium SKU). |
az redis server-link show |
Gets the detailed information about a linked server of a redis cache (requires Premium SKU). |
az redis show |
Gets a Redis cache (resource description). |
az redis update |
Update a Redis cache. |
az redis create
Create new Redis Cache instance.
az redis create --location
--name
--resource-group
--sku {Basic, Premium, Standard}
--vm-size {c0, c1, c2, c3, c4, c5, c6, p1, p2, p3, p4, p5}
[--enable-non-ssl-port]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--redis-configuration]
[--replicas-per-master]
[--shard-count]
[--static-ip]
[--subnet-id]
[--subscription]
[--tags]
[--tenant-settings]
[--zones {1, 2, 3}]
Examples
Create new Redis Cache instance. (autogenerated)
az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Basic --vm-size c0
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of the Redis cache.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Type of Redis cache.
Size of Redis cache to deploy. Basic and Standard Cache sizes start with C. Premium Cache sizes start with P.
Optional Parameters
If specified, then the non-ssl redis server port (6379) will be enabled.
Specifies the TLS version required by clients to connect to cache.
JSON encoded configuration settings. Use @{file} to load from a file.
The number of replicas to be created per master.
The number of shards to be created on a Premium Cluster Cache.
Specify a static ip if required for the VNET. If you do not specify a static IP then an IP address is chosen automatically.
The full resource ID of a subnet in a virtual network to deploy the redis cache in. Example format /subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.{Network|ClassicNetwork}/virtualNetworks/vnet1/subnets/subnet1.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Space-separated tenant settings in key[=value] format.
Space-separated list of availability zones into which to provision the resource.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis delete
Deletes a Redis cache.
az redis delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Optional Parameters
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis export
Export data stored in a Redis cache.
az redis export --container
--prefix
[--file-format]
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
SAS url for container where data needs to be exported to.
Prefix to use for exported files.
Optional Parameters
Format of the blob (Currently rdb is the only supported format, with other formats expected in the future).
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis force-reboot
Reboot specified Redis node(s).
This operation requires write permission to the cache resource. There can be potential data loss.
az redis force-reboot --reboot-type {AllNodes, PrimaryNode, SecondaryNode}
[--ids]
[--name]
[--resource-group]
[--shard-id]
[--subscription]
Required Parameters
Which Redis node(s) to reboot. Depending on this value data loss is possible.
Optional Parameters
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 the Redis cache.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
If clustering is enabled, the ID of the shard to be rebooted.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis import
Import data into a Redis cache.
az redis import --files
[--file-format]
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
SAS url for blobs that needs to be imported.
Optional Parameters
Format of the blob (Currently rdb is the only supported format, with other formats expected in the future).
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis import-method
Import data into Redis cache.
az redis import-method --files
[--file-format]
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
SAS url for blobs that needs to be imported.
Optional Parameters
Format of the blob (Currently rdb is the only supported format, with other formats expected in the future).
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis list
List Redis Caches.
Lists details about all caches within current Subscription or provided Resource Group.
az redis list [--query-examples]
[--resource-group]
[--subscription]
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis list-keys
Retrieve a Redis cache's access keys.
This operation requires write permission to the cache resource.
az redis list-keys [--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis regenerate-keys
Regenerate Redis cache's access keys.
This operation requires write permission to the cache resource.
az redis regenerate-keys --key-type {Primary, Secondary}
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
The Redis access key to regenerate.
Optional Parameters
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 the Redis cache.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis show
Gets a Redis cache (resource description).
az redis show [--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
Optional Parameters
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 the Redis cache.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
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.
Increase logging verbosity. Use --debug for full debug logs.
az redis update
Update a Redis cache.
Scale or update settings of a Redis cache.
az redis update [--add]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--sku {Basic, Premium, Standard}]
[--subscription]
[--vm-size {c0, c1, c2, c3, c4, c5, c6, p1, p2, p3, p4, p5}]
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 the Redis cache.
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=.
Type of Redis cache.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Size of Redis cache to deploy. Basic and Standard Cache sizes start with C. Premium Cache sizes start with P.
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.
Increase logging verbosity. Use --debug for full debug logs.