DefaultAzureCredential class
Fornece uma configuração padrão ChainedTokenCredential que funciona para a maioria dos aplicativos que usam bibliotecas de cliente do SDK do Azure. Para obter mais informações, consulte Visão geral de DefaultAzureCredential.
Os seguintes tipos de credenciais serão testados, pela ordem:
- EnvironmentCredential
- 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",
],
});
- Extends
Construtores
Default |
Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialClientIdOptions. |
Default |
Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialOptions. |
Default |
Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialResourceIdOptions. |
Métodos Herdados
get |
Retorna o primeiro token de acesso retornado por uma das implementações de Esse método é chamado automaticamente pelas bibliotecas de cliente do SDK do Azure. Você pode chamar esse método diretamente, mas também deve manipular o cache de token e a atualização de token. |
Detalhes do Construtor
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Cria uma instância da classe DefaultAzureCredential com DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)
Parâmetros
Parâmetros opcionais. Consulte DefaultAzureCredentialClientIdOptions.
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
Parâmetros opcionais. Consulte DefaultAzureCredentialResourceIdOptions.
Detalhes do Método Herdado
getToken(string | string[], GetTokenOptions)
Retorna o primeiro token de acesso retornado por uma das implementações de TokenCredential
encadeadas. Lança um AggregateAuthenticationError quando uma ou mais credenciais lançam um AuthenticationError e nenhuma credencial retornou um token de acesso.
Esse método é chamado automaticamente pelas bibliotecas de cliente do SDK do Azure. Você pode chamar esse método diretamente, mas também deve manipular o cache de token e a 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 quaisquer solicitações que essa implementação TokenCredential
possa fazer.
Devoluções
Promise<AccessToken>
herdado deChainedTokenCredential.getToken