Plug-in de Identidade do Azure para Persistência de Cache de Token

Esse pacote fornece um plug-in para a biblioteca de Identidade do Azure para JavaScript (@azure/identity) que permite o cache de token persistente. A persistência de cache de token permite que o cache de token interno persista entre sessões usando um sistema de armazenamento seguro fornecido pelo sistema operacional local.

Código-fonte | Amostras

Introdução

import { useIdentityPlugin } from "@azure/identity";
import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

useIdentityPlugin(cachePersistencePlugin);

Pré-requisitos

Instalar o pacote

Esse pacote foi projetado para ser usado com a Identidade do Azure para JavaScript. Instale esse @azure/identity pacote usando npm:

$ npm install --save @azure/identity
$ npm install --save @azure/identity-cache-persistence

Ambientes com suporte

Os plug-ins de Identidade do Azure para JavaScript dão suporte a versões estáveis (mesmo numeradas) de Node.js a partir da v12. Embora os plug-ins possam ser executados em outras versões do Nó, nenhum suporte é garantido. @azure/identity-cache-persistencenão dá suporte a ambientes de navegador.

Principais conceitos

|Se esta for a primeira vez que você usa o @azure/identity ou o plataforma de identidade da Microsoft (Azure Active Directory), recomendamos que primeiro você leia Como usar o @azure/identity com a plataforma de identidade da Microsoft. Esse documento fornecerá uma compreensão mais profunda da plataforma e de como configurar a conta do Azure corretamente.

Plug-ins de Identidade do Azure

A partir da @azure/identity versão 2.0.0, a biblioteca de clientes de identidade para JavaScript inclui uma API de plug-in. Esse pacote (@azure/identity-cache-persistence) exporta um objeto plug-in que você deve passar como um argumento para a função de nível useIdentityPlugin superior do @azure/identity pacote. Habilite a persistência de cache de token em seu programa da seguinte maneira:

import { useIdentityPlugin } from "@azure/identity";
import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

useIdentityPlugin(cachePersistencePlugin);

Depois de chamar useIdentityPlugin, o plug-in de cache de token persistente é registrado no @azure/identity pacote e estará disponível em todas as credenciais que dão suporte ao cache de token persistente (aqueles que têm tokenCachePersistenceOptions em suas opções de construtor).

Exemplos

Depois que o plug-in for registrado, você poderá habilitar a persistência do cache de token passando tokenCachePersistenceOptions com uma enabled propriedade definida como true para um construtor de credenciais. No exemplo a seguir, usamos o , já que o DeviceCodeCredentialcache persistente de seus tokens permite ignorar o fluxo interativo de autenticação de código de dispositivo se um token armazenado em cache estiver disponível.

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });

  // We'll use the Microsoft Graph scope as an example
  const scope = "https://graph.microsoft.com/.default";

  // Print out part of the access token
  console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Solução de problemas

Log

A habilitação do log pode ajudar a descobrir informações úteis sobre falhas. Para ver um log de solicitações e respostas HTTP, defina a variável de ambiente AZURE_LOG_LEVEL como info. Como alternativa, o log pode ser habilitado no runtime chamando setLogLevel em @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Próximas etapas

Forneça comentários

Se você encontrar bugs ou tiver sugestões, abra um problema.

Contribuição

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.

Impressões