クイック スタート:Node.js で Azure Cache for Redis を使用するQuickstart: Use Azure Cache for Redis with Node.js

このクイック スタートでは、Azure 内の任意のアプリケーションからアクセスできるセキュリティで保護された専用キャッシュにアクセスするために、Azure Cache for Redis を Node.js アプリに組み込みます。In this quickstart, you incorporate Azure Cache for Redis into a Node.js app to have access to a secure, dedicated cache that is accessible from any application within Azure.

前提条件Prerequisites

他の 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

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

    新しい Azure Cache for Redis メニュー

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

    SettingSetting 推奨値Suggested value 説明Description
    DNS 名DNS name グローバルに一意の名前Globally unique name キャッシュ名。The cache name. 1 から 63 文字の文字列で、数字、英字、- 文字のみを使用する必要があります。It 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 Cache for Redis インスタンスが作成されるサブスクリプション。The subscription under which this new Azure Cache for Redis instance 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 deletes all resources that are associated with the app.
    LocationLocation East USEast 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 that are available for the cache. 詳細については、Azure Cache for Redis の概要に関するページを参照してください。For more information, see Azure Cache for Redis Overview.
    ダッシュボードにピン留めするPin to dashboard オンSelected 新しいキャッシュをダッシュボードにピン留めし、簡単に見つけられるようにします。Pin the new cache to your dashboard to make it easy to find.

    Azure Cache for Redis を作成する

  3. 新しいキャッシュ設定を構成したら、 [作成] を選択します。After the new cache settings are configured, select 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, it shows the status Running, and is ready for use.

    Azure Cache for Redis が作成された

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

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

アクセス キーおよびホスト名を取得するにはTo retrieve the access keys and host name

  1. Azure portal を使用してアクセス キーを取得するには、キャッシュに移動して、 [アクセス キー] を選択します。To retrieve the access keys by using the Azure portal, go to your cache and select Access keys.

    Azure Cache for Redis のキー

  2. ホスト名とポートを取得するには、 [プロパティ] を選択します。To retrieve the host name and ports, select Properties.

    Azure Cache for Redis のプロパティ

[ホスト名][プライマリ] アクセス キーの環境変数を追加します。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 Cache for Redis への接続をサポートしています。The latest builds of node_redis provide support for connecting to Azure Cache for Redis using SSL. 次の例では、SSL エンドポイント 6380 を使用して Azure Cache for Redis に接続する方法を示しています。The following example shows how to connect to Azure Cache for Redis 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 Cache for Redis のインスタンスに接続する方法を示しています。This code shows you how to connect to an Azure Cache for Redis 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 クライアントを使用する他の例については、https://redis.js.org/ を参照してください。For more examples of using Redis with the node_redis client, see https://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 Azure Cache for Redis 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!"));    

    // Demonstrate "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 portal にサインインし、 [リソース グループ] を選択します。Sign in to the Azure portal and select Resource groups.

[名前でフィルター] テキスト ボックスにリソース グループの名前を入力します。In the Filter by name text box, enter 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, select ... then Delete resource group.

削除

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

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

次の手順Next steps

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