クイックスタート: Node.js アプリで Azure Cache for Redis を使用する

[アーティクル]
10/16/2024

このクイックスタートでは、Azure 内の任意のアプリケーションからアクセスできる安全な専用キャッシュにアクセスするために、Azure Cache for Redis を Node.js アプリに組み込みます。

前提条件

Azure サブスクリプション。無料で作成できます
Node.js がインストールされていること。 Windows コンピューターに Node と npm をインストールする方法については、「Windows に Node.js をインストールする」をご覧ください。

キャッシュの作成

キャッシュを作成するには、Azure portal にサインインします。ポータルのメニューで、[リソースの作成] を選びます。
[作業の開始] ペインの検索バーに「Azure Cache for Redis」と入力します。検索結果で Azure Cache for Redis を見つけて、[作成] を選びます。

[新しい Redis Cache] ペインの [基本] タブで、以下のキャッシュの設定を構成します。

設定	アクション	説明
サブスクリプション	Azure サブスクリプションを選択します。	Azure Cache for Redis の新しいインスタンスの作成に使うサブスクリプション。
リソースグループ	リソースグループを選択するか、 [新規作成] を選択し、新しいリソースグループの名前を入力します。	キャッシュや他のリソースを作成するリソースグループの名前。すべてのアプリリソースを 1 つのリソースグループに配置することで、それらをまとめて簡単に管理または削除できます。
DNS 名	一意の名前を入力します。	キャッシュ名は、数字、英字、ハイフンのみを含む 1 から 63 文字の文字列とする必要があります。名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。キャッシュインスタンスの "ホスト名" は `\<DNS name>.redis.cache.windows.net` です。
場所	場所を選択します。	キャッシュを使う他のサービスに近い Azure リージョン。
キャッシュ SKU	SKU を選びます。	SKU によって、キャッシュに利用できるサイズ、パフォーマンス、機能のパラメーターが決まります。詳細については、Azure Cache for Redis の概要に関するページを参照してください。
キャッシュサイズ	キャッシュサイズを選びます。	詳細については、Azure Cache for Redis の概要に関するページを参照してください。

[ネットワーク] タブを選ぶか、[次へ: ネットワーク] を選びます。
[ネットワーク] タブで、キャッシュに使う接続方法を選びます。
[詳細] タブを選ぶか、[次へ: 詳細] を選びます。
[詳細] ペインで、以下の情報に基づいて認証方法を確認または選択します。
- 既定では、新しい Basic、Standard、または Premium キャッシュでは、Microsoft Entra 認証が有効になり、アクセスキー認証が無効になります。
- Basic または Standard キャッシュの場合は、非 TLS ポートを選択できます。
- Standard および Premium キャッシュの場合は、可用性ゾーンを有効にすることを選択できます。キャッシュの作成後に可用性ゾーンを無効にすることはできません。
- Premium キャッシュを利用する場合は、非 TLS ポート、クラスタリング、マネージド ID、データ永続化の設定を構成します。
重要

最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセスキーの認可より、セキュリティと使いやすさの点で優れています。キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証での Microsoft Entra ID の使用に関する記事をご覧ください。
(省略可能) [タグ] タブを選ぶか、[次へ: タグ] を選びます。
(省略可能) キャッシュリソースを分類する場合は、[タグ] タブでタグの名前と値を入力します。
[確認および作成] ボタンを選択します。

[確認と作成] タブでは、Azure によって構成が自動的に検証されます。
緑色の検証に成功のメッセージが表示された後、 [作成] を選択します。

新しいキャッシュのデプロイは数分で完了します。デプロイの進行状況は、Azure Cache for Redis の [概要] ペインで監視できます。 [状態] に [実行中] と表示されたら、キャッシュを使用できます。

node-redis クライアントライブラリをインストールする

node-redis ライブラリは、主要な Redis 用 Node.js クライアントです。 npm と次のコマンドを使って、クライアントをインストールできます。

npm install redis

キャッシュにアクセスする Node.js アプリを作成する

Microsoft Entra ID またはアクセスキーを使って Azure Cache for Redis に接続する Node.js アプリを作成します。 Microsoft Entra ID を使うことをお勧めします。

Microsoft Entra ID 認証 (推奨)
アクセスキー認証

キャッシュで Microsoft Entra ID の認証を有効にする

