Guida introduttiva: Usare Cache di Azure per Redis con un'app Node.js

Articolo
09/24/2024

In questa guida introduttiva si incorpora Cache di Azure per Redis in un'app Node.js per l'accesso a una cache sicura e dedicata accessibile da qualsiasi applicazione in Azure.

Prerequisiti

Una sottoscrizione di Azure. Crearne uno gratuito
Node.js installato. Per informazioni su come installare Node e npm in un computer Windows, vedere Installare Node.js in Windows.

Creare una cache

Per creare una cache, accedere al portale di Azure. Nel menu del portale selezionare Crea una risorsa.
Nel riquadro Attività iniziali immettere Cache di Azure per Redis nella barra di ricerca. Nei risultati della ricerca trovare Cache di Azure per Redis e quindi selezionare Crea.

Nel riquadro Nuova cache Redis, nella scheda Informazioni di base configurare le impostazioni seguenti per la cache:

Impostazione	Azione	Descrizione
Abbonamento	Seleziona la tua sottoscrizione di Azure.	Sottoscrizione da usare per creare la nuova istanza della cache di Azure per Redis.
Gruppo di risorse	Selezionare un gruppo di risorse oppure selezionare Crea nuovo e immettere un nuovo nome del gruppo di risorse.	Nome del gruppo di risorse in cui creare la cache e altre risorse. L'inserimento di tutte le risorse di un'app in un unico gruppo di risorse ne semplifica la gestione o l'eliminazione.
Nome DNS	Immettere un nome univoco.	Il nome della cache deve essere una stringa compresa tra 1 e 63 caratteri contenente solo numeri, lettere o trattini. Il nome deve iniziare e terminare con un numero o una lettera e non può contenere trattini consecutivi. Il nome host dell'istanza della cache è `\<DNS name>.redis.cache.windows.net`.
Location	Selezionare una località.	Un'area di Azure vicina ad altri servizi che usano la cache.
SKU della cache	Selezionare uno SKU.	Lo SKU determina le dimensioni, le prestazioni e i parametri delle funzionalità disponibili per la cache. Per altre informazioni, vedere la panoramica su Cache Redis di Azure.
Dimensioni della cache	Selezionare le dimensioni della cache.	Per altre informazioni, vedere la panoramica su Cache Redis di Azure.

Selezionare la scheda Rete oppure selezionare Avanti: Rete.
Nella scheda Rete selezionare un metodo di connettività da usare per la cache.
Selezionare la scheda Avanzate o Avanti: Avanzate.
Nel riquadro Avanzate verificare o selezionare un metodo di autenticazione in base alle informazioni seguenti:
- Per impostazione predefinita, per una nuova cache Basic, Standard o Premium, l'Autenticazione di Microsoft Entra è abilitata e l'Autenticazione delle chiavi di accesso è disabilitata.
- Per le cache Basic o Standard, è possibile scegliere la selezione di una porta non TLS.
- Per le cache Standard e Premium, è possibile scegliere di abilitare le zone di disponibilità. Non è possibile disabilitare le zone di disponibilità dopo la creazione della cache.
- Per una cache Premium, configurare le impostazioni per la porta non TLS, il clustering, l'identità gestita e la persistenza dei dati.
Importante

Per una protezione ottimale, è consigliabile usare Microsoft Entra ID con identità gestite per autorizzare le richieste nella cache ogni volta che è possibile. L'autorizzazione tramite Microsoft Entra ID e le identità gestite offre sicurezza e facilità d'uso superiori rispetto all'autorizzazione con chiave di accesso condiviso. Per altre informazioni sull'uso delle identità gestite con le cache, vedere Usare Microsoft Entra ID per l'autenticazione della cache.
(Facoltativo) Selezionare la scheda Tag o selezionare Avanti: Tag.
(Facoltativo) Nella scheda Tag immettere un nome e un valore di tag per classificare la risorsa della cache.
Selezionare il pulsante Rivedi e crea.

Nella scheda Rivedi e crea Azure convalida automaticamente la configurazione.
Quando viene visualizzato il messaggio verde di Convalida superata, selezionare Crea.

Una nuova distribuzione della cache richiede diversi minuti. È possibile monitorare lo stato di avanzamento della distribuzione nel riquadro Panoramica di Cache di Azure per Redis. Quando Stato mostra In esecuzione, la cache è pronta per l'uso.

Installare la libreria client node-redis

La libreria node-redis è il client Node.js primario per Redis. È possibile installare il client usando npm e il comando seguente:

npm install redis

