LinuxCommandLibrary

az-redis

Manage Azure Cache for Redis instances

TLDR

Create a new Redis cache instance

$ az redis create --location [location] [[-n|--name]] [name] [[-g|--resource-group]] [resource_group] --sku [Basic|Premium|Standard] --vm-size [c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5]
copy

Update a Redis cache
$ az redis update [[-n|--name]] [name] [[-g|--resource-group]] [resource_group] --sku [Basic|Premium|Standard] --vm-size [c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5]
copy

Export data stored in a Redis cache
$ az redis export --container [container] --file-format [file-format] [[-n|--name]] [name] --prefix [prefix] [[-g|--resource-group]] [resource_group]
copy

Delete a Redis cache
$ az redis delete [[-n|--name]] [name] [[-g|--resource-group]] [resource_group] [[-y|--yes]]
copy

SYNOPSIS

az redis <subcommand> [--resource-group -g] [--name -n] [--subscription] [--output -o] [--query -q] [--verbose] [--debug]

PARAMETERS

--debug
    Increase logging verbosity to show all debug logs.

--help -h
    Show help for az redis.

--only-show-errors
    Only show errors, suppressing warnings.

--output -o
    Output format: json, jsonc, table, tsv, yaml (default: json).

--query -q
    JMESPath query string to customize output.

--resource-group -g
    Name or ID of resource group (common for subcommands).

--subscription
    Name or ID of Azure subscription.

--verbose
    Increase logging verbosity.

DESCRIPTION

az redis is a command group in the Azure Command-Line Interface (CLI) for managing Azure Cache for Redis, a fully managed, in-memory caching service. It enables creation, listing, updating, deletion, scaling, rebooting, key regeneration, firewall rule management, and diagnostic configurations for Redis caches.

Operations require an active az login session with permissions on the target subscription and resource group. Supports Basic, Standard, Premium, and Enterprise tiers with clustering, persistence, and modules like RediSearch or RedisJSON.

Common workflows include provisioning caches with SKU specifications, listing caches per resource group or subscription, forcing node reboots for maintenance, and listing access keys. Output formats include table, JSON, TSV, or CSV via --output. Integrates with other az commands for resource group and networking management.

Ideal for DevOps automation, CI/CD pipelines, and infrastructure-as-code with tools like Terraform or ARM templates, reducing latency for web apps by caching data.

CAVEATS

Requires Azure CLI 2.11+ installed and az login. Subcommands have additional required/optional params (e.g., create needs SKU). Not for local Redis; Azure-specific. Rate limits apply on frequent operations.

SUBCOMMANDS

Key ones: create, delete, list, show, update, force-reboot, list-keys, regenerate-key, firewall-rules.

EXAMPLES

az redis create -g myRG -n mycache --sku Basic --vm-size c0
az redis list -g myRG
az redis list-keys -g myRG -n mycache

HISTORY

Part of Azure CLI since 2.0 (2017), aligned with Azure Cache for Redis GA. Evolved with tiers (Enterprise 2019+), modules support (2020+), and private endpoints integration.

SEE ALSO

Copied to clipboard