Краткое руководство. Использование Azure Redis в Node.js

Статья
11/19/2024

В этом кратком руководстве описано, как включить Управляемый Redis Azure (предварительная версия) или Кэш Azure для Redis в приложение Node.js. Приложение имеет доступ к защищенному выделенному кэшу, доступному из любого приложения в Azure.

Необходимые компоненты

Подписка Azure — создайте бесплатную учетную запись.
Node.js установлен . Чтобы установить Node.js, ознакомьтесь с инструкциями по установке узла и npm на компьютере Windows, см . статью "Установка Node.js в Windows ".

Создание экземпляра Управляемого Redis (предварительная версия) Azure

Чтобы создать экземпляр Управляемого Redis (предварительная версия) Azure, войдите в портал Azure и выберите "Создать ресурс".
На новой странице в поле поиска введите Кэш Azure для Redis.

На странице Новый кэш Redis настройте параметры для нового кэша.

Параметр	Выберите значение	Description
Подписка	Раскройте список и выберите нужную подписку.	Подписка, в которой создается новый экземпляр Управляемого Redis Azure.
Группа ресурсов	Раскройте список и выберите группу ресурсов или нажмите Создать и введите имя для новой группы ресурсов.	Имя группы ресурсов, в которой будут созданы кэш и другие ресурсы. Поместив все ресурсы приложения в одну группу ресурсов, вы сможете легко управлять ими и/или удалить их вместе.
DNS-имя	Введите уникальное в пределах региона имя.	Имя кэша должно быть строкой от 1 до 63 символов при сочетании с именем региона кэша, содержащим только цифры, буквы или дефисы. (Если имя кэша меньше 45 символов, оно должно работать во всех доступных регионах.) Имя должно начинаться и заканчиваться числом или буквой и не может содержать последовательные дефисы. Имя `\<DNS name\>.\<Azure region\>.redis.azure.net`узла экземпляра кэша .
Местонахождение	Откройте список и выберите расположение.	Управляемый Redis azure доступен в выбранных регионах Azure.
Тип кэша	В раскрывающемся списке выберите уровень производительности и размер кэша.	Уровень определяет производительность экземпляра Redis, а размер кэша определяет память, доступную для хранения данных. Рекомендации по выбору подходящего уровня производительности см. в разделе "Выбор нужного уровня"

Снимок экрана: вкладка

Нажмите кнопку "Далее" и выберите общедоступную или частную конечную точку.
Нажмите кнопку Далее: Дополнительно.

Настройте все модули Redis, которые вы хотите добавить в экземпляр.

По умолчанию для нового управляемого кэша:
- Идентификатор Microsoft Entra включен.
- Проверка подлинности ключей доступа отключена по соображениям безопасности.
Внимание

Для оптимальной безопасности рекомендуется использовать идентификатор Microsoft Entra с управляемыми удостоверениями для авторизации запросов к кэшу, если это возможно. Авторизация с помощью идентификатора Microsoft Entra и управляемых удостоверений обеспечивает более высокую безопасность и удобство использования при авторизации ключа общего доступа. Дополнительные сведения об использовании управляемых удостоверений с кэшем см. в разделе "Использование идентификатора Microsoft Entra для проверки подлинности кэша".

Задайте для политики кластеризации значение Enterprise для некластеризованного кэша или в OSS для кластеризованного кэша. Дополнительные сведения о выборе политики кластеризации см. в статье "Политика кластера".

Если вы используете активную георепликацию, ее необходимо настроить во время создания. Дополнительные сведения см. в разделе "Настройка активной георепликации для экземпляров Управляемого Redis Azure".

Внимание

После создания не удается изменить политику кластеризации экземпляра Управляемого Redis (предварительная версия) Azure. Если вы используете RediSearch, требуется политика кластера Enterprise и NoEviction является единственной поддерживаемой политикой вытеснения.

Внимание

Если вы используете этот экземпляр кэша в группе георепликации, политики вытеснения нельзя изменить после создания экземпляра. Перед созданием кэша необходимо знать политики вытеснения основных узлов. Дополнительные сведения о активной георепликации см. в разделе "Предварительные требования для активной георепликации".