Creare un'app Node.js per accedere a una cache

Creare un'app Node.js nella quale si utilizzino Microsoft Entra ID o le chiavi di accesso per connettersi a Cache di Azure per Redis. È consigliabile usare Microsoft Entra ID.

Autenticazione di Microsoft Entra ID (scelta consigliata)
Autenticazione tramite chiave di accesso

Abilitare l'autenticazione di Microsoft Entra ID nella cache

Per una cache esistente, verificare prima di tutto se l'autenticazione di Microsoft Entra è abilitata. Altrimenti seguire questa procedura per abilitare l'autenticazione di Microsoft Entra. È consigliabile usare Microsoft Entra ID per l'autenticazione nelle applicazioni.

Nel portale di Azure selezionare l'istanza della cache di Azure per Redis in cui si vuole usare l'autenticazione basata su token di Microsoft Entra.
Nel menu del servizio, in Impostazioni, seleziona Autenticazione.
Nel riquadro Autenticazione verificare se è selezionata la casella di controllo Abilita autenticazione di Microsoft Entra. In caso affermativo, è possibile passare alla sezione successiva.
In caso contrario, selezionare la casella di controllo Abilita autenticazione di Microsoft Entra. Immettere quindi il nome di un utente valido. Seleziona Salva. Al nome utente immesso vengono assegnati automaticamente i criteri di accesso al proprietario dei dati.

È anche possibile immettere un'identità gestita o un'entità servizio per connettersi alla cache.
In una finestra di dialogo viene chiesto se si vuole aggiornare la configurazione e si è informati che il completamento dell'aggiornamento richiede alcuni minuti. Selezionare Sì.

Importante

Al termine dell'operazione di abilitazione, i nodi nella cache vengono riavviati per caricare la nuova configurazione. È consigliabile completare questa operazione durante la finestra di manutenzione standard o al di fuori dell'orario di ufficio di punta. Il processo può richiedere fino a 30 minuti.

Per informazioni sull'uso di Microsoft Entra ID con l'interfaccia della riga di comando di Azure, vedere le pagine di riferimento sull'identità.

Installare la libreria client di Identità di Azure per JavaScript

La libreria client di Identità di Azure per JavaScript usa la Libreria di autenticazione Microsoft (MSAL) necessaria per fornire il supporto per l'autenticazione tramite token. Installare la libreria usando npm:

npm install @azure/identity

Creare un'app Node.js usando Microsoft Entra ID

Aggiungere variabili di ambiente per il nome host e l'ID entità servizio.

