快速入門：在 Node.js 中使用 Azure Redis

發行項
12/19/2024

在本快速入門中，您會將 Azure 受控 Redis（預覽版）或 Azure Cache for Redis 納入Node.js應用程式。應用程式可以存取可從 Azure 內的任何應用程式存取的安全專用快取。

必要條件

Azure 訂用帳戶 - 建立免費帳戶
Node.js安裝 - 若要安裝Node.js，請參閱在 Windows 上安裝Node.js，以取得如何在 Windows 電腦上安裝 Node 和 npm 的指示。

建立 Azure 受控 Redis （預覽）實例

若要建立 Azure 受控 Redis （預覽）實例，請登入 Azure 入口網站，然後選取 [建立資源]。
在 [ 新增 ] 頁面上的搜尋方塊中，輸入 Azure Cache for Redis。

在 [新的 Redis 快取] 頁面上，設定新快取的設定。

設定	選擇值	描述
訂用帳戶	下拉並選取您的訂用帳戶。	要在其中建立這個新 Azure 受控 Redis 實例的訂用帳戶。
資源群組	下拉並選取資源群組，或選取 [新建] 並輸入新的資源群組名稱。	用來建立快取和其他資源的資源群組名稱。將所有的應用程式資源放在一個資源群組中，您將可輕鬆地一併管理或刪除這些資源。
DNS 名稱	輸入區域中唯一的名稱。	當快取名稱與快取的區域名稱合併 (只包含數字、字母或連字號) 時，必須為介於 1 到 63 個字元之間的字串。（如果快取名稱長度少於 45 個字元，則應該適用於所有目前可用的區域。名稱必須以數位或字母開頭和結尾，且不能包含連續連字元。快取執行個體的主機名稱為 `\<DNS name\>.\<Azure region\>.redis.azure.net`。
地點	下拉並選取位置。	Azure 受控 Redis 可在選取的 Azure 區域中取得。
快取類型	下拉式清單並選取效能層級和快取大小。	層會決定 Redis 實例的效能，而快取大小會決定可用來儲存數據的記憶體。如需選擇正確效能層級的指引，請參閱選擇正確的層

顯示 [Azure 受控 Redis 基本] 索引標籤的螢幕快照。

選取 [下一步：網络] ，然後選取公用或私人端點。
選取 [下一步：進階]。

設定您要新增至實例的任何 Redis 模組。

根據預設，針對新的受控快取：
- Microsoft已啟用 Entra 識別碼。
- 基於安全性考慮，存取金鑰驗證 已停用。
重要

為了獲得最佳安全性，建議您盡可能使用 Microsoft Entra ID 搭配受控識別來授權對快取的要求。使用 Microsoft Entra ID 和受控識別進行授權，提供比共用存取金鑰授權更優異的安全性和易用性。如需搭配快取使用受控識別的詳細資訊，請參閱使用 Microsoft Entra ID 進行快取驗證 (部分機器翻譯)。

將 [叢集原則] 設定為 [企業]，以用於非叢集快取，或設定為叢集快取的 OSS。 如需選擇 叢集原則的詳細資訊，請參閱叢集原則。

如果您使用 主動式異地複寫，則必須在建立期間加以設定。如需詳細資訊，請參閱設定 Azure 受控 Redis 實例的作用中異地複寫。

重要

建立 Azure 受控 Redis 實例之後，您無法變更叢集原則。如果您使用 RediSearch，則需要企業叢集原則，而且 NoEviction 是唯一支援的收回原則。

重要

如果您在異地復寫群組中使用這個快取實例，在建立實例之後就無法變更收回原則。建立快取之前，請務必了解主要節點的收回原則。如需主動式異地復寫的詳細資訊，請參閱作用中異地復寫必要條件。

重要

建立快取實例之後，您無法變更模組。您必須在建立 Azure Cache for Redis 執行個體時啟用模組。建立快取之後，沒有選項可啟用模組的設定。
選取 [下一步：標記] 並略過。
完成時，選取 [下一步:檢閱 + 建立]。
檢閱設定並選取 [建立]。

Redis 實例需要幾分鐘的時間才能建立。您可以在 Azure 受控 Redis 概觀頁面上監視進度。當 [狀態] 顯示為 [執行中] 時，表示快取已可供使用。

建立 Azure Cache for Redis 執行個體