Внимание

После создания экземпляра кэша нельзя изменять модули. Модули должны быть включены во время создания экземпляра Кэш Azure для Redis. После создания кэша невозможно включить настройку модуля.
Нажмите кнопку "Далее": теги и пропуск.
По завершении выберите Next: Отзыв и создание.
Проверьте параметры и выберите Создать.

Создание экземпляра Redis занимает несколько минут. Ход выполнения можно отслеживать на странице обзора Управляемого Redis в Azure. Когда Состояние примет значение Running (Выполняется), кэш будет готов к использованию.

Создание экземпляра кэша Azure для Redis

Чтобы создать кэш, войдите в портал Azure. В меню портала выберите "Создать ресурс".
В области "Начало работы" введите Кэш Azure для Redis в строке поиска. В результатах поиска найдите Кэш Azure для Redis и нажмите кнопку "Создать".

На панели "Новый кэш Redis" на вкладке "Основы" настройте следующие параметры для кэша:

Параметр	Действие	Description
Подписка	Выберите свою подписку Azure.	Подписка, используемая для создания нового экземпляра Кэш Azure для Redis.
Группа ресурсов	Выберите группу ресурсов или щелкните Создать и введите новое имя группы ресурсов.	Имя группы ресурсов, в которой создается кэш и другие ресурсы. Поместив все ресурсы приложения в одну группу ресурсов, вы сможете легко управлять ими и/или удалить их вместе.
DNS-имя	Введите уникальное имя.	Имя кэша должно быть строкой от 1 до 63 символов, содержащих только цифры, буквы и дефисы. Имя должно начинаться и заканчиваться цифрой или буквой и не может содержать более одного дефиса подряд. Имя `\<DNS name>.redis.cache.windows.net`узла экземпляра кэша .
Местонахождение	Выберите расположение.	Регион Azure, расположенный рядом с другими службами, используюющими кэш.
Номер SKU кэша	Выберите номер SKU.	Номер SKU определяет размер, производительность и параметры компонентов, доступные для кэша. Дополнительные сведения см. в статье Общие сведения о Кэше Azure для Redis.
Объем кэша	Выберите размер кэша.	Дополнительные сведения см. в статье Общие сведения о Кэше Azure для Redis.

Перейдите на вкладку "Сеть" или нажмите кнопку "Далее: сеть".
На вкладке "Сеть" выберите метод подключения, используемый для кэша.
Выберите вкладку "Дополнительно" или нажмите кнопку "Далее".
На панели "Дополнительно" проверьте или выберите метод проверки подлинности на основе следующих сведений:
- По умолчанию для нового кэша "Базовый", "Стандартный" или "Премиум" включена проверка подлинности Microsoft Entra Authentication, а проверка подлинности ключей доступа отключена.
- Для кэшей "Базовый" или "Стандартный" можно выбрать выбранный порт, отличный от TLS.
- Для кэшей уровня "Стандартный" и "Премиум" можно включить зоны доступности. После создания кэша невозможно отключить зоны доступности.
- Для кэша Premium настройте параметры для порта, не относяющегося к TLS, кластеризации, управляемому удостоверению и сохраняемости данных.
Внимание

Для оптимальной безопасности рекомендуется использовать идентификатор Microsoft Entra с управляемыми удостоверениями для авторизации запросов к кэшу, если это возможно. Авторизация с помощью идентификатора Microsoft Entra и управляемых удостоверений обеспечивает более высокую безопасность и удобство использования при авторизации ключа общего доступа. Дополнительные сведения об использовании управляемых удостоверений с кэшем см. в разделе "Использование идентификатора Microsoft Entra для проверки подлинности кэша".
(Необязательно) Выберите вкладку "Теги" или нажмите кнопку "Далее: теги".
(Необязательно) На вкладке "Теги" введите имя и значение тега, если вы хотите классифицировать ресурс кэша.
Нажмите кнопку Просмотреть и создать.

