Partilhar via


Azure.Identity Namespace

Classes

AuthenticationFailedException

Uma classe de exceção gerada para erros na autenticação de solicitações de cliente.

AuthenticationRecord

Informações da conta relacionadas a uma solicitação de autenticação.

AuthenticationRequiredException

Uma exceção que indica que a autenticação interativa é necessária.

AuthorizationCodeCredential

Autentica-se resgatando um código de autorização obtido anteriormente de Microsoft Entra ID. Consulte https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow para obter mais informações sobre o fluxo de autenticação de código de autorização.

AuthorizationCodeCredentialOptions

Opções usadas para configurar o AuthorizationCodeCredential.

AzureAuthorityHosts

Define campos que expõem os hosts de autoridade conhecidos para a Nuvem Pública do Azure e nuvens soberanas.

AzureCliCredential

Habilita a autenticação para Microsoft Entra ID usando a CLI do Azure para obter um token de acesso.

AzureCliCredentialOptions

Opções para configurar o AzureCliCredential.

AzureDeveloperCliCredential

Permite que a autenticação Microsoft Entra ID usando Azure Developer CLI para obter um token de acesso.

AzureDeveloperCliCredentialOptions

Opções para configurar o AzureDeveloperCliCredential.

AzurePowerShellCredential

Habilita a autenticação para Microsoft Entra ID usando Azure PowerShell para obter um token de acesso.

AzurePowerShellCredentialOptions

Opções para configurar o AzurePowerShellCredential.

BrowserCustomizationOptions

Opções para personalizar a exibição do navegador.

ChainedTokenCredential

Fornece uma TokenCredential implementação que encadeia várias TokenCredential implementações a serem testadas em ordem até que um dos métodos getToken retorne um não padrão AccessToken.

ClientAssertionCredential

Habilita a autenticação de uma entidade de serviço Microsoft Entra usando uma asserção de cliente assinada.

ClientAssertionCredentialOptions

Opções usadas para configurar o ClientAssertionCredential.

ClientCertificateCredential

Habilita a autenticação de uma entidade de serviço para Microsoft Entra ID usando um certificado X509 atribuído ao registro de aplicativo. Mais informações sobre como configurar a autenticação de certificado podem ser encontradas aqui: https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

ClientCertificateCredentialOptions

Opções usadas para configurar o ClientCertificateCredential.

ClientSecretCredential

Permite que a autenticação Microsoft Entra ID usando um segredo do cliente que foi gerado para um Registro de Aplicativo. Mais informações sobre como configurar um segredo do cliente podem ser encontradas aqui: https://docs.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

ClientSecretCredentialOptions

Opções usadas para configurar o ClientSecretCredential.

CredentialUnavailableException

Uma exceção que indica que um TokenCredential não tentou autenticar e recuperar AccessToken, pois suas informações de pré-requisito ou estado não estavam disponíveis.

DefaultAzureCredential

Fornece um fluxo de autenticação padrão TokenCredential para aplicativos que serão implantados no Azure. Os seguintes tipos de credencial, se habilitados, serão testados, na ordem:

Consulte a documentação desses tipos de credencial para obter mais informações sobre como eles tentam autenticação.
DefaultAzureCredentialOptions

Opções para configurar o DefaultAzureCredential fluxo de autenticação e as solicitações feitas aos serviços de Identidade do Azure.

DeviceCodeCredential

Uma TokenCredential implementação que autentica um usuário usando o fluxo de código do dispositivo e fornece tokens de acesso para essa conta de usuário. Para obter mais informações sobre o fluxo de autenticação de código do dispositivo, consulte https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow.

DeviceCodeCredentialOptions

Opções para configurar o DeviceCodeCredential.

EnvironmentCredential

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ávelDescrição
AZURE_TENANT_IDA ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_IDA ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_CLIENT_SECRETUm segredo do cliente que foi gerado para o Registro do Aplicativo.
Entidade de serviço com certificado:
VariávelDescrição
AZURE_TENANT_IDA ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_IDA ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_CLIENT_CERTIFICATE_PATHUm 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ávelDescrição
AZURE_TENANT_IDA ID do locatário Microsoft Entra (diretório).
AZURE_CLIENT_IDA ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
AZURE_USERNAMEO nome de usuário, também conhecido como upn, de uma conta de usuário Microsoft Entra.
AZURE_PASSWORDA senha da conta de usuário do 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.

