Início Rápido: usar o Cache do Azure para Redis com um aplicativo Node.js

Artigo
10/16/2024

Neste início rápido, você incorporará o Cache do Azure para Redis em um aplicativo Node.js para acessar um cache seguro e dedicado que pode ser acessado de qualquer aplicativo no Azure.

Pré-requisitos

Uma assinatura do Azure. Crie um gratuitamente
Node. js instalado. Para obter informações sobre como instalar o Node e o NPM em um computador do Windows, consulte Instalar Node.js no Windows.

Criar um cache

Para criar um cache, entre no portal do Azure. No menu do portal, selecione Criar um recurso.
Na página Introdução, insira Cache do Azure para Redis na barra de pesquisa. Nos resultados da pesquisa, localize o Cache do Azure para Redis e selecione Criar.

No painel Novo Cache Redis, no guia Básico, defina as seguintes configurações para seu cache:

Configuração	Ação	Descrição
Assinatura	Selecione sua assinatura do Azure.	A assinatura a ser usada para criar a nova instância do Cache do Azure para Redis.
Grupo de recursos	Selecione um grupo de recursos ou selecione Criar novo e insira um novo nome de grupo de recursos.	Um nome para o grupo de recursos no qual seu cache e outros recursos serão criados. Ao colocar todos os seus recursos de aplicativos em um só grupo de recursos, você pode gerenciá-los ou excluí-los juntos com facilidade.
Nome DNS	Insira um nome exclusivo.	O nome de cache precisa ser uma cadeia de caracteres de 1 a 63 caracteres que contenha somente números, letras e hifens. O nome deve começar e terminar com um número ou uma letra e não pode conter hifens consecutivos. O nome do host da instância de cache é `\<DNS name>.redis.cache.windows.net`.
Localidade	Selecione uma localização.	Uma região do Azure próxima a outros serviços que usam seu cache.
Cache SKU	Selecione um SKU.	O SKU determina os parâmetros de tamanho, desempenho e recurso disponíveis para o cache. Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.
Tamanho do cache	Selecione um tamanho de cache.	Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.

Selecione a guia Rede ou selecione Avançar: Rede.
No guia Rede, selecione um método de conectividade a ser usado para o cache.
Selecione o guia Avançado ou selecione Avançar: Avançado.
No painel Avançado, verifique ou selecione um método de autenticação com base nas seguintes informações:
- Por padrão, para um novo cache Básico, Standard ou Premium, a Autenticação do Microsoft Entra está habilitada e a Autenticação de Chaves de Acesso está desabilitada.
- Para caches Básico ou Standard, é possível escolher a seleção de uma porta não TLS.
- Para caches Standard e Premium, é possível optar por habilitar zonas de disponibilidade. Não é possível desabilitar zonas de disponibilidade após a criação do cache.
- Para um cache Premium, defina as configurações para porta não TLS, clustering, identidade gerenciada e persistência de dados.
Importante

Para obter a segurança ideal, recomendamos que você use o Microsoft Entra ID com identidades gerenciadas para autorizar solicitações no seu cache, se possível. A autorização usando o Microsoft Entra ID e identidades gerenciadas oferece maior segurança e facilidade de uso em comparação com a autorização por chave de acesso compartilhada. Para obter mais informações sobre como usar identidades gerenciadas com seu cache, consulte Usar o Microsoft Entra ID para a autenticação de cache.
(Opcional) Selecione a guia Marcas ou selecione Avançar: Marcas.
(Opcional) No guia Marcas, insira um nome de marca e um valor se você quiser categorizar seu recurso de cache.
Selecione o botão Revisar + criar.

No guia Revisar + criar, o Azure valida automaticamente sua configuração.
Depois que a mensagem em verde Validação aprovada for exibida, selecione Criar.

Uma nova implantação de cache ocorre ao longo de vários minutos. Você pode monitorar o progresso da implantação no painel Visão Geral do Cache do Azure para Redis. Quando o Status mostrar Em execução, o cache estará pronto para ser usado.

Instalar a biblioteca cliente node-redis

A biblioteca node-redis é o principal cliente Node.js para Redis. Instale o cliente usando o NPM e o seguinte comando:

npm install redis

Crie um aplicativo Node.js para acessar um cache

Crie um aplicativo Node.js que use o Microsoft Entra ID ou chaves de acesso para se conectar ao Cache do Azure para Redis. Recomendamos que você use o Microsoft Entra ID.

