@azure/identity package

Fornece uma matriz contendo instância de AuthenticationError para falhas de autenticação de credenciais em umChainedTokenCredential .

Fornece detalhes sobre uma falha de autenticação com o Azure Active Directory. O campo errorResponse contém mais detalhes sobre a falha específica.

Erro usado para impor a autenticação depois de tentar recuperar um token silenciosamente.

Permite a autenticação do Microsoft Entra ID usando um código de autorização obtido através do fluxo de código de autorização, descrito com mais detalhe na documentação do Microsoft Entra ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Esta credencial utilizará as informações de login do utilizador atualmente iniciadas através da ferramenta de linha de comandos CLI do Azure ('az'). Para isso, irá ler o token de acesso do utilizador e expirar com o comando do CLI do Azure "az account get-access-token".

O Azure Developer CLI é uma ferramenta de interface de linha de comandos que permite aos programadores criar, gerir e implementar recursos no Azure. É construído sobre a CLI do CLI do Azure e oferece funcionalidades adicionais específicas para programadores do Azure. Permite aos utilizadores autenticar-se como utilizador e/ou como principal de serviço contra Microsoft Entra ID. O AzureDeveloperClidential autentica-se num ambiente de desenvolvimento e adquire um token em nome do utilizador ou principal do serviço iniciado na CLI do Azure Developer. Atua como o utilizador ou principal de serviço logado para o Azure Developer CLI e executa um comando CLI do Azure abaixo para autenticar a aplicação contra o Microsoft Entra ID.

Configurar AzureDeveloperCliCredential

Para usar esta credencial, o programador precisa de autenticar localmente no Azure Developer CLI usando um dos comandos abaixo:

1. Execute o "azd auth login" no Azure Developer CLI para autenticar interativamente como utilizador.
2. Execute "azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID" para autenticar como uma entidade de serviço.

Talvez seja necessário repetir esse processo após um determinado período de tempo, dependendo da validade do token de atualização em sua organização. Geralmente, o período de validade do token de atualização é de algumas semanas a alguns meses. AzureDeveloperCliCredential solicitará que você entre novamente.

Esta credencial foi concebida para ser usada em Azure Pipelines com ligações de serviço como configuração para a federação de identidades de carga de trabalho.

Esta credencial utilizará as informações de utilizador atualmente iniciadas no módulo Azure PowerShell. Para isso, irá ler o token de acesso do utilizador e expirar com Azure PowerShell comando Get-AzAccessToken -ResourceUrl {ResourceScope}

Permite que várias implementações de TokenCredential sejam tentadas em ordem até que um dos métodos getToken retorne um token de acesso. Para obter mais informações, consulte visão geral de ChainedTokenCredential.

Autentica uma entidade de serviço com uma asserção JWT.

Permite a autenticação do Microsoft Entra ID usando um certificado codificado em PEM atribuído a um Registo de Aplicações. Mais informações sobre como configurar a autenticação de certificado podem ser encontradas aqui:

https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Permite a autenticação do Microsoft Entra ID usando um segredo do cliente gerado para um Registo de Aplicações. Mais informações sobre como configurar um segredo do cliente podem ser encontradas aqui:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Isso significa que a credencial que foi testada em uma credencial encadeada não estava disponível para ser usada como credencial. Em vez de tratar isso como um erro que deveria parar a cadeia, ela é pega e a cadeia continua

Fornece uma configuração padrão ChainedTokenCredential que funciona para a maioria das aplicações que utilizam bibliotecas SDK do Azure clientes. Para obter mais informações, consulte Visão geral de DefaultAzureCredential.

Os seguintes tipos de credenciais serão testados, pela ordem:

• Credencial do Ambiente
• WorkloadIdentityCredential
• CredencialDeIdentidadeGerida
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• BrokerCredential (uma credencial habilitada para broker que requer @azure/identity-broker a instalação)

Consulte a documentação desses tipos de credenciais para obter mais informações sobre como eles tentam autenticação.

O exemplo a seguir demonstra como usar a requiredEnvVars opção para garantir que determinadas variáveis de ambiente sejam definidas antes que o DefaultAzureCredential seja instanciado. Se alguma das variáveis de ambiente especificadas estiver ausente ou vazia, um erro será lançado, impedindo que o aplicativo continue a execução sem a configuração necessária. Ele também demonstra como definir a AZURE_TOKEN_CREDENTIALS variável de ambiente para controlar quais credenciais são incluídas na cadeia.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

Permite a autenticação Microsoft Entra ID usando um código de dispositivo que o utilizador pode introduzir em https://microsoft.com/devicelogin.

