你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Azure.Identity 命名空间

AuthenticationFailedException

在对客户端请求进行身份验证时出错时引发的异常类。

AuthenticationRecord

与身份验证请求相关的帐户信息。

AuthenticationRequiredException

指示需要交互式身份验证的异常。

AuthorizationCodeCredential

通过兑换以前从Microsoft Entra ID 获取的授权代码进行身份验证。 有关授权代码身份验证流的详细信息,请参阅 https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow

AuthorizationCodeCredentialOptions

用于配置 的选项 AuthorizationCodeCredential

AzureAuthorityHosts

定义公开 Azure 公有云和主权云的已知权威主机的字段。

AzureCliCredential

使用 Azure CLI 启用身份验证以Microsoft Entra ID 以获取访问令牌。

AzureCliCredentialOptions

用于配置 的选项 AzureCliCredential

AzureDeveloperCliCredential

允许使用 Azure Developer CLI Microsoft Entra ID 进行身份验证以获取访问令牌。

AzureDeveloperCliCredentialOptions

用于配置 的选项 AzureDeveloperCliCredential

AzurePowerShellCredential

允许使用 Azure PowerShell Microsoft Entra ID 进行身份验证以获取访问令牌。

AzurePowerShellCredentialOptions

用于配置 的选项 AzurePowerShellCredential

BrowserCustomizationOptions

用于自定义浏览器视图的选项。

ChainedTokenCredential

提供一个 TokenCredential 实现,该实现将多个 TokenCredential 实现按顺序进行尝试,直到其中一个 getToken 方法返回非默认 AccessToken

ClientAssertionCredential

启用使用签名客户端断言对Microsoft Entra服务主体进行身份验证。

ClientAssertionCredentialOptions

用于配置 的选项 ClientAssertionCredential

ClientCertificateCredential

使用分配给它的“应用注册”的 X509 证书,对服务主体进行身份验证以Microsoft Entra ID。 有关如何配置证书身份验证的详细信息,可在此处找到: https://learn.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

ClientCertificateCredentialOptions

用于配置 的选项 ClientCertificateCredential

ClientSecretCredential

使用为应用注册生成的客户端密码启用身份验证以Microsoft Entra ID。 有关如何配置客户端密码的详细信息,可在此处找到: https://docs.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

ClientSecretCredentialOptions

用于配置 的选项 ClientSecretCredential

CredentialUnavailableException

异常指示 TokenCredential 未尝试进行身份验证和检索 AccessToken,因为其先决条件信息或状态不可用。

DefaultAzureCredential

为将部署到 Azure 的应用程序提供默认 TokenCredential 身份验证流。 将按顺序尝试以下凭据类型(如果启用):

有关它们如何尝试身份验证的详细信息,请参阅这些凭据类型的文档。
DefaultAzureCredentialOptions

用于配置 DefaultAzureCredential 身份验证流和向 Azure 标识服务发出的请求的选项。

DeviceCodeCredential

一种 TokenCredential 实现,它使用设备代码流对用户进行身份验证,并为该用户帐户提供访问令牌。 有关设备代码身份验证流的详细信息,请参阅 https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow

DeviceCodeCredentialOptions

用于配置 的选项 DeviceCodeCredential

EnvironmentCredential

启用身份验证以使用客户端密码或证书Microsoft Entra ID,或者作为具有用户名和密码的用户进行身份验证。

使用以下环境变量按以下顺序尝试配置:

具有机密的服务主体:
变量说明
AZURE_TENANT_IDMicrosoft Entra租户 (目录) ID。
AZURE_CLIENT_ID客户端 (应用程序) 租户中应用注册的 ID。
AZURE_CLIENT_SECRET专为应用注册生成的客户端密码。
具有证书的服务主体:
变量说明
AZURE_TENANT_IDMicrosoft Entra租户 (目录) ID。
AZURE_CLIENT_ID客户端 (应用程序) 租户中应用注册的 ID。
AZURE_CLIENT_CERTIFICATE_PATHPEM 或 PFX 格式的证书和私钥对路径,可对应用注册进行身份验证。
AZURE_CLIENT_CERTIFICATE_PASSWORD (可选) 目前仅 PFX (PKCS12 支持 (保护证书文件的密码) 证书) 。
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN (可选) 指定身份验证请求是否将包含 x5c 标头,以支持基于使用者名称/颁发者的身份验证。 设置为“true”或“1”时,身份验证请求包括 x5c 标头。
用户名和密码:
变量说明
AZURE_TENANT_IDMicrosoft Entra租户 (目录) ID。
AZURE_CLIENT_ID客户端 (应用程序) 租户中应用注册的 ID。
AZURE_USERNAMEMicrosoft Entra 用户帐户的用户名(也称为 upn)。
AZURE_PASSWORDMicrosoft Entra 用户帐户的密码。 请注意,这不支持已启用 MFA 的帐户。

