Use the Redis command-line tool with Azure Cache for Redis

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.

Gather cache access information

Note

We recommend that you use the Azure Az PowerShell module to interact with Azure. See Install Azure PowerShell to get started. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.

You can gather the information needed to access the cache using three methods:

  1. Azure CLI using az redis list-keys
  2. Azure PowerShell using Get-AzRedisCacheKey
  3. Using the Azure portal

In this section, you retrieve the keys from the Azure portal.

Retrieve 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.

  • To get the access keys, from your cache left navigation, select Access keys.

    Azure Cache for Redis keys

  • To get the host name and ports, from your cache left navigation, select Properties. The host name is of the form <DNS name>.redis.cache.windows.net.

    Azure Cache for Redis properties

Enable access for redis-cli.exe

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:

  1. 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.

  2. 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 of yourcachename.

    [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.

Connect using the Redis command-line tool.

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

Screenshot that shows that your connection to the cache is successful.

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

stunnel with redis-cli

Next steps

Learn more about using the Redis Console to issue commands.