EnvironmentCredential class

Habilita a autenticação para a ID do Microsoft Entra usando um segredo ou certificado do cliente 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 do Microsoft Entra (diretório).
  • AZURE_CLIENT_ID: a ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

Se a configuração do AZURE_TENANT_ID, você também poderá definir os locatários permitidos adicionalmente

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: para aplicativos multilocatários, 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 todos os locatários.

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

  • AZURE_CLIENT_SECRET: um segredo do cliente que foi gerado para o Registro de Aplicativo.
  • 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 dar suporte ao nome da entidade/autenticação baseada no 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 com o qual autenticar.
  • AZURE_PASSWORD: senha com a qual autenticar.

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

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se 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 do Microsoft Entra (diretório).
  • AZURE_CLIENT_ID: a ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

Se a configuração do AZURE_TENANT_ID, você também poderá definir os locatários permitidos adicionalmente

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: para aplicativos multilocatários, 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 todos os locatários.

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

  • AZURE_CLIENT_SECRET: um segredo do cliente que foi gerado para o Registro de Aplicativo.
  • 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 dar suporte ao nome da entidade/autenticação baseada no 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 com o qual autenticar.
  • AZURE_PASSWORD: senha com a qual autenticar.

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

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parâmetros

options
EnvironmentCredentialOptions

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

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se 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 .

Retornos

Promise<AccessToken>