キャッシュが既にある場合は、最初に Microsoft Entra 認証が有効になっているかどうかを確認します。そうでない場合は、次の手順のようにして、Microsoft Entra 認証を有効にします。アプリケーションでの認証には Microsoft Entra ID を使うことをお勧めします。

Azure portal で、Microsoft Entra トークンベースの認証を使用する対象の Azure Cache for Redis インスタンスを選択します。
サービスメニューの [設定] で、[認証] を選びます。
[認証] ペインで、[Microsoft Entra 認証を有効にする] チェックボックスがオンになっているかどうかを調べます。そうである場合は、次のセクションに進むことができます。
そうでない場合は、[Microsoft Entra 認証を有効にする] チェックボックスをオンにします。次に、有効なユーザーの名前を入力します。 [保存] を選択します。入力したユーザー名には、データ所有者アクセスポリシーが自動的に割り当てられます。

マネージド ID またはサービスプリンシパルを入力して、キャッシュに接続することもできます。
ダイアログボックスで、構成を更新するかどうかが確認され、更新の完了には数分かかることが通知されます。 [はい] を選択します。

重要

有効化の操作が完了すると、キャッシュ内のノードが再起動して新しい構成が読み込まれます。この操作は、標準メンテナンス期間中またはピーク営業時間外に実行することをお勧めします。このプロセスには、最大で 30 分かかることがあります。

Azure CLI での Microsoft Entra ID の使用については、ID のリファレンスページをご覧ください。

JavaScript 用 Azure ID クライアントライブラリをインストールする

JavaScript 用 Azure ID クライアントライブラリは、必要な Microsoft 認証ライブラリ (MSAL) を使ってトークン認証のサポートを提供します。 npm を使ってライブラリをインストールします。

npm install @azure/identity

Microsoft Entra ID を使用して Node.js アプリを作成する

ホスト名とサービスプリンシパル ID 用の環境変数を追加します。

