Azure Cache for Redis での Redis コマンドラインツールの使用

[アーティクル]
04/30/2024

redis-cli コマンドラインツールを使用して、クライアントとして Azure Cache for Redis を操作します。このツールを使用して、Azure Cache for Redis インスタンスを直接操作し、デバッグとトラブルシューティングを行います。

redis-cli をインストールする

redis-cli ツールは、複数のオペレーティングシステムで使用できる "Redis パッケージ" と共に自動的にインストールされます。お好みのオペレーティングシステムに関する最も詳細なドキュメントについては、オープンソースの Redis のインストールガイドを参照してください。

Linux

redis-cli は Linux 上でネイティブに実行されます。ほとんどのディストリビューションには、redis-cli ツールを含む "Redis パッケージ" が含まれています。たとえば、Ubuntu では、次のコマンドを使用して "Redis パッケージ" をインストールします。

sudo apt-get update
sudo apt-get install redis

Windows

Windows コンピューターで redis-cli を使用する最善の方法は、Linux 用 Windows サブシステム (WSL) をインストールすることです。 Linux サブシステムを使用すると、Windows 上で Linux ツールを直接実行できます。 WSL をインストールするには、WSL のインストール手順に従います。

WSL がインストールされたら、WSL 用に選択した Linux ディストリビューションで使用可能な任意のパッケージ管理を使って redis-cli をインストールできます。

キャッシュアクセス情報を収集する

次の方法を使用して、キャッシュにアクセスするために必要な情報を収集できます。

Azure CLI から az redis list-keys を使用する
Azure PowerShell から Get-AzRedisCacheKey を使用する
Azure ポータルの使用

このセクションでは､Azure portal からキーを取得します｡

Azure portal からホスト名、ポート、アクセスキーを取得する

Azure Cache for Redis サーバーに接続するには、キャッシュクライアントにキャッシュのホスト名、ポート、およびキーが必要です。クライアントによっては、これらの項目を参照するための名前が若干異なる場合があります。ホスト名、ポート、およびキーは Azure portal から取得できます。

アクセスキーを取得するには、[リソース] メニューから [認証] を選択します。その後、[アクセスキー] タブを選択します。
キャッシュのホスト名とポートを取得するには、[リソース] メニューから [概要] を選択します。ホスト名は、<DNS 名>.redis.cache.windows.net の形式になります。

redis-cli を使用して接続する

"Redis パッケージ" がインストールされているコンピューターでシェルまたはターミナルを開きます。 WSL を使用する場合は、Windows ターミナルを使って Linux コマンドラインを開くことができます。 redis-cli を使って接続する前に、次のことを確認します。

TLS アクセスが必要かどうか - 既定では、Azure Cache for Redis インスタンスでは接続に TLS 暗号化が使用されます。サーバー側で TLS が使用されている場合は常に、--tls オプションを使って redis-cli の TLS を有効にする必要があります。
使用されるポート - すべての Enterprise および Enterprise Flash レベルのキャッシュでポート 10000 が使われます。しかし、Basic、Standard、Premium レベルのキャッシュでは、TLS 以外の接続にはポート 6379 が、TLS 接続にはポート 6380 が使用されます。
キャッシュインスタンスでクラスタリングが使われているかどうか - クラスタリングを使用する Premium レベルのキャッシュ、または OSS クラスターポリシーを使っている Enterprise/Enterprise Flash レベルのキャッシュを使用している場合は、-c オプションを追加して、すべてのシャードに確実にアクセスできるようにします。

例

TLS を使って Basic、Standard、または Premium レベルの Azure Cache for Redis インスタンスに接続するには、次のコマンドを使用します。
```
redis-cli.exe -p 6380 -h yourcachename.redis.cache.windows.net -a YourAccessKey --tls
```
TLS を使用しない Basic、Standard、または Premium レベルの Azure Cache for Redis インスタンスに接続します。
```
redis-cli.exe -p 6379 -h yourcachename.redis.cache.windows.net -a YourAccessKey
```
TLS とクラスタリングを使用して、Basic、Standard、または Premium レベルの Azure Cache for Redis インスタンスに接続します。
```
redis-cli.exe -p 6380 -h yourcachename.redis.cache.windows.net -a YourAccessKey --tls -c
```
TLS を使って Enterprise クラスターポリシーを使用し、Enterprise または Enterprise Flash レベルのキャッシュインスタンスに接続します。
```
redis-cli.exe -p 10000 -h yourcachename.eastus.redisenterprise.cache.azure.net -a YourAccessKey --tls
```
TLS を使わずに OSS クラスターポリシーを使用し、Enterprise または Enterprise Flash レベルのキャッシュインスタンスに接続します。
```
redis-cli.exe -p 10000 -h yourcachename.eastus.redisenterprise.cache.azure.net -a YourAccessKey -c
```

接続のテスト

接続が確立されたら、Azure Cache for Redis インスタンスにコマンドを発行できます。接続をテストする簡単な方法の 1 つは、PING コマンドを使用することです。このコマンドでは、コンソールで PONG が返されます。

yourcachename.redis.cache.windows.net:6380> PING
PONG

SET や GET などのコマンドを実行することもできます。

yourcachename.redis.cache.windows.net:6380> SET hello world
OK
yourcachename.redis.cache.windows.net:6380> GET hello
"world"

これで、redis-cli を使用して Azure Cache for Redis インスタンスに接続できました。

redis-cli の代替手段

redis-cli は便利なツールですが、トラブルシューティングやテストのために他の方法でキャッシュに接続できます。

Azure Cache for Redis には、コマンドラインツールをインストールしなくてもコマンドを発行できる Azure portal に組み込まれた Redis コンソールが用意されています。 Redis コンソール機能は現在、Basic、Standard、Premium レベルでのみ使用できます。
RedisInsight は、Redis コマンドを発行し、Redis インスタンスの内容を表示するための豊富なオープンソースのグラフィカルツールです。 Azure Cache for Redis で動作し、Linux、Windows、macOS でサポートされています。

まず、新しい Enterprise レベルのキャッシュインスタンスを作成します。

Azure Cache for Redis での Redis コマンドライン ツールの使用

redis-cli をインストールする

Linux

Windows

キャッシュ アクセス情報を収集する

Azure portal からホスト名、ポート、アクセス キーを取得する