EnvironmentCredential Classe

Definição

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Pacote:

Azure.Identity v1.11.1

Origem:

EnvironmentCredential.cs

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

A configuração é tentada nesta ordem, usando estas variáveis de ambiente:

Entidade de serviço com segredo:

Variável	Descrição
AZURE_TENANT_ID	A ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_ID	A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_CLIENT_SECRET	Um segredo do cliente que foi gerado para o Registro do Aplicativo.

Entidade de serviço com certificado:

Variável	Descrição
AZURE_TENANT_ID	A ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_ID	A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_CLIENT_CERTIFICATE_PATH	Um caminho para o par de certificados e chaves privadas no formato PEM ou PFX, que pode autenticar o Registro do Aplicativo.
AZURE_CLIENT_CERTIFICATE_PASSWORD	(Opcional) A senha que protege o arquivo de certificado (atualmente compatível apenas com certificados PFX (PKCS12).
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN	(Opcional) Especifica se uma solicitação de autenticação incluirá um cabeçalho x5c para dar suporte ao nome da entidade/autenticação baseada em emissor. Quando definido como 'true' ou '1', as solicitações de autenticação incluem o cabeçalho x5c.

Nome de usuário e senha:

Variável	Descrição
AZURE_TENANT_ID	A ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_ID	A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_USERNAME	O nome de usuário, também conhecido como upn, de uma conta de usuário Microsoft Entra.
AZURE_PASSWORD	A senha da conta de usuário Microsoft Entra. Observe que isso não dá suporte a contas com MFA habilitada.

Essa credencial usa, em última análise, um ClientSecretCredential, ClientCertificateCredentialou UsernamePasswordCredential para executar a autenticação usando esses detalhes. Consulte a documentação dessa classe para obter mais detalhes.

public class EnvironmentCredential : Azure.Core.TokenCredential

type EnvironmentCredential = class
    inherit TokenCredential

Public Class EnvironmentCredential
Inherits TokenCredential

Herança

Object

TokenCredential

EnvironmentCredential

Construtores

EnvironmentCredential()	Cria uma instância da classe EnvironmentCredential e lê os detalhes do segredo do cliente de variáveis de ambiente. Se as variáveis de ambiente esperadas não forem encontradas no momento, o método GetToken retornará o padrão AccessToken quando invocado.
EnvironmentCredential(EnvironmentCredentialOptions)	Cria uma instância da classe EnvironmentCredential e lê os detalhes do segredo do cliente de variáveis de ambiente. Se as variáveis de ambiente esperadas não forem encontradas no momento, o método GetToken retornará o padrão AccessToken quando invocado.

Métodos

GetToken(TokenRequestContext, CancellationToken)

Obtém um token de Microsoft Entra ID, usando os detalhes do cliente especificados nas variáveis de ambiente AZURE_TENANT_ID, AZURE_CLIENT_ID e AZURE_CLIENT_SECRET ou AZURE_USERNAME e AZURE_PASSWORD para autenticação. Os tokens adquiridos são armazenados em cache pela instância de credencial. O tempo de vida e a atualização do token são tratados automaticamente. Sempre que possível, reutilize instâncias de credencial para otimizar a eficácia do cache.

GetTokenAsync(TokenRequestContext, CancellationToken)

Obtém um token de Microsoft Entra ID, usando os detalhes do cliente especificados nas variáveis de ambiente AZURE_TENANT_ID, AZURE_CLIENT_ID e AZURE_CLIENT_SECRET ou AZURE_USERNAME e AZURE_PASSWORD para autenticação. Os tokens adquiridos são armazenados em cache pela instância de credencial. O tempo de vida e a atualização do token são tratados automaticamente. Sempre que possível, reutilize instâncias de credencial para otimizar a eficácia do cache.