На вкладке "Проверка и создание " Azure автоматически проверяет конфигурацию.
Когда отобразится сообщение Проверка пройдена зеленого цвета, выберите Создать.

Развертывание нового кэша происходит в течение нескольких минут. Ход развертывания можно отслеживать на панели обзора Кэш Azure для Redis. Когда отображается состояние выполнения, кэш готов к использованию.

Установка клиентской библиотеки node-redis

Библиотека redis узла является основным клиентом Node.js для Redis. Клиент можно установить с npm , выполнив следующую команду:

npm install redis

Создание приложения Node.js для доступа к кэшу

Создайте приложение Node.js, которое использует идентификатор Microsoft Entra или ключи доступа для подключения к экземпляру Управляемого Redis (предварительная версия) Azure. Мы рекомендуем использовать идентификатор Microsoft Entra.

Проверка подлинности идентификатора Microsoft Entra (рекомендуется)
Проверка подлинности ключа доступа

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Кэши Redis Для Azure, кроме уровней Enterprise и Enterprise Flash, по умолчанию включена проверка подлинности Microsoft Entra. Ключи доступа отключены по умолчанию.

Внимание

Корпорация Майкрософт рекомендует использовать проверку подлинности Идентификатора Microsoft Entra для наиболее безопасной проверки подлинности вместо использования паролей или ключей доступа. Проверка подлинности, описанная в этом разделе статьи, использует ключи доступа, для которых требуется очень высокий уровень доверия к приложению и не несет рисков при использовании идентификатора Microsoft Entra. Используйте подход в этом документе, только если проверка подлинности идентификатора Microsoft Entra недоступна.

В портал Azure выберите кэш, в котором вы хотите использовать проверку подлинности на основе токена Microsoft Entra.
Выберите проверку подлинности в меню "Ресурс".
Выберите элемент и введите имя допустимого пользователя. По умолчанию при нажатии кнопки "Сохранить" пользователь, который вы вводите, автоматически назначается политика доступа владельца данных. Вы также можете ввести управляемое удостоверение или субъект-службу для подключения к экземпляру кэша.

Сведения об использовании идентификатора Microsoft Entra с Azure CLI см. на справочных страницах для удостоверений.

Установка клиентской библиотеки удостоверений JavaScript Azure

Библиотека проверки подлинности Майкрософт (MSAL) позволяет получать маркеры безопасности от удостоверения Майкрософт для проверки подлинности пользователей. Существует клиентская библиотека удостоверений JavaScript Azure, которая использует MSAL для предоставления поддержки проверки подлинности маркеров. Установите эту библиотеку с помощью npm:

npm install @azure/identity

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Добавьте переменные среды для имени узла и идентификатора субъекта-службы, который является идентификатором объекта субъекта-службы Microsoft Entra ID или пользователя. В портал Azure найдите имя пользователя.
```
set AZURE_MANAGED_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
Создайте новый файл сценария с именем redistest.js.

Добавьте следующий пример JavaScript в файл. В этом коде показано, как подключиться к экземпляру Управляемого Redis в Azure с помощью имени узла кэша и ключевых переменных среды. Код также хранит строковое значение в кэше и извлекает его. Также выполняются команды PING и CLIENT LIST. Дополнительные примеры использования Redis с клиентом 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 имеют ограниченный срок жизни, в среднем 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 для проверки подлинности в Redis с помощью библиотеки node-redis см . в этом репозитории GitHub.

Внимание

Получение имени узла, портов и ключей доступа с помощью портала Azure

Чтобы подключить сервер Кэша Azure для 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));

Этот код показывает, как подключиться к экземпляру кэша Redis для Azure, используя имя узла кэша и переменные среды ключа. Код также хранит строковое значение в кэше и извлекает его. Также выполняются команды 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 или ключи доступа для подключения к Кэш Azure для Redis. Мы рекомендуем использовать идентификатор Microsoft Entra.

Проверка подлинности идентификатора Microsoft Entra (рекомендуется)
Проверка подлинности ключа доступа

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Внимание

В портал Azure выберите кэш, в котором вы хотите использовать проверку подлинности на основе токена Microsoft Entra.
Выберите проверку подлинности в меню "Ресурс".
Выберите элемент и введите имя допустимого пользователя. По умолчанию при нажатии кнопки "Сохранить" пользователь, который вы вводите, автоматически назначается политика доступа владельца данных. Вы также можете ввести управляемое удостоверение или субъект-службу для подключения к экземпляру кэша.

Сведения об использовании идентификатора Microsoft Entra с Azure CLI см. на справочных страницах для удостоверений.

Установка клиентской библиотеки удостоверений JavaScript Azure

npm install @azure/identity

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Добавьте переменные среды для имени узла и идентификатора субъекта-службы, который является идентификатором объекта субъекта-службы Microsoft Entra ID или пользователя. В портал Azure найдите имя пользователя.
```
set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
Создайте новый файл сценария с именем redistest.js.

