EnvironmentCredential class
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.
Construtores
Environment |
Cria uma instância da classe EnvironmentCredential e decide que credenciais deve utilizar consoante as variáveis de ambiente disponíveis. Variáveis de ambiente necessárias:
Se definir o AZURE_TENANT_ID, também pode definir os inquilinos permitidos adicionalmente
Variáveis de ambiente utilizadas para autenticação de credenciais de cliente:
Em alternativa, os utilizadores podem fornecer variáveis de ambiente para autenticação de nome de utilizador e palavra-passe:
Se as variáveis de ambiente necessárias para efetuar a autenticação estiverem em falta, será gerado um CredentialUnavailableError . Se a autenticação falhar ou se ocorrer um erro desconhecido, será gerado um AuthenticationError . |
Métodos
get |
Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. |
Detalhes do Construtor
EnvironmentCredential(EnvironmentCredentialOptions)
Cria uma instância da classe EnvironmentCredential e decide que credenciais deve utilizar consoante as variáveis de ambiente disponíveis.
Variáveis de ambiente necessárias:
AZURE_TENANT_ID
: O ID de inquilino (diretório) Microsoft Entra.AZURE_CLIENT_ID
: o ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
Se definir o AZURE_TENANT_ID, também pode definir os inquilinos permitidos adicionalmente
AZURE_ADDITIONALLY_ALLOWED_TENANTS
: para aplicações multi-inquilino, especifica inquilinos adicionais para os quais a credencial pode adquirir tokens com uma única cadeia delimitada por ponto e vírgula. Utilize * para permitir todos os inquilinos.
Variáveis de ambiente utilizadas para autenticação de credenciais de cliente:
AZURE_CLIENT_SECRET
: um segredo do cliente que foi gerado para o Registo de Aplicações.AZURE_CLIENT_CERTIFICATE_PATH
: o caminho para um certificado PEM a utilizar durante a autenticação, em vez do segredo do cliente.AZURE_CLIENT_CERTIFICATE_PASSWORD
: (opcional) palavra-passe para o ficheiro de certificado.
Em alternativa, os utilizadores podem fornecer variáveis de ambiente para autenticação de nome de utilizador e palavra-passe:
AZURE_USERNAME
: nome de utilizador com o qual se autenticar.AZURE_PASSWORD
: palavra-passe para autenticar com.
Se as variáveis de ambiente necessárias para efetuar a autenticação estiverem em falta, será gerado um CredentialUnavailableError . Se a autenticação falhar ou se ocorrer um erro desconhecido, será gerado um AuthenticationError .
new EnvironmentCredential(options?: EnvironmentCredentialOptions)
Parâmetros
- options
- EnvironmentCredentialOptions
Opções para configurar o cliente que faz o pedido de autenticação.
Detalhes de Método
getToken(string | string[], GetTokenOptions)
Autentica com Microsoft Entra ID e devolve 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 âmbitos aos quais o token terá acesso.
- options
- GetTokenOptions
Parâmetros opcionais. Veja GetTokenOptions.
Devoluções
Promise<AccessToken>