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

TokenCredential 接口

public interface TokenCredential

令牌凭据接口充当一个基本组件,用于在向 Azure 服务发出请求时管理和提供 Azure Active Directory (Azure AD) 身份验证所需的访问令牌。

接口 TokenCredential 、套餐 getToken(TokenRequestContext request)getTokenSync(TokenRequestContext request) 方法。 这些方法负责检索可用于对 Azure 服务的请求进行身份验证的访问令牌。 指定为 的一部分的 TokenRequestContext scopes 参数表示令牌所需的资源或权限。

令牌凭据接口由 Azure 标识 库中的各种凭据类实现。 这些凭据类处理身份验证过程,并根据指定的范围和任何其他配置提供必要的访问令牌。

利用令牌凭据接口,可以将身份验证逻辑与应用程序代码抽象化。 这样可以灵活地选择身份验证机制,并简化访问令牌的管理,包括令牌缓存和刷新。 它提供了一种跨不同 Azure 服务和库对请求进行身份验证的一致方法。

下面是实现令牌凭据接口的凭据类的一些示例:

  • DefaultAzureCredential:表示一个凭据,该凭据尝试使用一系列身份验证方法自动对请求进行身份验证。 它通过基于环境自动选择适当的身份验证机制(例如环境变量、托管标识和开发人员工具凭据)来简化此过程。
  • ClientSecretCredential:表示使用客户端 ID、客户端密码和租户 ID 进行身份验证的凭据。 它适用于具有需要使用客户端密码对 Azure 服务进行身份验证的客户端应用程序的情况。
  • ClientCertificateCredential:表示使用客户端 ID、客户端证书和租户 ID 进行身份验证的凭据。 当客户端应用程序有可用于身份验证的客户端证书时,此凭据非常有用。
  • InteractiveBrowserCredential:表示在浏览器中向用户执行交互式身份验证流的凭据。 它适用于用户需要提供同意或需要多重身份验证的方案。

可以在 Azure 标识库中找到实现 接口的TokenCredential更多凭据类。

这些凭据类可以与各种 Azure 客户端库结合使用,对请求进行身份验证并访问 Azure 服务,而无需手动管理访问令牌。 令牌凭据接口提供了一种一致的方式来以安全高效的方式处理 Azure Active Directory (AAD) 不同 Azure 服务和 SDK 的身份验证。

方法摘要

修饰符和类型 方法和描述
abstract Mono<AccessToken> getToken(TokenRequestContext request)

异步获取给定资源/受众的令牌。

default AccessToken getTokenSync(TokenRequestContext request)

同步获取给定资源/受众的令牌。

方法详细信息

getToken

public abstract Mono getToken(TokenRequestContext request)

异步获取给定资源/受众的令牌。 此方法由 Azure SDK 客户端库自动调用。 可以直接调用此方法,但还必须处理令牌缓存和令牌刷新。

Parameters:

request - 令牌请求的详细信息

Returns:

发出单个访问令牌的发布服务器

getTokenSync

public default AccessToken getTokenSync(TokenRequestContext request)

同步获取给定资源/受众的令牌。 此方法由 Azure SDK 客户端库自动调用。 可以直接调用此方法,但还必须处理令牌缓存和令牌刷新。

Parameters:

request - 令牌请求的详细信息

Returns:

访问令牌

适用于