Share via

@azure/identity package

  • Referência

Classes

AggregateAuthenticationError

Fornece uma errors matriz que contém a instância AuthenticationError para falhas de autenticação de credenciais num ChainedTokenCredential.
AuthenticationError

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

Erro utilizado para impor a autenticação depois de tentar obter um token automaticamente.
AuthorizationCodeCredential

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

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

Esta credencial utilizará as informações de início de sessão do utilizador com sessão iniciada atualmente através da ferramenta de linha de comandos da CLI do Azure ('az'). Para tal, irá ler o token de acesso do utilizador e expirar o tempo com o comando da CLI do Azure "az account get-access-token".
AzureDeveloperCliCredential

Azure Developer CLI é uma ferramenta de interface de linha de comandos que permite aos programadores criar, gerir e implementar recursos no Azure. Baseia-se na CLI do Azure e fornece funcionalidades adicionais específicas para os programadores do Azure. Permite que os utilizadores se autentiquem como utilizador e/ou principal de serviço em Microsoft Entra ID. O AzureDeveloperCliCredential autentica-se num ambiente de desenvolvimento e adquire um token em nome do utilizador ou principal de serviço com sessão iniciada no Azure Developer CLI. Atua como o Azure Developer CLI com sessão iniciada no utilizador ou principal de serviço e executa um comando da CLI do Azure por baixo para autenticar a aplicação no Microsoft Entra ID.

Configurar o AzureDeveloperCliCredential

Para utilizar esta credencial, o programador tem de se autenticar localmente no Azure Developer CLI com um dos comandos abaixo:

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

Poderá ter de repetir este processo após um determinado período de tempo, dependendo da validade do token de atualização na sua organização. Geralmente, o período de validade do token de atualização é de algumas semanas a alguns meses. O AzureDeveloperCliCredential irá pedir-lhe para iniciar sessão novamente.
AzurePowerShellCredential

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

Permite que várias TokenCredential implementações sejam experimentadas por ordem até que um dos métodos getToken devolva um token de acesso.
ClientAssertionCredential

Autentica um principal de serviço com uma afirmação JWT.
ClientCertificateCredential

Permite que a autenticação Microsoft Entra ID através de um certificado codificado por PEM atribuído a um Registo de Aplicações. Pode encontrar mais informações sobre como configurar a autenticação de certificados aqui:

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

Permite que a autenticação Microsoft Entra ID através de um segredo de cliente que foi gerado para um Registo de Aplicações. Pode encontrar mais informações sobre como configurar um segredo do cliente aqui:

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

Isto significa que a credencial que foi experimentada numa credencial em cadeia não estava disponível para ser utilizada como credencial. Em vez de tratar isto como um erro que deve parar a cadeia, é apanhado e a cadeia continua
DefaultAzureCredential

Fornece uma configuração ChainedTokenCredential predefinida que deve funcionar para a maioria das aplicações que utilizam o SDK do Azure.
DeviceCodeCredential

Permite que a autenticação Microsoft Entra ID através de um código de dispositivo que o utilizador pode introduzir no https://microsoft.com/devicelogin.
EnvironmentCredential

Permite que a autenticação Microsoft Entra ID através de um segredo ou certificado de cliente ou como utilizador com um nome de utilizador e palavra-passe.
InteractiveBrowserCredential

Permite que a autenticação Microsoft Entra ID dentro do browser através do fluxo de início de sessão interativo.
ManagedIdentityCredential

Tenta a autenticação com uma identidade gerida disponível no ambiente de implementação. Este tipo de autenticação funciona em VMs do Azure, Serviço de Aplicações instâncias, aplicações Funções do Azure, Azure Kubernetes Services, instâncias do Azure Service Fabric e no Azure Cloud Shell.

Pode encontrar mais informações sobre como configurar identidades geridas aqui: https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Permite a autenticação para Microsoft Entra ID através do fluxo Em Nome de.
UsernamePasswordCredential

Permite que a autenticação Microsoft Entra ID com o nome de utilizador e a palavra-passe de um utilizador. Esta credencial requer um elevado grau de confiança, pelo que só deve utilizá-la quando não for possível utilizar outros tipos de credenciais mais seguros.
VisualStudioCodeCredential

Liga-se ao Azure com a credencial fornecida pela extensão DO VSCode "Conta do Azure". Depois de o utilizador iniciar sessão através da extensão, esta credencial pode partilhar o mesmo token de atualização que é colocado em cache pela extensão.

É um problema conhecido que esta credencial não funciona com as versões da extensão da Conta do Azure mais recentes do que a 0.9.11. Está em curso uma correção a longo prazo deste problema. Entretanto, considere autenticar com o AzureCliCredential.
WorkloadIdentityCredential

