クイック スタート: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, sign in to the Azure portal and select Create a resource.

    [リソースの作成] を選択します

  2. [新規] ページで、 [データベース] を選択し、 [Azure Cache for Redis] を選択します。On the New page, select Databases and then select Azure Cache for Redis.

    Azure Cache for Redis を選択する

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

    SettingSetting 推奨値Suggested value 説明Description
    DNS 名DNS name グローバルに一意の名前を入力します。Enter a globally unique name. キャッシュ名は 1 から 63 文字の文字列で、数字、英字、ハイフンのみを使用する必要があります。The cache name must be a string between 1 and 63 characters that contains only numbers, letters, or hyphens. 名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。The name must start and end with a number or letter, and can't contain consecutive hyphens. キャッシュ インスタンスの "ホスト名" は、 <DNS name>.redis.cache.windows.net になります。Your cache instance's host name will be <DNS name>.redis.cache.windows.net.
    サブスクリプションSubscription ドロップダウンで、ご自身のサブスクリプションを選択します。Drop down and select your subscription. この新しい Azure Cache for Redis インスタンスが作成されるサブスクリプション。The subscription under which to create this new Azure Cache for Redis instance.
    リソース グループResource group ドロップ ダウンでリソース グループを選択するか、 [新規作成] を選択し、新しいリソース グループの名前を入力します。Drop down and select a resource group, or select Create new and enter a new resource group name. その中にキャッシュやその他のリソースを作成するリソース グループの名前。Name for the resource group in which to create your cache and other resources. すべてのアプリ リソースを 1 つのリソース グループに配置することで、それらをまとめて簡単に管理または削除できます。By putting all your app resources in one resource group, you can easily manage or delete them together.
    LocationLocation ドロップ ダウンで場所を選択します。Drop down and select a location. キャッシュを使用する他のサービスの近くのリージョンを選択します。Select a region near other services that will use your cache.
    [価格レベル]Pricing tier ドロップ ダウンで価格レベルを選択します。Drop down and select a Pricing tier. 価格レベルによって、キャッシュに使用できるのサイズ、パフォーマンス、および機能が決まります。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.
  4. 作成 を選択します。Select Create.

    Azure Cache for Redis を作成する

    キャッシュが作成されるまで、しばらく時間がかかります。It takes a while for the cache to create. Azure Cache for Redis の [概要] ページで進行状況を監視できます。You can monitor progress on the Azure Cache for Redis Overview page. [状態] に "実行中" と表示されている場合は、キャッシュを使用する準備ができています。When Status shows as Running, the cache is ready to use.

    Azure Cache for Redis が作成された

Azure portal からホスト名、ポート、アクセス キーを取得するRetrieve host name, ports, and access keys from the Azure portal

Azure Cache for Redis のインスタンスに接続するには、キャッシュ クライアントにキャッシュのホスト名、ポート、およびキーが必要です。To connect 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 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 のキー

  • ホスト名とポートを取得するには、キャッシュの左側のナビゲーションから [プロパティ] を選択します。To get the host name and ports, from your cache left navigation, select Properties. ホスト名は、 <DNS 名>.redis.cache.windows.net の形式になります。The host name is of the form <DNS name>.redis.cache.windows.net.

    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.

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

リソースのクリーンアップ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.

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

リソース グループの削除の確認を求めるメッセージが表示されます。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.