Autenticação do Microsoft Entra ID (recomendado)
Autenticação de chave de acesso

Habilitar a autenticação do Microsoft Entra no seu cache

Para um cache existente, primeiro verifique se a autenticação do Microsoft Entra está habilitada. Caso contrário, conclua as etapas a seguir para habilitar a autenticação do Microsoft Entra. Recomendamos que você use o Microsoft Entra ID para autenticação em seus aplicativos.

No portal do Azure, selecione a instância do Cache do Azure para Redis onde você gostaria de usar a autenticação baseada em token do Microsoft Entra.
No menu de serviço, em Configurações, selecione Autenticação.
No painel Autenticação, verifique se a caixa de seleção Habilitar Autenticação do Microsoft Entra está marcada. Se estiver, você poderá passar para a próxima seção.
Caso contrário, marque a caixa de seleção Habilitar Autenticação do Microsoft Entra. Em seguida, insira o nome de um usuário válido. Selecione Salvar. O nome de usuário inserido é atribuído automaticamente à Política de Acesso do Proprietário de Dados.

Você também pode inserir uma identidade gerenciada ou uma entidade de serviço para se conectar à instância de cache.
Em uma caixa de diálogo, será perguntado se você deseja atualizar sua configuração e informado que a atualização leva vários minutos para ser concluída. Selecione Sim.

Importante

Depois que a operação de habilitação for concluída, os nós de cache serão reinicializados para carregar a nova configuração. Recomendamos que você conclua esta operação durante a janela de manutenção padrão ou fora do horário comercial de pico. O processo pode levar até 30 minutos.

Para obter informações sobre como usar o Microsoft Entra ID com a CLI do Azure, consulte as páginas de referência de identidade.

Instale a biblioteca de clientes da Identidade do Azure para JavaScript

A biblioteca de clientes da Identidade do Azure para JavaScript usa a MSAL (Biblioteca de Autenticação da Microsoft) necessária para fornecer suporte à autenticação de token. Instale a biblioteca usando o NPM:

npm install @azure/identity

Crie um aplicativo Node.js usando o Microsoft Entra ID

Adicione variáveis de ambiente para o nome do host e a ID da entidade de serviço.