サービスプリンシパル ID は、Microsoft Entra ID サービスプリンシパルまたはユーザーのオブジェクト ID です。 Azure portal では、この値は [ユーザー名] として表示されます。
```
set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
redistest.js という名前のスクリプトファイルを作成します。

次の例の JavaScript をファイルに追加します。このコードでは、キャッシュのホスト名とキーの環境変数を使って Azure Cache for Redis インスタンスに接続する方法を示します。コードでは、キャッシュ内の文字列値の格納および取得も行います。 PING および CLIENT LIST コマンドも実行されます。 Redis と node-redis クライアントの他の使用例については、「Node-Redis」を参照してください。

const { createClient } = require("redis");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // Construct a Token Credential from Identity library, e.g. ClientSecretCredential / ClientCertificateCredential / ManagedIdentityCredential, etc.
  const credential = new DefaultAzureCredential();
  const redisScope = "https://redis.azure.com/.default";

  // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
  let accessToken = await credential.getToken(redisScope);
  console.log("access Token", accessToken);

  // Create redis client and connect to the Azure Cache for Redis over the TLS port using the access token as password.
  const cacheConnection = createClient({
    username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
    password: accessToken.token,
    url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
    pingInterval: 100000,
    socket: { 
      tls: true,
      keepAlive: 0 
    },
  });

  cacheConnection.on("error", (err) => console.log("Redis Client Error", err));
  await cacheConnection.connect();

  // PING command
  console.log("\nCache command: PING");
  console.log("Cache response : " + await cacheConnection.ping());

  // SET
  console.log("\nCache command: SET Message");
  console.log("Cache response : " + await cacheConnection.set("Message",
      "Hello! The cache is working from Node.js!"));

  // GET
  console.log("\nCache command: GET Message");
  console.log("Cache response : " + await cacheConnection.get("Message"));

  // Client list, useful to see if connection list is growing...
  console.log("\nCache command: CLIENT LIST");
  console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));

  cacheConnection.disconnect();

  return "Done"
}

main().then((result) => console.log(result)).catch(ex => console.log(ex));

Node.js を使ってスクリプトを実行します。
```
node redistest.js
```

コードの出力が次の例のようになることを確認します。

Cache command: PING
Cache response : PONG

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: SET Message
Cache response : OK

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: CLIENT LIST
Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

Done

再認証を含むサンプル JavaScript アプリを作成する

Microsoft Entra ID アクセストークンの有効期間は限られており、約 75 分です。キャッシュへの接続を維持するには、トークンを更新する必要があります。

この例では、JavaScript を使ってトークンを更新する方法を見ていきます。

redistestreauth.js という名前のスクリプトファイルを作成します。

次の例の JavaScript をファイルに追加します。

 const { createClient } = require("redis");
 const { DefaultAzureCredential } = require("@azure/identity");

 async function returnPassword(credential) {
     const redisScope = "https://redis.azure.com/.default";

     // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
     return credential.getToken(redisScope);
 }

 async function main() {
   // Construct a Token Credential from Identity library, e.g. ClientSecretCredential / ClientCertificateCredential / ManagedIdentityCredential, etc.
   const credential = new DefaultAzureCredential();
   let accessToken = await returnPassword(credential);

   // Create redis client and connect to the Azure Cache for Redis over the TLS port using the access token as password.
   let cacheConnection = createClient({
     username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
     password: accessToken.token,
     url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
     pingInterval: 100000,
     socket: { 
       tls: true,
       keepAlive: 0 
     },
   });

   cacheConnection.on("error", (err) => console.log("Redis Client Error", err));
   await cacheConnection.connect();

   for (let i = 0; i < 3; i++) {
     try {
         // PING command
         console.log("\nCache command: PING");
         console.log("Cache response : " + await cacheConnection.ping());

         // SET
         console.log("\nCache command: SET Message");
         console.log("Cache response : " + await cacheConnection.set("Message",
             "Hello! The cache is working from Node.js!"));

         // GET
         console.log("\nCache command: GET Message");
         console.log("Cache response : " + await cacheConnection.get("Message"));

         // Client list, useful to see if connection list is growing...
         console.log("\nCache command: CLIENT LIST");
         console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));
       break;
     } catch (e) {
       console.log("error during redis get", e.toString());
       if ((accessToken.expiresOnTimestamp <= Date.now())|| (redis.status === "end" || "close") ) {
         await redis.disconnect();
         accessToken = await returnPassword(credential);
         cacheConnection = createClient({
           username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
           password: accessToken.token,
           url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
           pingInterval: 100000,
           socket: {
             tls: true,
             keepAlive: 0
           },
         });
       }
     }
   }
 }

 main().then((result) => console.log(result)).catch(ex => console.log(ex));

Node.js を使ってスクリプトを実行します。
```
node redistestreauth.js
```

出力が次の例のようになることを確認します。

 Cache command: PING
 Cache response : PONG

 Cache command: GET Message
 Cache response : Hello! The cache is working from Node.js!

 Cache command: SET Message
 Cache response : OK

 Cache command: GET Message
 Cache response : Hello! The cache is working from Node.js!

 Cache command: CLIENT LIST
 Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

Note

Microsoft Entra ID を使って node-redis ライブラリを介して Redis に対する認証を行う方法の他の例については、node-redis の GitHub リポジトリを参照してください。

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

キャッシュクライアントが Azure Cache for Redis サーバーに接続するには、キャッシュのホスト名、ポート、アクセスキーが必要です。一部のクライアントでは、これらの項目が少し異なる名前で呼ばれている場合があります。ホスト名、ポート、キーは Azure portal で取得できます。

キャッシュのアクセスキーを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューの [設定] で、[認証] を選びます。
3. [認証] ペインで、[アクセスキー] タブを選びます。
4. アクセスキーの値をコピーするには、キーフィールドの [コピー] アイコンを選びます。
キャッシュのホスト名とポートを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューで、[概要] を選びます。
3. [基本] の [ホスト名] で、[コピー] アイコンを選んでホスト名の値をコピーします。ホスト名の値の形式は <DNS name>.redis.cache.windows.net です。
4. [ポート] で、[コピー] アイコンを選んでポートの値をコピーします。

ホスト名とプライマリアクセスキーの環境変数を追加します。コードに機密情報を直接含める代わりに、これらの変数をコードから使用します。

set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set AZURE_CACHE_FOR_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

キャッシュに接続する

Note

コード内の操作ごとに新しい接続を作成しないでください。可能な限り接続を再利用してください。

新しい Node.js アプリを作成する

redistest.js という名前の新しいスクリプトファイルを作成します。

次の例の JavaScript をファイルに追加します。

const redis = require("redis");

// Environment variables for cache
const cacheHostName = process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME;
const cachePassword = process.env.AZURE_CACHE_FOR_REDIS_ACCESS_KEY;

if(!cacheHostName) throw Error("AZURE_CACHE_FOR_REDIS_HOST_NAME is empty")
if(!cachePassword) throw Error("AZURE_CACHE_FOR_REDIS_ACCESS_KEY is empty")

async function testCache() {

    // Connection configuration
    const cacheConnection = redis.createClient({
        // redis for TLS
        url: `redis://${cacheHostName}:6380`,
        password: cachePassword
    });

    // Connect to Redis
    await cacheConnection.connect();

    // PING command
    console.log("\nCache command: PING");
    console.log("Cache response : " + await cacheConnection.ping());

    // GET
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.get("Message"));

    // SET
    console.log("\nCache command: SET Message");
    console.log("Cache response : " + await cacheConnection.set("Message",
        "Hello! The cache is working from Node.js!"));

    // GET again
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.get("Message"));

    // Client list, useful to see if connection list is growing...
    console.log("\nCache command: CLIENT LIST");
    console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));

    // Disconnect
    cacheConnection.disconnect()

    return "Done"
}