此凭据最终使用 ClientSecretCredentialClientCertificateCredentialUsernamePasswordCredential 使用这些详细信息执行身份验证。 有关更多详细信息,请参阅该类的文档。

EnvironmentCredentialOptions

用于配置 的选项 EnvironmentCredential

IdentityModelFactory

为 Azure 标识库启用模拟的模型工厂。

InteractiveBrowserCredential

一种 TokenCredential 实现,它启动系统默认浏览器以交互方式对用户进行身份验证并获取访问令牌。 仅启动浏览器以对用户进行身份验证一次,然后只要用户刷新令牌有效,就会通过用户以无提示方式获取访问令牌。

InteractiveBrowserCredentialOptions

用于配置 的选项 InteractiveBrowserCredential

ManagedIdentityCredential

尝试使用已分配给部署环境的托管标识进行身份验证。 此身份验证类型适用于所有支持托管标识的 Azure 托管环境。 有关配置托管标识的详细信息,可在此处找到: https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview

OnBehalfOfCredential

启用身份验证以使用代理流Microsoft Entra ID。

OnBehalfOfCredentialOptions
SharedTokenCacheCredential

使用本地缓存文件中的令牌进行身份验证。 这是一种旧机制,用于使用提供给 Visual Studio 的凭据对客户端进行身份验证。 此 Visual Studio 身份验证机制已替换为 VisualStudioCredential

SharedTokenCacheCredentialOptions

用于配置身份验证的选项 SharedTokenCacheCredential

TokenCachePersistenceOptions

控制令牌缓存存储的选项。

TokenCacheRefreshArgs

发送到 TokenCache OnBefore 和 OnAfter 事件的 Args。

TokenCacheUpdatedArgs

有关令牌缓存更新的数据。

TokenCredentialDiagnosticsOptions

公开与日志记录、遥测和分布式跟踪相关的客户端选项。

TokenCredentialOptions

用于配置对 OAUTH 标识服务发出的请求的选项。

UnsafeTokenCacheOptions

控制令牌缓存存储的选项。

UsernamePasswordCredential

启用身份验证以使用用户的用户名和密码Microsoft Entra ID。 如果用户启用了 MFA,则此凭据将无法获取引发 的 AuthenticationFailedException令牌。 此外,此凭据需要高度信任,如果可以使用更安全的凭据,则不建议在原型制作之外使用此凭据。

UsernamePasswordCredentialOptions

用于配置 的选项 UsernamePasswordCredential

VisualStudioCodeCredential

启用身份验证以在用户通过“Azure 帐户”扩展登录到Visual Studio Code时Microsoft Entra ID。

这是一个已知问题VisualStudioCodeCredential不适用于低于 0.9.11Azure 帐户扩展版本。 正在对此问题进行长期修复。 同时,请考虑使用 AzureCliCredential进行身份验证。

VisualStudioCodeCredentialOptions

用于配置 的选项 VisualStudioCodeCredential

VisualStudioCredential

启用身份验证以使用 Visual Studio 2017 或更高版本中的数据Microsoft Entra ID。 有关如何配置 Visual Studio for Azure 开发的详细信息,请参阅 https://learn.microsoft.com/dotnet/azure/configure-visual-studio

VisualStudioCredentialOptions

用于配置 的选项 VisualStudioCredential

WorkloadIdentityCredential

WorkloadIdentityCredential 支持在 Kubernetes 和其他支持工作负载标识的主机上Microsoft Entra Workload ID身份验证。 有关详细信息,请参阅Microsoft Entra Workload ID

WorkloadIdentityCredentialOptions

用于配置 的选项 WorkloadIdentityCredential

结构

DeviceCodeInfo

要呈现给用户以允许用户通过设备代码身份验证流进行身份验证的设备代码的详细信息。

TokenCacheData

与缓存委托相关的 UnsafeTokenCacheOptions 详细信息。