title | description | author | ms.author | ms.service | ms.topic | ms.date | ms.custom |
---|---|---|---|---|---|---|---|
Use redis-cli with Azure Cache for Redis |
Learn how to use *redis-cli.exe* as a command-line tool for interacting with an Azure Cache for Redis as a client |
flang-msft |
franlanglois |
cache |
conceptual |
01/25/2022 |
devx-track-azurepowershell |
Use the popular redis-cli.exe
command-line tool to interact with an Azure Cache for Redis as a client. The tool is available for Windows platforms by downloading the Redis command-line tools for Windows.
If you want to run the command-line tool on another platform, download open-source Redis from https://redis.io/download.
[!INCLUDE updated-for-az]
You can gather the information needed to access the cache using three methods:
- Azure CLI using az redis list-keys
- Azure PowerShell using Get-AzRedisCacheKey
- Using the Azure portal
In this section, you retrieve the keys from the Azure portal.
[!INCLUDE redis-cache-create]
With Azure Cache for Redis, only the TLS port (6380) is enabled by default. The redis-cli.exe
command-line tool doesn't support TLS. You have two configuration choices to use it:
-
Enable the non-TLS port (6379) - This configuration is not recommended because in this configuration, the access keys are sent via TCP in clear text. This change can compromise access to your cache. The only scenario where you might consider this configuration is when you’re just accessing a test cache.
-
Download and install stunnel.
Run stunnel GUI Start to start the server.
Right-click the taskbar icon for the stunnel server and select Show Log Window.
On the stunnel Log Window menu, select Configuration > Edit Configuration to open the current configuration file.
Add the following entry for
redis-cli.exe
under the Service definitions section. Insert your actual cache name in place ofyourcachename
.[redis-cli] client = yes accept = 127.0.0.1:6380 connect = yourcachename.redis.cache.windows.net:6380
Save and close the configuration file.
On the stunnel Log Window menu, select Configuration > Reload Configuration.
When using stunnel, run redis-cli.exe
, and pass only your port, and access key (primary or secondary) to connect to the cache.
redis-cli.exe -p 6380 -a YourAccessKey
If you're using a test cache with the unsecure non-TLS port, run redis-cli.exe
and pass your host name, port, and access key (primary or secondary) to connect to the test cache.
redis-cli.exe -h yourcachename.redis.cache.windows.net -p 6379 -a YourAccessKey
Learn more about using the Redis Console to issue commands.