Partilhar via

EnvironmentCredential class

  • Referência
Pacote:
@azure/identity

Permite a autenticação para o Microsoft Entra ID usando um segredo de cliente ou certificado, ou como um usuário com um nome de usuário e senha.

Construtores

EnvironmentCredential(EnvironmentCredentialOptions)

Cria uma instância da classe EnvironmentCredential e decide qual credencial usar dependendo das variáveis de ambiente disponíveis.

Variáveis de ambiente necessárias:

  • AZURE_TENANT_ID: A ID do locatário (diretório) do Microsoft Entra.
  • AZURE_CLIENT_ID: O ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

Se definir o AZURE_TENANT_ID, você também pode definir os locatários permitidos adicionalmente

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens com uma única cadeia de caracteres delimitada por ponto-e-vírgula. Use * para permitir que todos os locatários.

Variáveis de ambiente usadas para autenticação de credenciais de cliente:

  • AZURE_CLIENT_SECRET: Um segredo do cliente que foi gerado para o Registo da Aplicação.
  • AZURE_CLIENT_CERTIFICATE_PATH: O caminho para um certificado PEM a ser usado durante a autenticação, em vez do segredo do cliente.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: senha (opcional) para o arquivo de certificado.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opcional) indica que a cadeia de certificados deve ser definida no cabeçalho x5c para suportar a autenticação baseada no nome do assunto / emissor.

Como alternativa, os usuários podem fornecer variáveis de ambiente para autenticação de nome de usuário e senha:

  • AZURE_USERNAME: Nome de usuário para autenticar.
  • AZURE_PASSWORD: Senha para autenticar.

Se as variáveis de ambiente necessárias para executar a autenticação estiverem faltando, uma CredentialUnavailableError será lançada. Se a autenticação falhar ou se houver um erro desconhecido, uma AuthenticationError de será lançada.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido.

Detalhes do Construtor

EnvironmentCredential(EnvironmentCredentialOptions)

Cria uma instância da classe EnvironmentCredential e decide qual credencial usar dependendo das variáveis de ambiente disponíveis.

Variáveis de ambiente necessárias:

  • AZURE_TENANT_ID: A ID do locatário (diretório) do Microsoft Entra.
  • AZURE_CLIENT_ID: O ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

Se definir o AZURE_TENANT_ID, você também pode definir os locatários permitidos adicionalmente

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens com uma única cadeia de caracteres delimitada por ponto-e-vírgula. Use * para permitir que todos os locatários.

Variáveis de ambiente usadas para autenticação de credenciais de cliente:

  • AZURE_CLIENT_SECRET: Um segredo do cliente que foi gerado para o Registo da Aplicação.
  • AZURE_CLIENT_CERTIFICATE_PATH: O caminho para um certificado PEM a ser usado durante a autenticação, em vez do segredo do cliente.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: senha (opcional) para o arquivo de certificado.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opcional) indica que a cadeia de certificados deve ser definida no cabeçalho x5c para suportar a autenticação baseada no nome do assunto / emissor.

Como alternativa, os usuários podem fornecer variáveis de ambiente para autenticação de nome de usuário e senha:

  • AZURE_USERNAME: Nome de usuário para autenticar.
  • AZURE_PASSWORD: Senha para autenticar.

Se as variáveis de ambiente necessárias para executar a autenticação estiverem faltando, uma CredentialUnavailableError será lançada. Se a autenticação falhar ou se houver um erro desconhecido, uma AuthenticationError de será lançada.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parâmetros

options
EnvironmentCredentialOptions

Opções para configurar o cliente que faz a solicitação de autenticação.

Detalhes de Método

getToken(string | string[], GetTokenOptions)

Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido.

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

Parâmetros opcionais. Consulte GetTokenOptions.

Devoluções

Promise<AccessToken>