Permite autenticação ao Microsoft Entra ID usando um segredo ou certificado do cliente.

Permite a autenticação do Microsoft Entra ID dentro do navegador web usando o fluxo interativo de login.

Tenta autenticação usando uma identidade gerenciada disponível no ambiente de implantação. Este tipo de autenticação funciona em VMs do Azure, instâncias de App Service, aplicações Funções do Azure, Azure Kubernetes Services, instâncias do Azure Service Fabric e dentro do Azure Cloud Shell.

Mais informações sobre como configurar identidades gerenciadas podem ser encontradas aqui: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

Permite a autenticação para Microsoft Entra ID usando o Em nome do fluxo.

Permite a autenticação do Microsoft Entra ID com o nome de utilizador e a palavra-passe do utilizador. Essa credencial requer um alto grau de confiança, portanto, você só deve usá-la quando outros tipos de credenciais mais seguros não puderem ser usados.

Liga-se ao Azure usando a conta de utilizador iniciada através da extensão Azure Resources no Visual Studio Code. Depois que o usuário fizer login por meio da extensão, essa credencial poderá compartilhar o mesmo token de atualização armazenado em cache pela extensão.

A autenticação por Identidade de Carga de Trabalho é uma funcionalidade no Azure que permite que aplicações a correr em máquinas virtuais (VMs) acedam a outros recursos do Azure sem necessidade de um principal de serviço ou identidade gerida. Com a autenticação de Identidade de Carga de Trabalho, os aplicativos se autenticam usando sua própria identidade, em vez de usar uma entidade de serviço compartilhada ou uma identidade gerenciada. Por baixo, a autenticação de Identidade de Carga de Trabalho utiliza o conceito de Credenciais de Conta de Serviço (SACs), que são criadas automaticamente pelo Azure e armazenadas de forma segura na VM. Usando a autenticação de Identidade de Carga de Trabalho, você pode evitar a necessidade de gerenciar e girar entidades de serviço ou identidades gerenciadas para cada aplicativo em cada VM. Além disso, como os SACs são criados automaticamente e geridos pelo Azure, não precisa de se preocupar em armazenar e proteger as próprias credenciais sensíveis. O WorkloadIdentityCredential suporta autenticação ID de carga de trabalho Microsoft Entra no Azure Kubernetes e adquire um token usando os SACs disponíveis no ambiente Azure Kubernetes. Consulte ID de carga de trabalho Microsoft Entra para mais informações.

Representa um token de acesso com um tempo de expiração.

O registro a ser usado para localizar os tokens armazenados em cache no cache.

Parâmetros opcionais para o AuthenticationRequiredError

Fornece opções para configurar como a biblioteca de Identidade faz a validação de autoridade durante pedidos de autenticação ao Microsoft Entra ID.

Opções para o AuthorizationCodeCredential

Opções para o AzureCliCredential

Opções para o AzureDeveloperCliCredential

Parâmetros opcionais para a classe AzurePipelinesCredential.

Opções para o AzurePowerShellCredential

Opções de configuração para InteractiveBrowserCredential para suportar a autenticação de agente WAM.

Parâmetros quando a autenticação do agente WAM está desativada.

Parâmetros quando a autenticação do agente WAM está habilitada.

Opções de configuração compartilhada para personalização do navegador

Opções para o ClientAssertionCredential

Parâmetros opcionais para a classe ClientCertificateCredential.

Opções de configuração necessárias para o ClientCertificateCredential, com o conteúdo da cadeia de caracteres de um certificado PEM

Opções de configuração necessárias para o ClientCertificateCredential, com o caminho para um certificado PEM.

Parâmetros opcionais para a classe ClientSecretCredential.

Opções de configuração compartilhada para credenciais que suportam cache de token persistente.

Fornece opções para configurar o classe de DefaultAzureCredential. Esta variação suporta managedIdentityClientId e não managedIdentityResourceId, uma vez que apenas um dos dois é suportado.

Fornece opções para configurar o classe de DefaultAzureCredential.

Fornece opções para configurar o classe de DefaultAzureCredential. Esta variação suporta managedIdentityResourceId e não managedIdentityClientId, uma vez que apenas um dos dois é suportado.

Define opções para a classe InteractiveBrowserCredential para Node.js.

Fornece o código de usuário e o URI de verificação onde o código deve ser inserido. Também fornece uma mensagem para exibir ao usuário que contém uma instrução com esses detalhes.

Permite autenticação ao Microsoft Entra ID dependendo das variáveis de ambiente disponíveis. Define opções para a classe EnvironmentCredential.