若要建立快取，請登入 Azure 入口網站。在入口網站功能表中，選取 [建立資源]。
在 [開始使用] 窗格中，於搜尋列中輸入「Azure Cache for Redis」。在搜尋結果中，尋找「Azure Cache for Redis」，然後選取 [建立]。

在 [新增 Azure Cache for Redis] 窗格的 [基本] 索引標籤上，為您的快取設定下列設定：

設定	動作	描述
訂用帳戶	選取 Azure 訂閱。	用於建立新 Azure Cache for Redis 執行個體的訂用帳戶。
資源群組	選取資源群組，或選取 [新建] 並輸入新的資源群組名稱。	用來建立快取和其他資源的資源群組名稱。將所有的應用程式資源放在一個資源群組中，您將可輕鬆地一併管理或刪除這些資源。
DNS 名稱	輸入唯一名稱。	快取名稱必須是 1 到 63 個字元的字串，且只能包含數字、字母和連字號。名稱的開頭和結尾必須是數字或字母，且不可包含連續的連字號。快取執行個體的主機名稱為 `\<DNS name>.redis.cache.windows.net`。
地點	選取位置。	靠近使用您快取其他服務的 Azure 區域。
快取 SKU	選取 [SKU]。	快取的可用大小、效能和功能參數取決於 SKU。如需詳細資訊，請參閱 Azure Cache for Redis 概觀。
快取大小	選取快取大小。	如需詳細資訊，請參閱 Azure Cache for Redis 概觀。

選取 [網路] 索引標籤，或選取 [下一步: 網路]。
在 [網路] 索引標籤上，選取要用於快取的連線方法。
選取 [進階] 索引標籤，或選取 [下一步: 進階]。
在 [進階] 窗格中，根據下列資訊驗證或選取驗證方法：
- 根據預設，對於新的基本、標準或進階快取，會啟用 Microsoft Entra 驗證並停用存取金鑰驗證。
- 對於基本或標準快取，您可以選擇非 TLS 連接埠的選取項目。
- 對於標準和進階快取，您可以選擇啟用可用性區域。您無法在建立快取後停用可用性區域。
- 針對進階快取，設定適用於非 TLS 連接埠、叢集、受控識別和資料持續性的設定。
重要

為了獲得最佳安全性，建議您盡可能使用 Microsoft Entra ID 搭配受控識別來授權對快取的要求。使用 Microsoft Entra ID 和受控識別進行授權，提供比共用存取金鑰授權更優異的安全性和易用性。如需搭配快取使用受控識別的詳細資訊，請參閱使用 Microsoft Entra ID 進行快取驗證 (部分機器翻譯)。
(選用) 選取 [標籤] 索引標籤，或選取 [下一步: 標籤]。
(選用) 如果您想要分類快取資源，請在 [標籤] 索引標籤上輸入標籤名稱和值。
選取 [檢閱 + 建立] 按鈕。

在 [檢閱 + 建立] 索引標籤上，Azure 會自動驗證您的設定。
出現綠色的 [通過驗證] 訊息之後，請選取 [建立]。

新的快取部署會在幾分鐘內進行。您可以在 Azure Cache for Redis 概觀窗格上監視部署進度。當 [狀態] 顯示 [執行中] 時，表示快取已可供使用。

安裝 node-redis 用戶端程式庫

node-redis 程式庫是 Redis 的主要 Node.js 用戶端。您可以使用下列命令安裝具有 npm 的用戶端：

npm install redis

建立 Node.js 應用程式以存取快取

建立Node.js應用程式，該應用程式會使用 Microsoft Entra 識別碼或存取密鑰來連線到 Azure 受控 Redis （預覽）實例。建議您使用 Microsoft Entra ID。

Microsoft Entra 驗證 (建議)
存取金鑰驗證

在快取上使用Microsoft Entra ID 驗證

除了 Enterprise 和 Enterprise Flash 層之外，Azure Redis 快取預設會啟用 entra Authentication Microsoft。預設會停用存取金鑰。

重要

Microsoft建議使用 Microsoft Entra ID 驗證，以取得最安全的驗證體驗，而不是使用密碼或存取密鑰。本文這一節中所述的驗證會使用存取密鑰，這需要在應用程式中高度信任，而且在使用 Microsoft Entra ID 時不會帶來風險。只有當Microsoft Entra ID 驗證無法運作時，才使用本檔中的方法。

