Compartilhar via


DefaultAzureCredential class

Fornece uma configuração de ChainedTokenCredential padrão que funciona para a maioria dos aplicativos que usam bibliotecas de clientes do SDK do Azure. Para obter mais informações, consulte visão geral do DefaultAzureCredential.

Os seguintes tipos de credencial serão testados, na ordem:

  • EnvironmentCredential
  • WorkloadIdentityCredential
  • ManagedIdentityCredential
  • VisualStudioCodeCredential
  • AzureCliCredential
  • do AzurePowerShellCredential
  • AzureDeveloperCliCredential
  • BrokerCredential (uma credencial habilitada para agente que requer @azure/identity-broker está instalada)

Consulte a documentação desses tipos de credencial 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 qualquer uma das variáveis de ambiente especificadas estiver ausente ou vazia, um erro será gerado, impedindo que o aplicativo continue a execução sem a configuração necessária. Ele também demonstra como definir a variável de AZURE_TOKEN_CREDENTIALS ambiente para controlar quais credenciais estã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",
  ],
});
Extends

Construtores

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialResourceIdOptions.

Métodos herdados

getToken(string | string[], GetTokenOptions)

Retorna o primeiro token de acesso retornado por uma das implementações de TokenCredential encadeadas. Gera um AggregateAuthenticationError quando uma ou mais credenciais geram um AuthenticationError e nenhuma credenciais retornou um token de acesso.

Esse método é chamado automaticamente pelas bibliotecas de clientes do SDK do Azure. Você pode chamar esse método diretamente, mas também deve lidar com cache de token e atualização de token.

Detalhes do construtor

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parâmetros

DefaultAzureCredential(DefaultAzureCredentialOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parâmetros

options
DefaultAzureCredentialOptions

Parâmetros opcionais. Consulte defaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parâmetros

Detalhes do método herdado

getToken(string | string[], GetTokenOptions)

Retorna o primeiro token de acesso retornado por uma das implementações de TokenCredential encadeadas. Gera um AggregateAuthenticationError quando uma ou mais credenciais geram um AuthenticationError e nenhuma credenciais retornou um token de acesso.

Esse método é chamado automaticamente pelas bibliotecas de clientes do SDK do Azure. Você pode chamar esse método diretamente, mas também deve lidar com cache de token e atualização de token.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parâmetros

scopes

string | string[]

A lista de escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar as solicitações que essa implementação TokenCredential podem fazer.

Retornos

Promise<AccessToken>

Herdado deChainedTokenCredential.getToken