クイック スタート: Node.js で Azure Redis Cache を使用する方法Quickstart: How to use Azure Redis Cache with Node.js

Azure Redis Cache を使用すると、Microsoft が管理している、セキュリティで保護された専用 Redis Cache にアクセスできます。Azure Redis Cache gives you access to a secure, dedicated Redis cache, managed by Microsoft. キャッシュは、Microsoft Azure 内の任意のアプリケーションからアクセスできます。Your cache is accessible from any application within Microsoft Azure.

このトピックでは、Node.js を使用して Azure Redis Cache を使用する方法を説明しています。This topic shows you how to get started with Azure Redis Cache using Node.js.

このクイック スタートの手順は、任意のコード エディターを使用して実行できます。You can use any code editor to complete the steps in this quickstart. ただし、推奨のエディターは Visual Studio Code です (Windows、macOS、および Linux プラットフォームで使用できます)。However, Visual Studio Code is an excellent option available on the Windows, macOS, and Linux platforms.

完了したキャッシュ アプリ

Azure サブスクリプションをお持ちでない場合は、開始する前に 無料アカウント を作成してください。If you don't have an Azure subscription, create a free account before you begin.

前提条件Prerequisites

node_redis をインストールします。Install node_redis:

npm install redis

このチュートリアルでは、node_redis を使用します。This tutorial uses node_redis. 他の Node.js クライアントを使用する例については、 Node.js Redis クライアントに関するセクションに記載されている Node.js クライアントの個々のドキュメントを参照してください。For examples of using other Node.js clients, see the individual documentation for the Node.js clients listed at Node.js Redis clients.

キャッシュの作成Create a cache

キャッシュを作成するには、まず Azure Portal にサインインし、[リソースの作成] > [データベース] > [Redis Cache] の順にクリックします。To create a cache, first sign in to the Azure portal, and click Create a resource > Databases > Redis Cache.

新しいキャッシュ

[新規 Redis Cache] で、新しいキャッシュの設定を構成します。In New Redis Cache, configure the settings for your new cache.

SettingSetting 推奨値Suggested value [説明]Description
DNS 名DNS name グローバルに一意の名前Globally unique name キャッシュ名は 1 ~ 63 文字の文字列で、数字、英字、- 文字のみを使用する必要があります。The cache name must be a string between 1 and 63 characters and contain only numbers, letters, and the - character. キャッシュ名の先頭と末尾には - 文字を使用できません。また、連続する - 文字は無効です。The cache name cannot start or end with the - character, and consecutive - characters are not valid.
サブスクリプションSubscription 該当するサブスクリプションYour subscription この新しい Azure Redis Cache が作成されるサブスクリプション。The subscription under which this new Azure Redis Cache is created.
リソース グループResource Group TestResourcesTestResources その中にキャッシュを作成する新しいリソース グループの名前。Name for the new resource group in which to create your cache. アプリのすべてのリソースを 1 つのグループ内に配置することで、それらを一緒に管理できます。By putting all the resources for an app in a group, you can manage them together. たとえば、リソース グループを削除すれば、そのアプリに関連付けられているすべてのリソースが削除されます。For example, deleting the resource group would delete all resources associated with the app.
場所Location 米国東部East US キャッシュを使用する他のサービスの近くのリージョンを選択します。Choose a region near to other services that will use your cache.
価格レベルPricing tier Basic C0 (250 MB のキャッシュ)Basic C0 (250 MB Cache) 価格レベルによって、キャッシュのサイズ、パフォーマンス、および使用可能な機能が決まります。The pricing tier determines the size, performance, and features available for the cache. 詳細については、Azure Redis Cache の概要に関するページを参照してください。For more information, see Azure Redis Cache Overview.
ダッシュボードにピン留めするPin to dashboard オンSelected クリックすると、新しいキャッシュをダッシュ ボードにピン留めし、簡単に見つけられるようになります。Click pin the new cache to your dashboard making it easy to find.

キャッシュの作成

新しいキャッシュ設定を構成したら、[作成] をクリックします。Once the new cache settings are configured, click Create.

キャッシュが作成されるまで数分かかる場合があります。It can take a few minutes for the cache to be created. 状態を確認するには、ダッシュボードで進行状況を監視してください。To check the status, you can monitor the progress on the dashboard. キャッシュが作成されると、新しいキャッシュの状態が 実行中 になり、使用できるようになります。After the cache has been created, your new cache has a Running status and is ready for use.

作成されたキャッシュ

Azure Portal を使用して、ホスト名、ポート、およびアクセス キーを取得するRetrieve host name, ports, and access keys using the Azure Portal

Azure Redis Cache のインスタンスに接続するときには、キャッシュ クライアントにキャッシュのホスト名、ポート、およびキーが必要です。When connecting to an Azure Redis Cache instance, cache clients need the host name, ports, and a key for the cache. 一部のクライアントは、若干異なる名前で、これらの項目を参照できます。Some clients may refer to these items by slightly different names. この情報は、Azure Portal で取得できます。You can retrieve this information in the Azure portal.

Azure Portal を使用してアクセス キーを取得するには、キャッシュを参照して、[アクセス キー] をクリックします。To retrieve the access keys using the Azure portal, browse to your cache and click Access keys.

Redis Cache のキー

ホスト名やポートを取得するには、[プロパティ] をクリックします。To retrieve host name, ports, click Properties.

Redis cache properties

[ホスト名][プライマリ] アクセス キーの環境変数を追加します。Add environment variables for your HOST NAME and Primary access key. コードに機密情報を直接含める代わりに、これらの変数をコードから使用します。You will use these variables from your code instead of including the sensitive information directly in your code.