testCache().then((result) => console.log(result)).catch(ex => console.log(ex));

このコードでは、キャッシュのホスト名とキーの環境変数を使って Azure Cache for Redis インスタンスに接続する方法を示します。コードでは、キャッシュ内の文字列値の格納および取得も行います。 PING および CLIENT LIST コマンドも実行されます。 Redis と node_redis クライアントの他の使用例については、「Node-Redis」を参照してください。

Node.js を使ってスクリプトを実行します。
```
node redistest.js
```

出力が次の例のようになることを確認します。

Cache command: PING
Cache response : PONG

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: SET Message
Cache response : OK

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: CLIENT LIST
Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

Done

リソースをクリーンアップする

この記事で作成したリソースを引き続き使用する場合は、リソースグループを保持します。

それ以外の場合、リソースに関連する課金が行われないようにするために、リソースの使用が終了したら、作成した Azure リソースグループを削除して構いません。

警告

リソースグループを削除すると、元に戻すことができません。リソースグループを削除すると、そのリソースグループ内のすべてのリソースは完全に削除されます。間違ったリソースグループやリソースをうっかり削除しないようにしてください。保持したいリソースを含む既存のリソースグループ内にリソースを作成した場合は、リソースグループを削除するのではなく、各リソースを個別に削除できます。

リソースグループを削除する

Azure portal にサインインし、 [リソースグループ] を選択します。
削除するリソースグループを選びます。

多数のリソースグループがある場合は、[任意フィールドのフィルター] に、この記事を完了するために作成したリソースグループの名前を入力します。検索結果の一覧で、リソースグループを選びます。
[リソースグループの削除] を選択します。
[リソースグループの削除] ペインで、リソースグループの名前を入力して確認した後、[削除] を選びます。

しばらくすると、リソースグループとそのリソースのすべてが削除されます。

サンプルコードを入手する

GitHub で Node.js クイックスタートのサンプルを入手してください。

Azure Cache for Redis を使用する ASP.NET Web アプリを作成する

次の方法で共有

クイックスタート: Node.js アプリで Azure Cache for Redis を使用する

前提条件

キャッシュの作成

node-redis クライアントライブラリをインストールする

キャッシュにアクセスする Node.js アプリを作成する

キャッシュで Microsoft Entra ID の認証を有効にする

JavaScript 用 Azure ID クライアントライブラリをインストールする

Microsoft Entra ID を使用して Node.js アプリを作成する

再認証を含むサンプル JavaScript アプリを作成する

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

キャッシュに接続する

新しい Node.js アプリを作成する

リソースをクリーンアップする

リソースグループを削除する

サンプルコードを入手する

フィードバック

その他のリソース

次の方法で共有

クイック スタート: Node.js アプリで Azure Cache for Redis を使用する

前提条件

キャッシュの作成

node-redis クライアント ライブラリをインストールする

キャッシュにアクセスする Node.js アプリを作成する

キャッシュで Microsoft Entra ID の認証を有効にする

JavaScript 用 Azure ID クライアント ライブラリをインストールする

Microsoft Entra ID を使用して Node.js アプリを作成する

再認証を含むサンプル JavaScript アプリを作成する

リソースをクリーンアップする

リソース グループを削除する

サンプル コードを入手する

関連するコンテンツ

フィードバック

その他のリソース

クイックスタート: Node.js アプリで Azure Cache for Redis を使用する

node-redis クライアントライブラリをインストールする

JavaScript 用 Azure ID クライアントライブラリをインストールする

リソースグループを削除する

サンプルコードを入手する