A autenticação da Identidade da Carga de Trabalho é uma funcionalidade no Azure que permite que as aplicações em execução em máquinas virtuais (VMs) acedam a outros recursos do Azure sem a necessidade de um principal de serviço ou identidade gerida. Com a autenticação da Identidade da Carga de Trabalho, as aplicações autenticam-se com a sua própria identidade, em vez de utilizarem um principal de serviço partilhado ou uma identidade gerida. Nos bastidores, a autenticação da Identidade da 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. Ao utilizar a autenticação da Identidade da Carga de Trabalho, pode evitar a necessidade de gerir e rodar principais de serviço ou identidades geridas para cada aplicação em cada VM. Além disso, como as SACs são criadas automaticamente e geridas pelo Azure, não precisa de se preocupar em armazenar e proteger as próprias credenciais confidenciais. O WorkloadIdentityCredential suporta ID de carga de trabalho Microsoft Entra autenticação no Azure Kubernetes e adquire um token com as SACs disponíveis no ambiente do Azure Kubernetes. Consulte ID de carga de trabalho Microsoft Entra para obter mais informações.

Interfaces

AccessToken

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

O registo a utilizar para localizar os tokens em cache na cache.
AuthenticationRequiredErrorOptions

Parâmetros opcionais para AuthenticationRequiredError
AuthorityValidationOptions

Fornece opções para configurar a forma como a Biblioteca de identidades faz a validação da autoridade durante os pedidos de autenticação para Microsoft Entra ID.
AuthorizationCodeCredentialOptions

Opções do AuthorizationCodeCredential
AzureCliCredentialOptions

Opções para o AzureCliCredential
AzureDeveloperCliCredentialOptions

Opções para o AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Opções para o AzurePowerShellCredential
BrokerAuthOptions

Opções de configuração para InteractiveBrowserCredential para suportar a Autenticação do Mediador WAM.
BrokerDisabledOptions

Parâmetros quando a autenticação do mediador WAM é desativada.
BrokerEnabledOptions

Parâmetros quando a autenticação do mediador WAM está ativada.
BrowserCustomizationOptions

Opções de configuração partilhadas para personalização do browser
ClientAssertionCredentialOptions

Opções para ClientAssertionCredential
ClientCertificateCredentialOptions

Parâmetros opcionais para a classe ClientCertificateCredential .
ClientCertificatePEMCertificate

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

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

Parâmetros opcionais para a classe ClientSecretCredential .
CredentialPersistenceOptions

Opções de configuração partilhadas para credenciais que suportam a colocação em cache de tokens persistentes.
DefaultAzureCredentialClientIdOptions

Fornece opções para configurar a classe DefaultAzureCredential . Esta variação suporta managedIdentityClientId e não managedIdentityResourceId, uma vez que apenas uma de ambas é suportada.
DefaultAzureCredentialOptions

Fornece opções para configurar a classe DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

Fornece opções para configurar a classe DefaultAzureCredential . Esta variação suporta managedIdentityResourceId e não managedIdentityClientId, uma vez que apenas uma de ambas é suportada.
DeviceCodeCredentialOptions

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

Fornece o código de utilizador e o URI de verificação onde o código tem de ser introduzido. Também fornece uma mensagem para apresentar ao utilizador que contém uma instrução com estes detalhes.
EnvironmentCredentialOptions

Permite que a autenticação Microsoft Entra ID consoante as variáveis de ambiente disponíveis. Define as opções para a classe EnvironmentCredential.
ErrorResponse

Veja a documentação oficial para obter mais detalhes:

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

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

As opções para configurar o fornecedor de tokens.
GetTokenOptions

Define opções para TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

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

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

Opções de construtor comuns para as credenciais de Identidade que requerem interação do utilizador.
ManagedIdentityCredentialClientIdOptions

Opções para enviar no construtor ManagedIdentityCredential . Esta variação suporta clientId e não resourceId, uma vez que apenas uma de ambas é suportada.
ManagedIdentityCredentialResourceIdOptions

Opções para enviar no construtor ManagedIdentityCredential . Esta variação suporta resourceId e não clientId, uma vez que apenas uma de ambas é suportada.
MultiTenantTokenCredentialOptions

Opções para aplicações multi-inquilino que permitem inquilinos adicionalmente permitidos.
OnBehalfOfCredentialCertificateOptions

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

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

Parâmetros que permitem a persistência da cache de tokens nas credenciais de Identidade.
TokenCredential

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

Fornece opções para configurar a forma como a Biblioteca de identidade faz pedidos de autenticação para Microsoft Entra ID.
UsernamePasswordCredentialOptions

Define as opções para a classe UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

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

Opções para WorkloadIdentityCredential

Aliases de Tipo

BrokerOptions

Parâmetros que permitem a autenticação do mediador WAM no InteractiveBrowserCredential.
BrowserLoginStyle