在 Azure 入口網站中，選取您想要使用 Microsoft Entra 令牌型驗證的快取。
從 [資源] 功能表中選取 [驗證]。
選取 [ 選取成員 ]，然後輸入有效用戶的名稱。當您選取 [儲存] 時，您輸入的使用者預設會自動獲指派「資料擁有者存取原則」。您也可以輸入受控識別或服務主體，以連線到快取執行個體。

如需搭配 Azure CLI 使用 Microsoft Entra ID 的詳細資訊，請參閱身分識別的參考頁面。

安裝 JavaScript Azure 身分識別用戶端程式庫

Microsoft 驗證程式庫 (MSAL) 可讓您從 Microsoft 身分識別取得安全性權杖，以驗證使用者。您可使用透過 MSAL 提供權杖驗證支援的 Python Azure 身分識別用戶端程式庫。使用 npm 來安裝此程式庫：

npm install @azure/identity

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

為您的主機名稱和服務主體識別碼新增環境變數，這是您的 Microsoft Entra ID 服務主體或使用者的物件識別碼。在 Azure 入口網站中，尋找 [用戶名稱]。
```
set AZURE_MANAGED_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
建立名為 redistest.js 的新指令檔。

在檔案中新增下列 JavaScript 範例。此程式代碼會示範如何使用快取主機名和密鑰環境變數來連線到 Azure 受控 Redis 實例。此程式碼也會將字串值儲存到快取中，以及擷取其中的字串值。 PING 和 CLIENT LIST 命令也會執行。如需更多搭配使用 Redis 與 node_redis 用戶端的範例，請參閱 https://redis.js.org/。

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_MANAGED_REDIS_HOST_NAME}:10000`,
    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_MANAGED_REDIS_HOST_NAME}:10000`,
     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_MANAGED_REDIS_HOST_NAME}:10000`,
           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

注意

如需使用 Microsoft Entra ID 與 node-redis 程式庫向 Redis 進行驗證的其他範例，請參閱此 GitHub 存放庫

重要

從 Azure 入口網站擷取主機名稱、連接埠和存取金鑰

若要連線 Azure Cache for Redis 伺服器，快取用戶端需要快取的主機名稱、連接埠和金鑰。某些用戶端可能會以稍有不同的名稱來參考這些項目。您可以從 Azure 入口網站取得主機名稱、連接埠和金鑰。

若要取得存取金鑰，請從 [資源] 功能表中選取 [驗證]。然後，選取 [存取金鑰] 索引標籤。
若要取得快取的主機名稱和連接埠，請從 [資源] 功能表選取 [概觀]。主機名稱的格式為 <DNS 名稱>.redis.cache.windows.net。

為主機名稱和主要存取金鑰新增環境變數。請從程式碼使用這些變數，而不是直接在程式碼中包含敏感性資訊。

set AZURE_MANAGED_REDIS_HOST_NAME=contosoCache
set AZURE_MANAGED_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

連線到快取

注意

請勿對程式碼中的每個作業建立新連線。相反地，請盡可能重複使用連線。

建立新的 Node.js 應用程式

建立名為 redistest.js 的新指令檔。

在檔案中新增下列 JavaScript 範例。

const redis = require("redis");

// Environment variables for cache
const cacheHostName = process.env.AZURE_MANAGED_REDIS_HOST_NAME;
const cachePassword = process.env.AZURE_MANAGED_REDIS_ACCESS_KEY;

if(!cacheHostName) throw Error("AZURE_MANAGED_REDIS_HOST_NAME is empty")
if(!cachePassword) throw Error("AZURE_MANAGED_REDIS_ACCESS_KEY is empty")