EnvironmentCredentialOptions

Opções usadas para configurar o EnvironmentCredential.

IdentityModelFactory

Fábrica de modelos que permite zombaria para a biblioteca de Identidade do Azure.

InteractiveBrowserCredential

Uma TokenCredential implementação que inicia o navegador padrão do sistema para autenticar interativamente um usuário e obter um token de acesso. O navegador só será iniciado para autenticar o usuário uma vez e, em seguida, adquirirá silenciosamente tokens de acesso por meio do token de atualização dos usuários, desde que seja válido.

InteractiveBrowserCredentialOptions

Opções para configurar o InteractiveBrowserCredential.

ManagedIdentityCredential

Tenta autenticação usando uma identidade gerenciada que foi atribuída ao ambiente de implantação. Esse tipo de autenticação funciona para todos os ambientes hospedados do Azure que dão suporte à identidade gerenciada. Mais informações sobre como configurar identidades gerenciadas podem ser encontradas aqui: https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

OnBehalfOfCredential

Habilita a autenticação para Microsoft Entra ID usando um fluxo On-Behalf-Of.

OnBehalfOfCredentialOptions
SharedTokenCacheCredential

Autentica usando tokens em um arquivo de cache local. Esse é um mecanismo herdado para autenticar clientes usando credenciais fornecidas ao Visual Studio. Esse mecanismo para autenticação do Visual Studio foi substituído pelo VisualStudioCredential.

SharedTokenCacheCredentialOptions

Opções para configurar a SharedTokenCacheCredential autenticação.

TokenCachePersistenceOptions

Opções que controlam o armazenamento do cache de token.

TokenCacheRefreshArgs

Args enviados para eventos TokenCache OnBefore e OnAfter.

TokenCacheUpdatedArgs

Dados referentes a uma atualização de um cache de token.

TokenCredentialDiagnosticsOptions

Expõe as opções de cliente relacionadas ao registro em log, telemetria e rastreamento distribuído.

TokenCredentialOptions

Opções para configurar solicitações feitas para o serviço de identidade OAUTH.

UnsafeTokenCacheOptions

Opções que controlam o armazenamento do cache de token.

UsernamePasswordCredential

Permite que a autenticação Microsoft Entra ID usando o nome de usuário e a senha de um usuário. Se o usuário tiver a MFA habilitada, essa credencial falhará ao obter um token lançando um AuthenticationFailedException. Além disso, essa credencial requer um alto grau de confiança e não é recomendada fora da prototipagem quando credenciais mais seguras podem ser usadas.

UsernamePasswordCredentialOptions

Opções para configurar o UsernamePasswordCredential.

VisualStudioCodeCredential

Permite que a autenticação Microsoft Entra ID à medida que o usuário entrou no Visual Studio Code por meio da extensão 'Conta do Azure'.

É um problema conhecido que VisualStudioCodeCredential não funciona com versões de extensão da Conta do Azure mais recentes do que a 0.9.11. Uma correção de longo prazo para esse problema está em andamento. Enquanto isso, considere a autenticação com AzureCliCredential.

VisualStudioCodeCredentialOptions

Opções para configurar o VisualStudioCodeCredential.

VisualStudioCredential

Permite que a autenticação Microsoft Entra ID usando dados do Visual Studio 2017 ou posterior. Consulte https://learn.microsoft.com/dotnet/azure/configure-visual-studio para obter mais informações sobre como configurar o Visual Studio para desenvolvimento no Azure.

VisualStudioCredentialOptions

Opções para configurar o VisualStudioCredential.

WorkloadIdentityCredential

WorkloadIdentityCredential dá suporte à autenticação ID de carga de trabalho do Microsoft Entra no Kubernetes e em outros hosts que dão suporte à identidade da carga de trabalho. Consulte ID de carga de trabalho do Microsoft Entra para obter mais informações.

WorkloadIdentityCredentialOptions

Opções usadas para configurar o WorkloadIdentityCredential.

Estruturas

DeviceCodeInfo

Detalhes do código do dispositivo a ser apresentado a um usuário para permitir que ele se autentique por meio do fluxo de autenticação de código do dispositivo.

TokenCacheData

Detalhes relacionados a um delegado de UnsafeTokenCacheOptions cache.