set REDISCACHEHOSTNAME=contosoCache.redis.cache.windows.net
set REDISCACHEKEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

キャッシュに接続するConnect to the cache

node_redis の最新のビルドでは、SSL を使用した Azure Redis Cache への接続をサポートしています。The latest builds of node_redis provide support for connecting to Azure Redis Cache using SSL. 次の例では、SSL エンドポイント 6380 を使用して Azure Redis Cache に接続する方法を示しています。The following example shows how to connect to Azure Redis Cache using the SSL endpoint of 6380.

var redis = require("redis");

// Add your cache name and access key.
var client = redis.createClient(6380, process.env.REDISCACHEHOSTNAME,
    {auth_pass: process.env.REDISCACHEKEY, tls: {servername: process.env.REDISCACHEHOSTNAME}});

コード内の操作ごとに新しい接続を作成せず、Don't create a new connections for each operation in your code. 可能な限り接続を再利用してください。Instead, reuse connections as much as possible.

新しい Node.js アプリを作成するCreate a new Node.js app

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

次の例の JavaScript をファイルに追加します。Add the following example JavaScript to the file. このコードは、キャッシュ ホスト名とキー環境変数を使用して Azure Redis Cache インスタンスに接続する方法を示しています。This code shows you how to connect to an Azure Redis Cache instance using the cache host name and key environment variables. コードでは、キャッシュ内の文字列値の格納および取得も行います。The code also stores and retrieves a string value in the cache. PING および CLIENT LIST コマンドも実行されます。The PING and CLIENT LIST commands are also executed. Redis と node_redis クライアントを使用する他の例については、http://redis.js.org/ を参照してください。For more examples of using Redis with the node_redis client, see http://redis.js.org/.

var redis = require("redis");
var bluebird = require("bluebird");

bluebird.promisifyAll(redis.RedisClient.prototype);
bluebird.promisifyAll(redis.Multi.prototype);

async function testCache() {

    // Connect to the Redis cache over the SSL port using the key.
    var cacheConnection = redis.createClient(6380, process.env.REDISCACHEHOSTNAME, 
        {auth_pass: process.env.REDISCACHEKEY, tls: {servername: process.env.REDISCACHEHOSTNAME}});

    // Perform cache operations using the cache connection object...

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

    // Simple get and put of integral data types into the cache
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.getAsync("Message"));    

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

    // Demostrate "SET Message" executed as expected...
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.getAsync("Message"));    

    // Get the client list, useful to see if connection list is growing...
    console.log("\nCache command: CLIENT LIST");
    console.log("Cache response : " + await cacheConnection.clientAsync("LIST"));    
}

testCache();

Node.js でスクリプトを実行します。Run the script with Node.js.

node redistest.js

次の例では、Message キーは、前に Azure portal の Redis コンソールを使って設定されたキャッシュ値を持っていたことがわかります。In the example below, you can see the Message key previously had a cached value, which was set using the Redis Console in the Azure portal. アプリは、そのキャッシュ値を更新しました。The app updated that cached value. また、アプリは PING および CLIENT LIST コマンドも実行しました。The app also executed the PING and CLIENT LIST commands.

完了したキャッシュ アプリ

リソースのクリーンアップClean up resources

次のチュートリアルに進む場合は、このクイック スタートで作成したリソースを維持して、再利用することができます。If you will be continuing to the next tutorial, you can keep the resources created in this quickstart and reuse them.

クイック スタートのサンプル アプリケーションの使用を終える場合は、課金を避けるために、このクイック スタートで作成した Azure リソースを削除することができます。Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.

重要

いったん削除したリソース グループを元に戻すことはできません。リソース グループとそこに存在するすべてのリソースは完全に削除されます。Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. 間違ったリソース グループやリソースをうっかり削除しないようにしてください。Make sure that you do not accidentally delete the wrong resource group or resources. このサンプルのホストとなるリソースを、保持するリソースが含まれている既存のリソース グループ内に作成した場合は、リソース グループを削除するのではなく、個々のブレードから各リソースを個別に削除することができます。If you created the resources for hosting this sample inside an existing resource group that contains resources you want to keep, you can delete each resource individually from their respective blades instead of deleting the resource group.

Azure ポータル にサインインし、 [リソース グループ] をクリックします。Sign in to the Azure portal and click Resource groups.

[名前でフィルター] ボックスにリソース グループの名前を入力します。In the Filter by name... textbox, type the name of your resource group. この記事の手順では、TestResources という名前のリソース グループを使用しました。The instructions for this article used a resource group named TestResources. 結果一覧でリソース グループの [...] をクリックし、[リソース グループの削除] をクリックします。On your resource group in the result list, click ... then Delete resource group.

削除

リソース グループの削除の確認を求めるメッセージが表示されます。You will be asked to confirm the deletion of the resource group. 確認のためにリソース グループの名前を入力し、[削除] をクリックします。Type the name of your resource group to confirm, and click Delete.

しばらくすると、リソース グループとそこに含まれているすべてのリソースが削除されます。After a few moments, the resource group and all of its contained resources are deleted.

次の手順Next steps

このクイック スタートでは、Node.js アプリから Azure Redis Cache を使用する方法を説明しました。In this quickstart, you learned how to use Azure Redis Cache from a Node.js application. ASP.NET Web アプリで Redis Cache を使用するには、次のクイック スタートに進みます。Continue to the next quickstart to use Redis Cache with an ASP.NET web app.