A ID da entidade de serviço é a ID do objeto da entidade de serviço ou usuário do Microsoft Entra ID. No portal do Azure, esse valor aparece como Nome de usuário.
```
set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
Criar um arquivo de script chamado redistest.js.

Adicione o exemplo JavaScript a seguir ao arquivo. Este código mostra como se conectar a uma instância do Cache do Azure para Redis usando o nome de host de cache e as principais variáveis de ambiente. O código também armazena e recupera um valor de cadeia de caracteres no cache. Os comandos PING e CLIENT LIST também são executados. Para obter mais exemplos de como usar Redis com o cliente node-redis, consulte Node-Redis.

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));

Execute o script usando o Node.js:
```
node redistest.js
```

Verifique se a saída do código é semelhante a este exemplo:

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

Crie um aplicativo JavaScript de amostra que tenha reautenticação

Os tokens de acesso do Microsoft Entra ID têm um tempo de vida limitado de aproximadamente 75 minutos. Para manter uma conexão com o seu cache, você precisa atualizar o token.

Este exemplo demonstra como atualizar o token usando o JavaScript:

Crie um arquivo de script chamado redistestreauth.js.

Adicione o exemplo JavaScript a seguir ao arquivo:

 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));

Execute o script usando o Node.js:
```
node redistestreauth.js
```

Verifique se a saída é semelhante a este exemplo:

 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

Observação

Para obter mais exemplos de como usar o Microsoft Entra ID para autenticar no Redis por meio da biblioteca de node-redis, consulte o repositório node-redis do GitHub.

Obter o nome do host, as portas e a chave de acesso

Para se conectar ao servidor do Cache do Azure para Redis, o cliente de cache precisa do nome do host, das portas e da chave de acesso do cache. Alguns clientes podem se referir a esses itens usando nomes ligeiramente diferentes. Você pode obter o nome do host, as portas e as chaves no portal do Azure.

Para obter uma chave de acesso para seu cache:
1. No portal do Azure, acesse seu cache.
2. No menu de serviço, em Configurações, selecione Autenticação.
3. No painel Autenticação, selecione a guia Chaves de acesso.
4. Para copiar o valor de uma chave de acesso, selecione o ícone Copiar no campo de chave.
Para obter o nome do host e as portas do cache:
1. No portal do Azure, acesse seu cache.
2. No menu de serviço, selecione Visão geral.
3. Em Essentials, para o Nome do host, selecione o ícone Copiar para copiar o valor do nome do host. O valor do nome do host tem o formato <DNS name>.redis.cache.windows.net.
4. Para Portas, selecione o ícone Copiar para copiar os valores da porta.

Adicionar variáveis de ambiente para seu nome de host e chave de acesso primária. Use essas variáveis no seu código em vez de incluir as informações confidenciais diretamente no seu código.

set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set AZURE_CACHE_FOR_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Conectar-se ao cache

Observação

Não crie uma conexão para cada operação em seu código. Em vez disso, reutilize conexões sempre que possível.

Criar um novo aplicativo Node.js

Criar um novo arquivo de script chamado redistest.js.

Adicione o exemplo JavaScript a seguir ao arquivo:

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));

Este código mostra como se conectar a uma instância do Cache do Azure para Redis usando o nome de host de cache e as principais variáveis de ambiente. O código também armazena e recupera um valor de cadeia de caracteres no cache. Os comandos PING e CLIENT LIST também são executados. Para obter mais exemplos de como usar Redis com o cliente node_redis, consulte Node-Redis.

Execute o script usando o Node.js:
```
node redistest.js
```

Verifique se a saída é semelhante a este exemplo:

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

Limpar os recursos

Se quiser continuar a usar os recursos que você criou neste artigo, conserve o grupo de recursos.

Caso contrário, para evitar encargos relacionados aos recursos, se você já tiver terminado de usá-los, pode excluir o grupo de recursos do Azure que você criou.

Aviso

A exclusão de um grupo de recursos é irreversível. Ao excluir o grupo de recursos, todos os recursos nele são excluídos permanentemente. Não exclua acidentalmente o grupo de recursos ou os recursos incorretos. Se você criou os recursos em um grupo de recursos existente que tem recursos que você quer manter, você pode excluir cada recurso individualmente em vez de excluir o grupo todo.

Excluir um grupo de recursos

Entre no portal do Azure e selecione Grupos de recursos.
Selecione o grupo de recursos a ser excluído.

Se houver muitos grupos de recursos, em Filtrar para qualquer campo, insira o nome do grupo de recursos que você criou para concluir este artigo. Na lista de resultados da pesquisa, selecione o grupo de recursos.
Selecione Excluir grupo de recursos.
No painel Excluir um grupo de recursos, insira o nome do grupo de recursos para confirmar e selecione Excluir.

Em poucos instantes, o grupo de recursos e todos os seus recursos são excluídos.

Obter o código de exemplo

Obtenha a amostra de início rápido do Node.js no GitHub.

Crie um aplicativo Web ASP.NET que usa um Cache do Azure para Redis

Compartilhar via

Início Rápido: usar o Cache do Azure para Redis com um aplicativo Node.js

Pré-requisitos

Criar um cache

Instalar a biblioteca cliente node-redis

Crie um aplicativo Node.js para acessar um cache

Habilitar a autenticação do Microsoft Entra no seu cache

Instale a biblioteca de clientes da Identidade do Azure para JavaScript

Crie um aplicativo Node.js usando o Microsoft Entra ID

Crie um aplicativo JavaScript de amostra que tenha reautenticação

Obter o nome do host, as portas e a chave de acesso

Conectar-se ao cache

Criar um novo aplicativo Node.js

Limpar os recursos

Excluir um grupo de recursos

Obter o código de exemplo

Comentários

Recursos adicionais

Compartilhar via

Início Rápido: usar o Cache do Azure para Redis com um aplicativo Node.js

Pré-requisitos

Criar um cache

Instalar a biblioteca cliente node-redis

Crie um aplicativo Node.js para acessar um cache

Habilitar a autenticação do Microsoft Entra no seu cache

Instale a biblioteca de clientes da Identidade do Azure para JavaScript

Crie um aplicativo Node.js usando o Microsoft Entra ID

Crie um aplicativo JavaScript de amostra que tenha reautenticação

Limpar os recursos

Excluir um grupo de recursos

Obter o código de exemplo

Conteúdo relacionado

Comentários

Recursos adicionais