|
| 1 | +--- |
| 2 | +title: Create, query, and delete a cache using Azure CLI |
| 3 | +description: Use the Azure CLI to create an Azure Cache for Redis instance, get cache details like status, hostname, ports, and keys, and delete the cache. |
| 4 | +ms.devlang: azurecli |
| 5 | +ms.topic: sample |
| 6 | +ms.date: 05/18/2025 |
| 7 | +ms.custom: |
| 8 | + - devx-track-azurecli, ignite-2024, build-2025 |
| 9 | + - build-2025 |
| 10 | +appliesto: |
| 11 | + - ✅ Azure Cache for Redis |
| 12 | +--- |
| 13 | + |
| 14 | +# Manage an Azure Redis cache using the Azure CLI |
| 15 | + |
| 16 | +This article describes how to create and delete an Azure Redis cache instance by using the Azure CLI. The article also shows how to use the Azure CLI to get cache details including provisioning status, hostname, ports, and keys. |
| 17 | + |
| 18 | +## Prerequisites |
| 19 | + |
| 20 | +- [!INCLUDE [quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)] |
| 21 | +[!INCLUDE [azure-cli-prepare-your-environment-no-header.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)] |
| 22 | +- Make sure you're signed in to Azure with the subscription you want to create your cache under. To use a different subscription than the one you're signed in with, run `az account set -s <subscriptionId>`, replacing `<subscriptionId>` with the subscription ID you want to use. |
| 23 | + |
| 24 | +>[!IMPORTANT] |
| 25 | +>Use these scripts to create and manage Azure Cache for Redis Basic, Standard, and Premium tiers with the Azure CLI [az redis](/cli/azure/redis) commands. |
| 26 | +> |
| 27 | +>Azure Cache for Redis Enterprise tiers and Azure Managed Redis use the [az redisenterprise](/cli/azure/redisenterprise) commands. The `redisenterprise` extension for Azure CLI version 2.61.0 or higher prompts you for installation the first time you run an `az redisenterprise` command. |
| 28 | +> |
| 29 | +>To create and manage an Azure Cache for Redis Enterprise-tier cache, use the [Azure Managed Redis](create-manage-cache.md?pivots=azure-managed-redis) scripts. |
| 30 | +
|
| 31 | +## Create an Azure Cache for Redis cache |
| 32 | + |
| 33 | +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](create-manage-cache.md?pivots=azure-managed-redis) scripts. |
| 34 | + |
| 35 | +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. |
| 36 | + |
| 37 | +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: |
| 38 | + |
| 39 | +- [Azure portal (Basic, Standard, or Premium)](../../azure-cache-for-redis/quickstart-create-redis.md) |
| 40 | +- [Azure PowerShell](../how-to-manage-redis-cache-powershell.md?pivots=azure-cache-redis) |
| 41 | +- [ARM template](../redis-cache-arm-provision.md#azure-cache-for-redis) |
| 42 | +- [Bicep template](../redis-cache-bicep-provision.md#azure-cache-for-redis) |
| 43 | + |
| 44 | +The cache `name` must be a string of 1-63 characters that's unique in the [Azure region](https://azure.microsoft.com/regions/). The name can contain only numbers, letters, and hyphens, must start and end with a number or letter, and can't contain consecutive hyphens. |
| 45 | + |
| 46 | +The `location` should be an Azure region near other services that use your cache. |
| 47 | + |
| 48 | +Choose a [sku](https://azure.microsoft.com/pricing/details/cache/) and `size` that have the appropriate features and performance for your cache. |
| 49 | + |
| 50 | +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. |
| 51 | + |
| 52 | +>[!IMPORTANT] |
| 53 | +>Microsoft Entra authentication is recommended for security. You can enable Microsoft Entra Authentication during or after cache creation. |
| 54 | +> |
| 55 | +>Use Microsoft Entra ID with managed identities to authorize requests against your cache if possible. Authorization using Microsoft Entra ID and managed identity provides better security and is easier to use than shared access key authorization. For more information about using managed identities with your cache, see [Use Microsoft Entra ID for cache authentication](../../azure-cache-for-redis/cache-azure-active-directory-for-authentication.md). |
| 56 | +
|
| 57 | +The following script uses the [az group create](/cli/azure/group) and [az redis create](/cli/azure/redis#az-redis-create) commands to create a resource group with an Azure Cache for Redis Basic C0 cache in it. |
| 58 | + |
| 59 | +```azurecli |
| 60 | +
|
| 61 | +# Variable block |
| 62 | +let "randomIdentifier=$RANDOM*$RANDOM" |
| 63 | +location="East US" |
| 64 | +resourceGroup="redis-cache-rg-$randomIdentifier" |
| 65 | +tag="create-manage-cache" |
| 66 | +cache="redis-cache-$randomIdentifier" |
| 67 | +sku="basic" |
| 68 | +size="C0" |
| 69 | +
|
| 70 | +# Create a resource group |
| 71 | +echo "Creating $resourceGroup in "$location"..." |
| 72 | +az group create --resource-group $resourceGroup --location "$location" --tags $tag |
| 73 | +
|
| 74 | +# Create a Basic C0 (256 MB) Azure Redis cache |
| 75 | +echo "Creating $cache" |
| 76 | +az redis create --name $cache --resource-group $resourceGroup --location "$location" --sku $sku --vm-size $size |
| 77 | +``` |
| 78 | + |
| 79 | +## Get details for an Azure Cache for Redis cache |
| 80 | + |
| 81 | +The following script uses the [az redis show](/cli/azure/redis#az-redis-show) and [az redis list-keys](/cli/azure/redis#az-redis-list-keys) commands to get and display the name, hostname, ports, and keys details for the preceding cache. |
| 82 | + |
| 83 | +>[!IMPORTANT] |
| 84 | +>The `list-keys` operation works only when access keys are enabled for the cache. The output of this command might compromise security by showing secrets, and may trigger a sensitive information warning. For more information, see [Use Azure CLI to manage sensitive information](https://go.microsoft.com/fwlink/?linkid=2258669). |
| 85 | +
|
| 86 | +```azurecli |
| 87 | +
|
| 88 | +# Get details of an Azure Cache for Redis cache |
| 89 | +echo "Showing details of $cache" |
| 90 | +az redis show --name "$cache" --resource-group $resourceGroup |
| 91 | +
|
| 92 | +# Retrieve the hostname and ports for an Azure Redis instance |
| 93 | +redis=($(az redis show --name "$cache" --resource-group $resourceGroup --query [hostName,enableNonSslPort,port,sslPort] --output tsv)) |
| 94 | +
|
| 95 | +# Retrieve the keys for an Azure Redis instance |
| 96 | +keys=($(az redis list-keys --name "$cache" --resource-group $resourceGroup --query [primaryKey,secondaryKey] --output tsv)) |
| 97 | +
|
| 98 | +# Display the retrieved hostname, keys, and ports |
| 99 | +echo "Hostname:" ${redis[0]} |
| 100 | +echo "Non SSL Port:" ${redis[2]} |
| 101 | +echo "Non SSL Port Enabled:" ${redis[1]} |
| 102 | +echo "SSL Port:" ${redis[3]} |
| 103 | +echo "Primary Key:" ${keys[0]} |
| 104 | +echo "Secondary Key:" ${keys[1]} |
| 105 | +``` |
| 106 | + |
| 107 | +## Clean up resources |
| 108 | + |
| 109 | +The following script uses the [az group delete](/cli/azure/group) and [az redis delete](/cli/azure/redis#az-redis-delete) commands to delete the preceding cache, and then delete its resource group. |
| 110 | + |
| 111 | +```azurecli |
| 112 | +# Delete an Azure Redis cache |
| 113 | +echo "Deleting $cache" |
| 114 | +az redis delete --name "$cache" --resource-group $resourceGroup -y |
| 115 | +
|
| 116 | +# echo "Deleting all resources" |
| 117 | +az group delete --resource-group $resourceGroup -y |
| 118 | +``` |
| 119 | + |
| 120 | +## Related content |
| 121 | + |
| 122 | +- [Azure CLI documentation](/cli/azure) |
| 123 | +- [Create a Premium Azure Cache for Redis with clustering](../../azure-cache-for-redis/scripts/create-manage-premium-cache-cluster.md) |
0 commit comments