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

CredentialBuilderBase<T> 类

  • 参考
包:
com.azure.identity
Maven 项目:
com.azure:azure-identity:1.10.4
  • java.lang.Object
    • com.azure.identity.CredentialBuilderBase<T>

类型参数

T

凭据生成器的类型

实现

HttpTrait<T>

public abstract class CredentialBuilderBase
implements HttpTrait<T>

所有凭据生成器的基类。

方法摘要

修饰符和类型 方法和描述
T addPolicy(HttpPipelinePolicy policy)

添加 ， HttpPipelinePolicy 以应用于发送的每个请求。
T clientOptions(ClientOptions clientOptions)

允许设置常见属性，例如应用程序 ID、标头、代理配置等。
T configuration(Configuration configuration)

设置在构造凭据期间使用的配置存储。
T enableAccountIdentifierLogging()

允许在客户端上记录帐户标识符以进行调试/监视。
T httpClient(HttpClient client)

设置用于向/从服务发送和接收请求的 HTTP 客户端。
T httpLogOptions(HttpLogOptions logOptions)

设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。
T httpPipeline(HttpPipeline httpPipeline)

已放弃

不推荐使用此方法。 请改用 pipeline(HttpPipeline pipeline)

指定要发送所有请求的 Http管道。
T maxRetry(int maxRetry)

指定身份验证请求失败时的最大重试次数。
T pipeline(HttpPipeline pipeline)

HttpPipeline设置要用于服务客户端的 。
T proxyOptions(ProxyOptions proxyOptions)

已放弃

改为在 上配置代理选项， HttpClient 然后使用 在凭据 httpClient(HttpClient client)上设置该客户端。

指定代理配置的选项。
T retryOptions(RetryOptions retryOptions)

RetryOptions设置通过客户端发出的所有请求的 。
T retryPolicy(RetryPolicy retryPolicy)

RetryPolicy设置发送每个请求时使用的 。
T retryTimeout(Function<Duration,Duration> retryTimeout)

指定一个函数，用于计算每个重试请求的超时秒数。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

addPolicy

public T addPolicy(HttpPipelinePolicy policy)

添加 ， HttpPipelinePolicy 以应用于发送的每个请求。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

policy - 一个 HttpPipelinePolicy。

Returns:

已配置策略的此生成器的更新实例。

clientOptions

public T clientOptions(ClientOptions clientOptions)

允许设置常见属性，例如应用程序 ID、标头、代理配置等。请注意，建议使用类的 HttpClientOptions 实例调用此方法， (基类) 的 ClientOptions 子类。 HttpClientOptions 子类提供更多适用于 HTTP 客户端的配置选项，这适用于实现此 HttpTrait 接口的任何类。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

clientOptions - 的已配置实例 HttpClientOptions。

Returns:

此生成器的更新实例，其中配置了客户端选项。

configuration

public T configuration(Configuration configuration)

设置在构造凭据期间使用的配置存储。 默认配置存储区是 的 global configuration store克隆。

Parameters:

configuration - 用于从中加载 Env 变量和/或属性的配置存储。

Returns:

此生成器的更新实例，其中配置存储按指定设置。

enableAccountIdentifierLogging

public T enableAccountIdentifierLogging()

允许在客户端上记录帐户标识符以进行调试/监视。 默认禁用此项。

帐户标识符日志可以包含敏感信息，并且只能在受保护的计算机上启用。 成功检索访问令牌时，启用此日志会记录信息级别的应用程序 ID、对象 ID、租户 ID 和用户主体名称。 确保启用 INFO 级别日志以查看帐户标识符日志。

Returns:

此生成器的更新实例。

httpClient

public T httpClient(HttpClient client)

设置用于向/从服务发送和接收请求的 HTTP 客户端。

Parameters:

client - 用于请求的 HTTP 客户端。

Returns:

此生成器的更新实例，其中设置了指定的 http 客户端。

httpLogOptions

public T httpLogOptions(HttpLogOptions logOptions)

设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。 logLevel如果未提供 ，则设置 的默认值HttpLogDetailLevel#NONE。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

logOptions - 在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。

Returns:

此生成器的更新实例，其中配置了 Http 日志选项。

httpPipeline

@Deprecated
public T httpPipeline(HttpPipeline httpPipeline)

已放弃

不推荐使用此方法。 请改用 pipeline(HttpPipeline pipeline)

指定用于发送所有请求的 HttpPipeline。 此设置将替代其他设置。

Parameters:

httpPipeline - 用于发送所有请求的 HttpPipeline

Returns:

此生成器的更新实例，其中设置了指定的 http 管道。

maxRetry

public T maxRetry(int maxRetry)

指定身份验证请求失败时的最大重试次数。

Parameters:

maxRetry - 重试次数

Returns:

此生成器的更新实例，其中指定了最大重试时间。

pipeline

public T pipeline(HttpPipeline pipeline)

HttpPipeline设置要用于服务客户端的 。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

pipeline - HttpPipeline 用于发送服务请求和接收响应。

Returns:

此生成器的更新实例，其中设置了指定的 http 管道。

proxyOptions

@Deprecated
public T proxyOptions(ProxyOptions proxyOptions)

已放弃

改为在 上配置代理选项， HttpClient 然后使用 在凭据 httpClient(HttpClient client)上设置该客户端。

指定代理配置的选项。

Parameters:

proxyOptions - 代理配置选项

Returns:

此生成器的更新实例，其中设置了指定的代理选项。

retryOptions

public T retryOptions(RetryOptions retryOptions)

RetryOptions设置通过客户端发出的所有请求的 。

注意： 了解 HttpTrait API 的优先顺序非常重要。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则根据提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果 HttpPipeline 指定 了 ，这些 API 也会被忽略，因此请务必参考实现此特征的类型的文档，以了解完整的一组影响。

使用 设置此项是互斥的 retryPolicy(RetryPolicy retryPolicy)。

Parameters:

retryOptions - RetryOptions用于通过客户端发出的所有请求的 。

Returns:

配置了重试选项的此生成器的更新实例。

retryPolicy

public T retryPolicy(RetryPolicy retryPolicy)

RetryPolicy设置发送每个请求时使用的 。 使用 设置此项是互斥的 retryOptions(RetryOptions retryOptions)。 如果未提供，则将在管道中使用默认重试策略。

Parameters:

retryPolicy - 应用于每个请求的用户重试策略。

Returns:

已配置重试策略的此生成器的更新实例。

retryTimeout

public T retryTimeout(Function retryTimeout)

指定一个函数，用于计算每个重试请求的超时秒数。

Parameters:

retryTimeout - 在给定重试次数的情况下返回超时的函数（以秒为单位）

Returns:

此生成器的更新实例，其中设置了指定的重试超时。

适用于