Добавьте следующий пример JavaScript в файл. Этот код показывает, как подключиться к экземпляру кэша Redis для Azure, используя имя узла кэша и переменные среды ключа. Код также хранит строковое значение в кэше и извлекает его. Также выполняются команды PING и CLIENT LIST. Дополнительные примеры использования Redis с клиентом 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 с повторной проверку подлинности

Создайте файл скрипта с именем 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

Примечание.

Получение имени узла, портов и ключей доступа с помощью портала 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 и щелкните Группы ресурсов.
Выберите группу ресурсов, которую нужно удалить.

Если существует множество групп ресурсов, используйте фильтр для любого поля... введите имя группы ресурсов, созданной для этой статьи. Выберите группу ресурсов в списке результатов.
Выберите команду Удалить группу ресурсов.
Подтвердите операцию удаления группы ресурсов. Введите имя группы ресурсов, которую необходимо удалить, и щелкните Удалить.

Через некоторое время группа ресурсов и все ее ресурсы будут удалены.

Получение кода примера

Получите краткое руководство по Node.js на GitHub.

Из этого краткого руководства вы узнали, как использовать Управляемый Redis (предварительная версия) Azure или Кэш Azure для Redis из приложения Node.js. Дополнительные сведения о предложениях Redis для Azure:

Поделиться через

Краткое руководство. Использование Azure Redis в Node.js

Необходимые компоненты

Создание экземпляра Управляемого Redis (предварительная версия) Azure

Создание экземпляра кэша Azure для Redis

Установка клиентской библиотеки node-redis

Создание приложения Node.js для доступа к кэшу

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Установка клиентской библиотеки удостоверений JavaScript Azure

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Создание примера приложения JavaScript с повторной проверку подлинности

Получение имени узла, портов и ключей доступа с помощью портала Azure

Подключение к кэшу

Создание нового приложения Node.js

Создание приложения Node.js для доступа к кэшу

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Установка клиентской библиотеки удостоверений JavaScript Azure

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Создание примера приложения JavaScript с повторной проверку подлинности

Получение имени узла, портов и ключей доступа с помощью портала Azure

Подключение к кэшу

Создание нового приложения Node.js

Очистка ресурсов

Удаление группы ресурсов

Получение кода примера

Обратная связь

Дополнительные ресурсы

Поделиться через

Краткое руководство. Использование Azure Redis в Node.js

Необходимые компоненты

Создание экземпляра Управляемого Redis (предварительная версия) Azure

Создание экземпляра кэша Azure для Redis

Установка клиентской библиотеки node-redis

Создание приложения Node.js для доступа к кэшу

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Установка клиентской библиотеки удостоверений JavaScript Azure

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Создание примера приложения JavaScript с повторной проверку подлинности

Создание приложения Node.js для доступа к кэшу

Использование проверки подлинности идентификатора Microsoft Entra в кэше

Установка клиентской библиотеки удостоверений JavaScript Azure

Создание нового приложения Node.js с помощью идентификатора Microsoft Entra

Создание примера приложения JavaScript с повторной проверку подлинности

Очистка ресурсов

Удаление группы ресурсов

Получение кода примера

Связанный контент

Обратная связь

Дополнительные ресурсы