redis-cli

Author: v-thepet

articles/azure-cache-for-redis/cache-how-to-redis-cli-tool.md

@@ -1,116 +1,123 @@
 ---
-title: Use redis-cli with Azure Cache for Redis
-description: Learn how to use *redis-cli* as a command-line tool for interacting with an Azure Cache for Redis as a client
+title: Use redis-cli
+description: Learn how to use redis-cli as a command-line tool for interacting with an Azure Cache for Redis as a client.
 
 
 
-ms.topic: conceptual
+ms.topic: how-to
 ms.date: 01/04/2024
 appliesto:
   - ✅ Azure Cache for Redis
 ---
 # Use the Redis command-line tool with Azure Cache for Redis
 
-Use the [redis-cli command-line tool](https://redis.io/docs/connect/cli/) to interact with an Azure Cache for Redis as a client. Use this tool to directly interact with your Azure Cache for Redis instance and for debugging and troubleshooting.
+This article describes how to use the [redis-cli command-line interface](https://redis.io/docs/connect/cli/) to interact with Azure Cache for Redis as a client. You can use *redis-cli* to directly interact with your Azure Redis cache instance, and for debugging and troubleshooting.
+
+## Prerequisite
+
+Access to an Azure Cache for Redis server instance.
 
 ## Install redis-cli
 
-The _redis-cli_ tool is installed automatically with the _Redis package_, which is available for multiple operating systems. See the open source [install Redis](https://redis.io/docs/install/install-redis/) guide for the most detailed documentation on your preferred operating system.
+The redis-cli tool installs automatically with the Redis package, which is available for Linux, macOS, and Windows. For detailed installation instructions for your operating system, see the open-source [Install Redis](https://redis.io/docs/install/install-redis/) guide.
 
-### Linux
+### Install on Linux
 
-The _redis-cli_ runs natively on Linux, and most distributions include a _Redis package_ that contains the _redis-cli_ tool. On Ubuntu, for instance, you install the _Redis package_  with the following commands:
+The redis-cli tool runs natively on Linux, and most Linux distributions include a Redis package that contains redis-cli. On Ubuntu, for instance, you install the Redis package with the following commands:
 
 ```linux
 sudo apt-get update
 sudo apt-get install redis
 ```
 
-### Windows
+### Install on Windows
 
-The best way to use _redis-cli_ on a Windows computer is to install the [Windows Subsystem for Linux (WSL)](/windows/wsl/about). The Linux subsystem allows you to run linux tools directly on Windows. To install WSL, follow the [WSL installation instructions](/windows/wsl/install).
+The best way to use redis-cli on Windows is to install the [Windows Subsystem for Linux (WSL2)](/windows/wsl/about), which allows you to run Linux tools directly on Windows. To install WSL, see [How to install Linux on Windows with WSL](/windows/wsl/install).
 
-Once WSL is installed, you can install _redis-cli_ using whatever package management is available in the Linux distro you chose for WSL.
+Once installed, use WSL to install a Linux distro, and then install redis-cli by using the available package management for the Linux distro you chose. The default distro for WSL is Ubuntu. For more information, see [Install Redis on Windows](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/).
 
-## Gather cache access information
+## Connect using redis-cli
 
-You can gather the information needed to access the cache using these methods:
+To use redis-cli to connect to your Azure Redis cache as a client, you must specify the cache host name, ports, and keys. You can retrieve these values by the following methods:
 
 - Azure CLI using [az redis list-keys](/cli/azure/redis#az-redis-list-keys)
 - Azure PowerShell using [Get-AzRedisCacheKey](/powershell/module/az.rediscache/Get-AzRedisCacheKey)
-- Using the Azure portal
+- [Azure portal](https://portal.azure.com)
 
-In this section, you retrieve the keys from the Azure portal.
+The following section describes how to get these values from the Azure portal.
 
 [!INCLUDE [redis-cache-create](includes/redis-cache-access-keys.md)]
 
-## Connect using redis-cli
+### Gather cache information
 
-Open up a shell or terminal on a computer with the _Redis package_ installed. If using WSL, you can [use the Windows Terminal](/windows/wsl/install#ways-to-run-multiple-linux-distributions-with-wsl) to open a Linux command line. Before connecting with redis-cli, check:
+Before connecting to your cache via redis-cli, determine the following information so you know what command options to use.
 
-1. Whether TLS access is needed - By default, Azure Cache for Redis instances use [TLS](cache-remove-tls-10-11.md) encryption for connections. Whenever TLS is used on the server side, TLS on redis-cli must be enabled using the `--tls` option.
-1. The port used - All Enterprise and Enterprise Flash tier caches use port `10000`. Basic, Standard, and Premium tier caches, however, use either port `6379` for non-TLS connections or port `6380` for TLS connections.
-1. Whether the cache instance uses clustering - If you're using a Premium tier cache that uses clustering or an Enterprise/Enterprise Flash tier cache that is using OSS cluster policy, add the `-c`option to ensure all shards can be accessed.
+- **TLS**: By default, Azure Redis instances use [Transport Layer Security (TLS)](cache-remove-tls-10-11.md) encryption for connections. If the cache uses TLS, you must enable TLS for redis-cli by using the `--tls` option.
+- **Port**: Enterprise and Enterprise Flash tier caches use port `10000`. Basic, Standard, and Premium tier caches use either port `6379` for non-TLS connections or port `6380` for TLS connections.
+- **Clustering**: If you have a Premium tier cache that uses clustering, or an Enterprise or Enterprise Flash tier cache that uses OSS cluster policy, add the `-c`option to ensure all shards can be accessed.
 
-### Examples
+### Run the redis-cli connection command
 
-1. Use the following command to connect to a Basic, Standard, or Premium tier Azure Cache for Redis instance using TLS:
+Open a shell or terminal on a computer with the Redis package installed. On Windows, you can use WSL with [Windows Terminal](/windows/wsl/install#ways-to-run-multiple-linux-distributions-with-wsl) to open a Linux command line.
+Run one of the following command lines, depending on your TLS, port, and clustering options. Replace the `<cache name>` and `<access key>` placeholders with the values for your cache.
 
-    ```console
-    redis-cli -p 6380 -h yourcachename.redis.cache.windows.net -a YourAccessKey --tls
-    ```
+- Connect to a Basic, Standard, or Premium tier Azure Redis instance that uses TLS:
 
-1. Connect to a Basic, Standard, or Premium tier Azure Cache for Redis instance that doesn't use TLS:
+  ```console
+  redis-cli -p 6380 -h <cache name>.redis.cache.windows.net -a <access key> --tls
+  ```
 
-    ```console
-    redis-cli -p 6379 -h yourcachename.redis.cache.windows.net -a YourAccessKey
-    ```
+- Connect to a Basic, Standard, or Premium tier Azure Redis instance that doesn't use TLS:
 
-1. Connect to a Basic, Standard, or Premium tier Azure Cache for Redis instance using TLS and clustering:
+  ```console
+  redis-cli -p 6379 -h <cache name>.redis.cache.windows.net -a <access key>
+  ```
 
-    ```console
-    redis-cli -p 6380 -h yourcachename.redis.cache.windows.net -a YourAccessKey --tls -c
-    ```
+- Connect to a Basic, Standard, or Premium tier Azure Redis instance that uses TLS and clustering:
 
-1. Connect to an Enterprise or Enterprise Flash tier cache instance using Enterprise cluster policy with TLS:
+  ```console
+  redis-cli -p 6380 -h <cache name>.redis.cache.windows.net -a <access key> --tls -c
+  ```
 
-    ```console
-    redis-cli -p 10000 -h yourcachename.eastus.redisenterprise.cache.azure.net -a YourAccessKey --tls
-    ```
+- Connect to an Enterprise or Enterprise Flash tier cache instance that uses Enterprise cluster policy with TLS:
 
-1. Connect to an Enterprise or Enterprise Flash tier cache instance using  OSS cluster policy without TLS:
+  ```console
+  redis-cli -p 10000 -h <cache name>.eastus.redisenterprise.cache.azure.net -a <access key> --tls
+  ```
 
-    ```console
-    redis-cli -p 10000 -h yourcachename.eastus.redisenterprise.cache.azure.net -a YourAccessKey -c
-    ```
+- Connect to an Enterprise or Enterprise Flash tier cache instance that uses OSS cluster policy without TLS:
 
-### Testing the connection
+  ```console
+  redis-cli -p 10000 -h <cache name>.eastus.redisenterprise.cache.azure.net -a <access key> -c
+  ```
 
-Once the connection is established, you can issue commands to your Azure Cache for Redis instance. One easy way to test the connection is to use the [`PING`](https://redis.io/commands/ping/) command. This command returns `PONG` in the console.
+You're now connected to your Azure Redis cache using redis-cli.
 
-```output
-yourcachename.redis.cache.windows.net:6380> PING
+## Use redis-cli commands with your cache
+
+Once you establish the connection, you can issue commands to your Azure Redis instance. One easy way to test the connection is to use the [`PING`](https://redis.io/commands/ping/) command. The following command returns `PONG` in the console.
+
+```console
+<cache name>.redis.cache.windows.net:6380> PING
 PONG
 ```
 
-You can also run commands like `SET` and `GET`:
+You can also run commands like `SET` and `GET`.
 
-```output
-yourcachename.redis.cache.windows.net:6380> SET hello world
+```console
+<cache name>.redis.cache.windows.net:6380> SET hello world
 OK
-yourcachename.redis.cache.windows.net:6380> GET hello
+<cache name>.redis.cache.windows.net:6380> GET hello
 "world"
 ```
 
-You're now connected to your Azure Cache for Redis instance using the _redis-cli_.
-
-## redis-cli alternatives
+## Alternatives to redis-cli
 
-While the _redis-cli_ is a useful tool, you can connect to your cache in other ways for troubleshooting or testing:
+You can also connect to your cache in the following other ways for troubleshooting or testing:
 
 - Azure Cache for Redis offers a [Redis Console](cache-configure.md#redis-console) built into the Azure portal where you can issue commands without needing to install the command-line tool. The Redis Console feature is currently only available in the Basic, Standard, and Premium tiers.
-- [RedisInsight](https://redis.io/insight/) is a rich open source graphical tool for issuing Redis commands and viewing the contents of a Redis instance. It works with Azure Cache for Redis and is supported on Linux, Windows, and macOS.
+- [RedisInsight](https://redis.io/insight/) is a rich open-source graphical tool for issuing Redis commands and viewing the contents of a Redis instance. RedisInsight works with Azure Cache for Redis and is supported on Linux, Windows, and macOS.
 
 ## Related content
 
-Get started by creating a [new Enterprise-tier cache](quickstart-create-redis-enterprise.md) instance.
+Get started by creating a [new Enterprise-tier cache](quickstart-create-redis-enterprise.md).

articles/azure-cache-for-redis/includes/media/redis-cache-access-keys/redis-cache-hostname-ports.png

@@ -1,17 +1,19 @@
 ---
-ms.date: 08/16/2024
+ms.date: 04/04/2025
 ms.topic: include
 ms.custom: ignite-2024
 ---
 
-### Retrieve host name, ports, and access keys from the Azure portal
+### Get cache host name, ports, and access keys from the Azure portal
 
-To connect your Azure Cache for Redis server, the cache client needs the host name, ports, and a key for the cache. Some clients might refer to these items by slightly different names. You can get the host name, ports, and keys from the [Azure portal](https://portal.azure.com).
+To connect to your Azure Redis cache, the cache client needs the cache host name, port, and keys. Some clients might refer to these items by slightly different names. Follow these instructions to get the cache host name, port, and keys from the [Azure portal](https://portal.azure.com).
 
-- To get the host name and ports for your cache, select **Overview** from the **Resource** menu. The host name is of the form `<DNS name>.redis.cache.windows.net`.
+- Copy the host name and port from the cache **Overview** page in the portal. The host name is of the form `<cache name>.redis.cache.windows.net`.
 
-  :::image type="content" source="media/redis-cache-access-keys/redis-cache-hostname-ports.png" alt-text="Screenshot showing Azure Cache for Redis properties.":::
+  :::image type="content" source="media/redis-cache-access-keys/redis-cache-hostname-ports.png" alt-text="Screenshot showing Azure Redis cache properties.":::
 
-- To get the access keys, select **Authentication** from the **Resource** menu. Then, select the **Access keys** tab.
+- To get the access keys, select **Show access keys** on the **Overview** page. The **CacheKeys** pane shows the keys.
 
-  :::image type="content" source="media/redis-cache-access-keys/redis-cache-keys.png" alt-text="Screenshot showing Azure Cache for Redis access keys.":::
+  You can also select **Authentication** under **Settings** in the left navigation menu, and then select the **Access keys** tab.
+
+  :::image type="content" source="media/redis-cache-access-keys/redis-cache-keys.png" alt-text="Screenshot showing Azure Redis cache access keys.":::