L'ID entità servizio è l'ID oggetto dell'entità servizio o dell'utente Microsoft Entra ID. Nel portale di Azure questo valore viene visualizzato come Nome utente.
```
set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
Creare un file script denominato redistest.js.

Aggiungere lo script JavaScript di esempio seguente al file. Questo codice mostra come connettersi a un'istanza di Cache Redis di Azure usando il nome host della cache e le variabili di ambiente chiave. Il codice, inoltre, archivia e recupera un valore stringa nella cache. Vengono anche eseguiti i comandi PING e CLIENT LIST. Per altri esempi relativi all'uso di Redis con il client node-redis, vedere 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));

Eseguire lo script usando Node.js:
```
node redistest.js
```

Verificare che l'output del codice sia simile all'esempio seguente:

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

Creare un'app JavaScript di esempio con la riautenticazione

I token di accesso a Microsoft Entra ID hanno una durata limitata di circa 75 minuti. Per mantenere una connessione alla cache, è necessario aggiornare il token.

Questo esempio illustra come aggiornare il token usando JavaScript:

Creare un file script denominato redistestreauth.js.

Aggiungere lo script JavaScript di esempio seguente al file:

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

Eseguire lo script usando Node.js:
```
node redistestreauth.js
```

Verificare la presenza di output simile all'esempio seguente:

 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

Nota

Per altri esempi su come usare Microsoft Entra ID per eseguire l'autenticazione a Redis tramite la libreria node-redis, vedere il repository GitHub node-redis.

Ottieni il nome host e la chiave di accesso

Per connettere il server cache di Azure per Redis, il client della cache deve avere il nome host della cache, le porte e una chiave di accesso. Alcuni client possono fare riferimento a questi elementi usando nomi leggermente diversi. È possibile ottenere il nome host, le porte e le chiavi nel portale di Azure.

Per ottenere una chiave di accesso per la cache:
1. Nel portale di Azure, passare alla cache.
2. Nel menu del servizio, in Impostazioni, seleziona Autenticazione.
3. Nel pannello Autenticazione, selezionare la scheda Chiavi di accesso.
4. Per copiare il valore per una chiave di accesso, selezionare l'icona Copia nel campo della chiave.
Per ottenere il nome host e le porte della cache:
1. Nel portale di Azure, passare alla cache.
2. Nel menù del servizio, selezionare Panoramica.
3. In Essentials, per Nome host, selezionare l'icona Copia per copiare il valore del nome host. Il valore del nome host ha la forma <DNS name>.redis.cache.windows.net.
4. Per Porte, selezionare l'icona Copia per copiare i valori della porta.

Aggiungere le variabili di ambiente per il nome host e la chiave di accesso primaria. Usare queste variabili dal codice invece di includere le informazioni riservate direttamente nel codice.

set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set AZURE_CACHE_FOR_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Connettersi alla cache

Nota

Non creare un nuova connessione per ogni operazione nel codice. Riutilizzare invece le connessioni quanto più possibile.

Creare una nuova app Node.js

Creare un nuovo file script denominato redistest.js.

Aggiungere lo script JavaScript di esempio seguente al file:

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

Questo codice mostra come connettersi a un'istanza di Cache Redis di Azure usando il nome host della cache e le variabili di ambiente chiave. Il codice, inoltre, archivia e recupera un valore stringa nella cache. Vengono anche eseguiti i comandi PING e CLIENT LIST. Per altri esempi relativi all'uso di Redis con il client node_redis, vedere Node-Redis.

Eseguire lo script usando Node.js:
```
node redistest.js
```

Verificare che l'output sia simile a questo esempio:

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

Pulire le risorse

Per continuare a usare le risorse create in questo articolo, mantenere il gruppo di risorse.

In alternativa, per evitare addebiti relativi alle risorse, se si è terminato di usare le risorse è possibile eliminare il gruppo di risorse di Azure creato.

Avviso

L'eliminazione di un gruppo di risorse è irreversibile. Quando si elimina un gruppo di risorse, tutte le risorse al suo interno vengono eliminate in modo permanente. Assicurarsi di non eliminare accidentalmente il gruppo di risorse sbagliato o le risorse errate. Se le risorse sono state create all'interno di un gruppo di risorse esistente che contiene anche risorse da mantenere, è possibile eliminare ogni singola risorsa individualmente anziché l'intero gruppo.

Eliminare un gruppo di risorse

Accedere al portale di Azure e selezionare Gruppi di risorse.
Selezionare il gruppo di risorse da eliminare.

Se sono presenti molti gruppi di risorse, in Filtra per qualsiasi campo immettere il nome del gruppo di risorse creato per completare questo articolo. Nell'elenco dei risultati della ricerca selezionare il gruppo di risorse.
Selezionare Elimina gruppo di risorse.
Nel riquadro Elimina un gruppo di risorse immettere il nome del gruppo di risorse per confermare, quindi selezionare Elimina.

Dopo qualche istante, il gruppo di risorse e tutte le relative risorse vengono eliminati.

Scaricare il codice di esempio

Ottenere l'esempio di avvio rapido di Node.js su GitHub.

Creare un'app Web ASP.NET che usa Cache Redis di Azure

Condividi tramite

Guida introduttiva: Usare Cache di Azure per Redis con un'app Node.js

Prerequisiti

Creare una cache

Installare la libreria client node-redis

Creare un'app Node.js per accedere a una cache

Abilitare l'autenticazione di Microsoft Entra ID nella cache

Installare la libreria client di Identità di Azure per JavaScript

Creare un'app Node.js usando Microsoft Entra ID

Creare un'app JavaScript di esempio con la riautenticazione

Ottieni il nome host e la chiave di accesso

Connettersi alla cache

Creare una nuova app Node.js

Pulire le risorse

Eliminare un gruppo di risorse

Scaricare il codice di esempio

Commenti e suggerimenti

Risorse aggiuntive

Condividi tramite

Guida introduttiva: Usare Cache di Azure per Redis con un'app Node.js

Prerequisiti

Creare una cache

Installare la libreria client node-redis

Creare un'app Node.js per accedere a una cache

Abilitare l'autenticazione di Microsoft Entra ID nella cache

Installare la libreria client di Identità di Azure per JavaScript

Creare un'app Node.js usando Microsoft Entra ID

Creare un'app JavaScript di esempio con la riautenticazione

Pulire le risorse

Eliminare un gruppo di risorse

Scaricare il codice di esempio

Contenuto correlato

Commenti e suggerimenti

Risorse aggiuntive