Manage an Azure Redis cache using the Azure CLI

Create an Azure Managed Redis cache

To create an Azure Managed Redis cache by using Azure CLI, the name, location, resourceGroup, and sku parameters are required. Other parameters are optional and have defaults.

You can use the Azure CLI script in this section to create an Azure Managed Redis cache with default settings. You can also use the following other methods to create a cache:

• Azure portal
• Azure PowerShell
• ARM template
• Bicep template

The cache name must be a string of 1-63 characters that's unique in the Azure region. The name can contain only numbers, letters, and hyphens, must start and end with a number or letter, and can't contain consecutive hyphens.

The location should be an Azure region near other services that use your cache.

Choose a sku that has the appropriate features and performance for your cache.

Microsoft Entra authentication is enabled by default for all new caches and is recommended for security.

Transport Layer Security (TLS) 1.2-1.3 encryption is enabled by default for all new caches. You can enable the non-TLS port and connections during or after cache creation, but for security reasons, disabling TLS isn't recommended.

The following script sets variables, and then uses the az group create and az redisenterprise create commands to create a resource group with an Azure Managed Redis Balanced B1 SKU cache in it.

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
resourceGroup="redis-cache-rg-$randomIdentifier"
tag="create-manage-cache"
cache="redis-cache-$randomIdentifier"
sku="Balanced_B1"

# Create a resource group
echo "Creating $resourceGroup in "$location"..."
az group create --resource-group $resourceGroup --location "$location" --tags $tag

# Create a Balanced B1 Azure Managed Redis cache
echo "Creating $cache"
az redisenterprise create --name $cache --resource-group $resourceGroup --location "$location" --sku $sku

Get details for an Azure Managed Redis cache

The following script uses the az redisenterprise show and az redisenterprise database list-keys commands to get and display the name, hostname, ports, and keys details for the preceding cache.

# Get details of an Azure Managed Redis cache
echo "Showing details of $cache"
az redisenterprise show --name "$cache" --resource-group $resourceGroup 

# Retrieve the hostname and ports for an Azure Redis Cache instance
redis=($(az redisenterprise show --name "$cache" --resource-group $resourceGroup --query [hostName,enableNonSslPort,port,sslPort] --output tsv))

# Retrieve the keys for an Azure Redis Cache instance
keys=($(az redisenterprise database list-keys --cluster-name "$cache" --resource-group $resourceGroup --query [primaryKey,secondaryKey] --output tsv))

# Display the retrieved hostname, keys, and ports
echo "Hostname:" ${redis[0]}
echo "Non SSL Port:" ${redis[2]}
echo "Non SSL Port Enabled:" ${redis[1]}
echo "SSL Port:" ${redis[3]}
echo "Primary Key:" ${keys[0]}
echo "Secondary Key:" ${keys[1]}

Clean up resources

The following script uses the az group delete and az redisenterprise delete commands to delete the preceding cache, and then delete its resource group.

# Delete a redis cache
echo "Deleting $cache"
az redisenterprise delete --name "$cache" --resource-group $resourceGroup -y

# echo "Deleting all resources"
az group delete --resource-group $resourceGroup -y

Create an Azure Cache for Redis cache

You can use the following Azure CLI script to create an Azure Cache for Redis Basic, Standard, or Premium-tier cache. To create and manage an Azure Cache for Redis Enterprise-tier cache, use the Azure Managed Redis scripts.

To create an Azure Cache for Redis Basic, Standard, or Premium cache by using Azure CLI, the name, location, resourceGroup, sku, and size parameters are required. Other parameters are optional and have defaults.

You can use the Azure CLI script in this section to create an Azure Cache for Redis Basic cache with default settings. You can also use the following other methods to create a cache:

• Azure portal (Basic, Standard, or Premium)
• Azure portal (Enterprise)
• Azure PowerShell
• ARM template
• Bicep template

The cache name must be a string of 1-63 characters that's unique in the Azure region. The name can contain only numbers, letters, and hyphens, must start and end with a number or letter, and can't contain consecutive hyphens.

The location should be an Azure region near other services that use your cache.

Choose a sku and size that have the appropriate features and performance for your cache.

Transport Layer Security (TLS) 1.2-1.3 encryption is enabled by default for all new caches. You can enable the non-TLS port and connections during or after cache creation, but for security reasons, disabling TLS isn't recommended.

The following script uses the az group create and az redis create commands to create a resource group with an Azure Cache for Redis Basic C0 cache in it.

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
resourceGroup="redis-cache-rg-$randomIdentifier"
tag="create-manage-cache"
cache="redis-cache-$randomIdentifier"
sku="basic"
size="C0"

# Create a resource group
echo "Creating $resourceGroup in "$location"..."
az group create --resource-group $resourceGroup --location "$location" --tags $tag

# Create a Basic C0 (256 MB) Azure Redis cache
echo "Creating $cache"
az redis create --name $cache --resource-group $resourceGroup --location "$location" --sku $sku --vm-size $size

Get details for an Azure Cache for Redis cache

The following script uses the az redis show and az redis list-keys commands to get and display the name, hostname, ports, and keys details for the preceding cache.

# Get details of an Azure Cache for Redis cache
echo "Showing details of $cache"
az redis show --name "$cache" --resource-group $resourceGroup

# Retrieve the hostname and ports for an Azure Redis instance
redis=($(az redis show --name "$cache" --resource-group $resourceGroup --query [hostName,enableNonSslPort,port,sslPort] --output tsv))

# Retrieve the keys for an Azure Redis instance
keys=($(az redis list-keys --name "$cache" --resource-group $resourceGroup --query [primaryKey,secondaryKey] --output tsv))

# Display the retrieved hostname, keys, and ports
echo "Hostname:" ${redis[0]}
echo "Non SSL Port:" ${redis[2]}
echo "Non SSL Port Enabled:" ${redis[1]}
echo "SSL Port:" ${redis[3]}
echo "Primary Key:" ${keys[0]}
echo "Secondary Key:" ${keys[1]}

Clean up resources

The following script uses the az group delete and az redis delete commands to delete the preceding cache, and then delete its resource group.

# Delete an Azure Redis cache
echo "Deleting $cache"
az redis delete --name "$cache" --resource-group $resourceGroup -y

# echo "Deleting all resources"
az group delete --resource-group $resourceGroup -y