(Funcionalidade apenas do browser) O "estilo de início de sessão" a utilizar no fluxo de autenticação:

  • O "redirecionamento" redireciona o utilizador para a página de autenticação e, em seguida, redireciona-o para a página assim que a autenticação estiver concluída.
  • O "pop-up" abre uma nova janela do browser com o fluxo de redirecionamento iniciado. A janela do browser existente do utilizador não sai da página atual
ClientCertificateCredentialPEMConfiguration

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

Define a assinatura de uma chamada de retorno que será transmitida para DeviceCodeCredential com o objetivo de apresentar detalhes de autenticação ao utilizador.
IdentityPlugin

O tipo de plug-in da Identidade do Azure, uma função que aceita um contexto de plug-in.
OnBehalfOfCredentialOptions

Parâmetros opcionais para a classe OnBehalfOfCredential .

Enumerações

AzureAuthorityHosts

Uma lista de anfitriões conhecidos da autoridade do Azure

Funções

deserializeAuthenticationRecord(string)

Analiza a serialização de um registo de autenticação serializado anteriormente de uma cadeia para um objeto.

A cadeia de entrada tem de conter as seguintes propriedades:

  • "autoridade"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nome de utilizador"
  • "versão"

Se a versão que recebermos não for suportada, será apresentado um erro.

Neste momento, a única versão disponível é: "1.0", que é sempre definida quando o registo de autenticação é serializado.
getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Devolve uma chamada de retorno que fornece um token de portador. Por exemplo, o token de portador pode ser utilizado para autenticar um pedido da seguinte forma:

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

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}`);
getDefaultAzureCredential()

Devolve uma nova instância do DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Serializa um numa AuthenticationRecord cadeia.

O resultado de um registo de autenticação serializado irá conter as seguintes propriedades:

  • "autoridade"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nome de utilizador"
  • "versão"

Para converter posteriormente esta cadeia num serializado AuthenticationRecord, utilize a função deserializeAuthenticationRecord()exportada .
useIdentityPlugin(IdentityPlugin)

Expanda a Identidade do Azure com funcionalidades adicionais. Transmita um plug-in a partir de um pacote de plug-in, como:

  • @azure/identity-cache-persistence: fornece a colocação em cache de tokens persistente
  • @azure/identity-vscode: fornece as dependências de VisualStudioCodeCredential e permite-lhe

Exemplo:

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

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

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

Detalhes de Função

deserializeAuthenticationRecord(string)

Analiza a serialização de um registo de autenticação serializado anteriormente de uma cadeia para um objeto.

A cadeia de entrada tem de conter as seguintes propriedades:

  • "autoridade"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nome de utilizador"
  • "versão"

Se a versão que recebermos não for suportada, será apresentado um erro.

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

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Parâmetros

serializedRecord

string

Registo de autenticação anteriormente serializado em cadeia.

Devoluções

AuthenticationRecord

AuthenticationRecord.

getBearerTokenProvider(TokenCredential, string | string[], GetBearerTokenProviderOptions)

Devolve uma chamada de retorno que fornece um token de portador. Por exemplo, o token de portador pode ser utilizado para autenticar um pedido da seguinte forma:

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

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

function getBearerTokenProvider(credential: TokenCredential, scopes: string | string[], options?: GetBearerTokenProviderOptions): () => Promise<string>

Parâmetros

credential
TokenCredential

A credencial utilizada para autenticar o pedido.

scopes

string | string[]

Os âmbitos necessários para o token de portador.

options
GetBearerTokenProviderOptions

Opções para configurar o fornecedor de tokens.

Devoluções

() => Promise<string>

uma chamada de retorno que fornece um token de portador.

getDefaultAzureCredential()

Devolve uma nova instância do DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Devoluções

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Serializa um numa AuthenticationRecord cadeia.

O resultado de um registo de autenticação serializado irá conter as seguintes propriedades:

  • "autoridade"
  • "homeAccountId"
  • "clientId"
  • "tenantId"
  • "nome de utilizador"
  • "versão"

Para converter posteriormente esta cadeia num serializado AuthenticationRecord, utilize a função deserializeAuthenticationRecord()exportada .

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Parâmetros

record
AuthenticationRecord

Devoluções

string

useIdentityPlugin(IdentityPlugin)

Expanda a Identidade do Azure com funcionalidades adicionais. Transmita um plug-in a partir de um pacote de plug-in, como:

  • @azure/identity-cache-persistence: fornece a colocação em cache de tokens persistente
  • @azure/identity-vscode: fornece as dependências de VisualStudioCodeCredential e permite-lhe

Exemplo:

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

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

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

function useIdentityPlugin(plugin: IdentityPlugin)

Parâmetros

plugin
IdentityPlugin

o plug-in a registar