async function testCache() {

    // Connection configuration
    const cacheConnection = redis.createClient({
        // redis for TLS
        url: `redis://${cacheHostName}:10000`,
        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 用戶端的範例，請參閱 https://redis.js.org/。

使用 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

建立 Node.js 應用程式以存取快取

建立 Node.js 應用程式，以使用 Microsoft Entra ID 或存取金鑰連線至 Azure Cache for Redis。建議您使用 Microsoft Entra ID。

Microsoft Entra 驗證 (建議)
存取金鑰驗證

在快取上使用Microsoft Entra ID 驗證

除了 Enterprise 和 Enterprise Flash 層之外，Azure Redis 快取預設會啟用 entra Authentication Microsoft。預設會停用存取金鑰。

重要

在 Azure 入口網站中，選取您想要使用 Microsoft Entra 令牌型驗證的快取。
從 [資源] 功能表中選取 [驗證]。
選取 [ 選取成員 ]，然後輸入有效用戶的名稱。當您選取 [儲存] 時，您輸入的使用者預設會自動獲指派「資料擁有者存取原則」。您也可以輸入受控識別或服務主體，以連線到快取執行個體。

如需搭配 Azure CLI 使用 Microsoft Entra ID 的詳細資訊，請參閱身分識別的參考頁面。

安裝 JavaScript Azure 身分識別用戶端程式庫

npm install @azure/identity

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

為您的主機名稱和服務主體識別碼新增環境變數，這是您的 Microsoft Entra ID 服務主體或使用者的物件識別碼。在 Azure 入口網站中，尋找 [用戶名稱]。
```
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 用戶端的範例，請參閱 https://redis.js.org/。

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

注意

如需使用 Microsoft Entra ID 與 node-redis 程式庫向 Redis 進行驗證的其他範例，請參閱此 GitHub 存放庫

從 Azure 入口網站擷取主機名稱、連接埠和存取金鑰

若要取得存取金鑰，請從 [資源] 功能表中選取 [驗證]。然後，選取 [存取金鑰] 索引標籤。
若要取得快取的主機名稱和連接埠，請從 [資源] 功能表選取 [概觀]。主機名稱的格式為 <DNS 名稱>.redis.cache.windows.net。

為主機名稱和主要存取金鑰新增環境變數。請從程式碼使用這些變數，而不是直接在程式碼中包含敏感性資訊。

set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set AZURE_CACHE_FOR_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

連線到快取

注意

請勿對程式碼中的每個作業建立新連線。相反地，請盡可能重複使用連線。

建立新的 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));

使用 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 入口網站，然後選取 [資源群組]。
選取您想要刪除的資源群組。

如果有許多資源群組，請使用 [篩選任何欄位] 方塊，並輸入您針對本文所建立資源群組的名稱。選取結果清單中的資源群組。
選取 [刪除資源群組]。
系統將會要求您確認是否刪除資源群組。輸入您的資源群組名稱以進行確認，然後選取 [刪除]。

不久後，系統便會刪除該資源群組及其所有的資源。

取得範例程式碼

在 GitHub 上取得 Node.js 快速入門。

在本快速入門中，您已瞭解如何從Node.js應用程式使用 Azure 受控 Redis（預覽版）或 Azure Cache for Redis。深入瞭解 Azure Redis 供應專案：

共用方式為

快速入門：在 Node.js 中使用 Azure Redis

必要條件

建立 Azure 受控 Redis （預覽）實例

建立 Azure Cache for Redis 執行個體

安裝 node-redis 用戶端程式庫

建立 Node.js 應用程式以存取快取

在快取上使用Microsoft Entra ID 驗證

安裝 JavaScript Azure 身分識別用戶端程式庫

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

建立具有重新驗證功能的範例 JavaScript 應用程式

從 Azure 入口網站擷取主機名稱、連接埠和存取金鑰

連線到快取

建立新的 Node.js 應用程式

建立 Node.js 應用程式以存取快取

在快取上使用Microsoft Entra ID 驗證

安裝 JavaScript Azure 身分識別用戶端程式庫

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

建立具有重新驗證功能的範例 JavaScript 應用程式

從 Azure 入口網站擷取主機名稱、連接埠和存取金鑰

連線到快取

建立新的 Node.js 應用程式

清除資源

刪除資源群組

取得範例程式碼

意見反應

其他資源

共用方式為

快速入門：在 Node.js 中使用 Azure Redis

必要條件

建立 Azure 受控 Redis （預覽） 實例

建立 Azure Cache for Redis 執行個體

安裝 node-redis 用戶端程式庫

建立 Node.js 應用程式以存取快取

在快取上使用Microsoft Entra ID 驗證

安裝 JavaScript Azure 身分識別用戶端程式庫

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

建立具有重新驗證功能的範例 JavaScript 應用程式

建立 Node.js 應用程式以存取快取

在快取上使用Microsoft Entra ID 驗證

安裝 JavaScript Azure 身分識別用戶端程式庫

使用 Microsoft Entra ID 建立新的 Node.js 應用程式

建立具有重新驗證功能的範例 JavaScript 應用程式

清除資源

刪除資源群組

取得範例程式碼

相關內容

意見反應

其他資源

建立 Azure 受控 Redis （預覽）實例