Consulte a documentação oficial para mais detalhes:

https://learn.microsoft.com/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

NOTA: Esta documentação destina-se ao suporte OAuth v1, mas os mesmos detalhes de resposta de erro ainda se aplicam à v2.

As opções para configurar o provedor de token.

Define opções para TokenCredential.getToken.

Define as opções comuns para a classe InteractiveBrowserCredential.

Define as opções comuns para a classe InteractiveBrowserCredential.

Opções comuns do construtor para as credenciais Identity que exigem interação do usuário.

Opções para enviar no ManagedIdentityCredential construtor. Esta variação suporta clientId e não resourceId, uma vez que apenas um dos dois é suportado.

Opções para enviar no ManagedIdentityCredential construtor. Essa variação suporta objectId como um argumento de construtor.

Opções para enviar no ManagedIdentityCredential construtor. Esta variação suporta resourceId e não clientId, uma vez que apenas um dos dois é suportado.

Opções para aplicativos multilocatários que permitem locatários adicionalmente permitidos.

Define os parâmetros para autenticar o OnBehalfOfCredential com uma asserção.

Define os parâmetros para autenticar o OnBehalfOfCredential com um certificado.

Define os parâmetros para autenticar o OnBehalfOfCredential com um segredo.

Parâmetros que permitem a persistência do cache de token nas credenciais de Identidade.

Representa uma credencial capaz de fornecer um token de autenticação.

Fornece opções para configurar como a biblioteca Identity faz pedidos de autenticação ao Microsoft Entra ID.

Define opções para a classe UsernamePasswordCredential.

Fornece opções para configurar a credencial do Visual Studio Code.

Opções para o WorkloadIdentityCredential

Parâmetros que habilitam a autenticação do agente WAM no InteractiveBrowserCredential.

(Funcionalidade apenas para browser) O "estilo de login" a ser usado no fluxo de autenticação:

• "Redirect" redireciona o usuário para a página de autenticação e, em seguida, redireciona-o de volta para a página assim que a autenticação for concluída.
• "popup" abre uma nova janela do navegador através do qual o fluxo de redirecionamento é iniciado. A janela existente do navegador do usuário não sai da página atual

Opções de configuração necessárias para o ClientCertificateCredential , com o conteúdo da cadeia de caracteres de um certificado PEM ou o caminho para um certificado PEM.

As variáveis de ambiente comumente suportadas para a classe DefaultAzureCredential .

Define a assinatura de um retorno de chamada que será passado para DeviceCodeCredential com a finalidade de exibir detalhes de autenticação para o usuário.

O tipo de plugin Azure Identity, uma função que aceita um contexto de plugin.

Parâmetros opcionais para a classe OnBehalfOfCredential.

Uma lista de hosts de autoridade Azure conhecidos

Desserializa um registro de autenticação serializado anteriormente de uma cadeia de caracteres em um objeto.

A cadeia de caracteres de entrada deve conter as seguintes propriedades:

• "Autoridade"
• "HomeAccountId"
• "ID do cliente"
• "Id do inquilino"
• "nome de utilizador"
• "versão"

Se a versão que recebemos não for suportada, um erro será lançado.

No momento, a única versão disponível é: "1.0", que é sempre definida quando o registro de autenticação é serializado.

Retorna um retorno de chamada que fornece um token de portador. Por exemplo, o token ao portador pode ser usado para autenticar uma solicitação da seguinte maneira:

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

Retorna uma nova instância do DefaultAzureCredential.

Serializa um AuthenticationRecord em uma cadeia de caracteres.

A saída de um registro de autenticação serializado conterá as seguintes propriedades:

• "Autoridade"
• "HomeAccountId"
• "ID do cliente"
• "Id do inquilino"
• "nome de utilizador"
• "versão"

Para converter posteriormente essa cadeia de caracteres em um AuthenticationRecordserializado, use a função exportada deserializeAuthenticationRecord().

Estenda o Azure Identity com funcionalidades adicionais. Passe um plugin de um pacote de plugins, como:

• @azure/identity-cache-persistence: fornece cache de token persistente
• @azure/identity-vscode: fornece as dependências do VisualStudioCodeCredential e habilita-o

Exemplo:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);
// The plugin has the capability to extend `DeviceCodeCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DeviceCodeCredential({
  tokenCachePersistenceOptions: {
    enabled: true,
  },
});

O valor Error.name de um AggregateAuthenticationError

O valor Error.name de um AuthenticationError

O valor Error.name de uma CredencialIndisponível

O AzureLogger usado para todos os clientes dentro do pacote de identidade