你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
KeyClientBuilder 类
- java.
lang. Object - com.
azure. security. keyvault. keys. KeyClientBuilder
- com.
实现
public final class KeyClientBuilder
implements TokenCredentialTrait<KeyClientBuilder>, HttpTrait<KeyClientBuilder>, ConfigurationTrait<KeyClientBuilder>
此类提供 Fluent 生成器 API，通过分别调用 和 来帮助配置和实例化 KeyAsyncClient 和 KeyClientbuildClient() 。buildAsyncClient() 它构造所需客户端的实例。
生成KeyAsyncClient所需的KeyClientBuilder最小配置选项是 vaultUrl 和 TokenCredential。
KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
可以选择在 log detail level中KeyClientBuilder配置 、多个自定义policies和自定义HttpClient。
KeyAsyncClient keyAsyncClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
.httpClient(HttpClient.createDefault())
.buildAsyncClient();
生成KeyClient所需的KeyClientBuilder最小配置选项是 vaultUrl 和 TokenCredential。
KeyClient keyClient = new KeyClientBuilder()
.vaultUrl("<your-key-vault-url>")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
构造函数摘要
| 构造函数 | 说明 |
|---|---|
| KeyClientBuilder() |
具有默认值的构造函数。 |
方法摘要
方法继承自 java.lang.Object
构造函数详细信息
KeyClientBuilder
public KeyClientBuilder()
具有默认值的构造函数。
方法详细信息
addPolicy
public KeyClientBuilder addPolicy(HttpPipelinePolicy policy)
添加 ， HttpPipelinePolicy 以应用于发送的每个请求。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
Parameters:
Returns:
buildAsyncClient
public KeyAsyncClient buildAsyncClient()
KeyAsyncClient基于生成器中设置的选项创建 。 每次 buildAsyncClient() 调用 时，都会创建 的新 KeyAsyncClient 实例。
如果 pipeline(HttpPipeline pipeline) 设置了 ，则 pipeline 使用 和 vaultUrl(String vaultUrl) 创建 KeyClientBuilder。 将忽略所有其他生成器设置。 如果未 pipeline 设置 ，则需要 credential(TokenCredential credential) 和 vaultUrl(String vaultUrl) 密钥保管库 URL 来生成 KeyAsyncClient。
Returns:
buildClient
public KeyClient buildClient()
KeyClient基于生成器中设置的选项创建 。 每次 buildClient() 调用 时，都会创建 的新 KeyClient 实例。
如果 pipeline(HttpPipeline pipeline) 设置了 ，则 pipeline 使用 和 vaultUrl(String vaultUrl) 创建 KeyClientBuilder。 将忽略所有其他生成器设置。 如果未 pipeline 设置 ，则需要 credential(TokenCredential credential) 和 vaultUrl(String vaultUrl) 来生成 KeyClient。
Returns:
clientOptions
public KeyClientBuilder clientOptions(ClientOptions clientOptions)
允许设置常见属性，例如应用程序 ID、标头、代理配置等。请注意，建议使用类的 HttpClientOptions 实例调用此方法， (基类) 的 ClientOptions 子类。 HttpClientOptions 子类提供更多适用于 HTTP 客户端的配置选项，这适用于实现此 HttpTrait 接口的任何类。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
Parameters:
Returns:
configuration
public KeyClientBuilder configuration(Configuration configuration)
设置在构造服务客户端期间使用的配置存储。 默认配置存储区是 的 global configuration store克隆，用于 NONE 在构造过程中绕过使用配置设置。
Parameters:
Returns:
credential
public KeyClientBuilder credential(TokenCredential credential)
TokenCredential设置用于授权发送到服务的请求的 。 有关正确使用 TokenCredential 类型的更多详细信息，请参阅 Azure SDK for Java 标识和身份验证文档。
Parameters:
Returns:
disableChallengeResourceVerification
public KeyClientBuilder disableChallengeResourceVerification()
禁用验证身份验证质询资源是否与密钥保管库或托管 HSM 域匹配。 默认情况下会执行此验证。
Returns:
httpClient
public KeyClientBuilder httpClient(HttpClient client)
HttpClient设置用于向/从服务发送和接收请求的 。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
Parameters:
Returns:
httpLogOptions
public KeyClientBuilder httpLogOptions(HttpLogOptions logOptions)
设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。 logLevel如果未提供 ，则设置 的默认值HttpLogDetailLevel#NONE。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
Parameters:
Returns:
pipeline
public KeyClientBuilder pipeline(HttpPipeline pipeline)
HttpPipeline设置要用于服务客户端的 。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
vaultUrl(String vaultUrl)设置 时pipeline不会忽略 。
Parameters:
Returns:
retryOptions
public KeyClientBuilder retryOptions(RetryOptions retryOptions)
RetryOptions为通过客户端发出的所有请求设置 。
注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。
设置此项与使用 是互斥的 retryPolicy(RetryPolicy retryPolicy)。
Parameters:
Returns:
retryPolicy
public KeyClientBuilder retryPolicy(RetryPolicy retryPolicy)
RetryPolicy设置发送每个请求时使用的 。 如果未提供，将在管道中使用默认重试策略。 设置此项与使用 是互斥的 retryOptions(RetryOptions retryOptions)。
Parameters:
Returns:
serviceVersion
public KeyClientBuilder serviceVersion(KeyServiceVersion version)
设置发出 KeyServiceVersion API 请求时使用的 。
如果未提供服务版本，将使用的服务版本将是基于正在使用的客户端库版本的最新已知服务版本。 如果未指定服务版本，更新到客户端库的较新版本可能会移动到较新的服务版本。
Parameters:
Returns:
vaultUrl
public KeyClientBuilder vaultUrl(String vaultUrl)
设置要向其发送 HTTP 请求的保管库终结点 URL。 应验证此 URL 引用有效的 密钥保管库 或托管 HSM 资源。 有关详细信息，请参阅以下 文档 。
Parameters:
vaultUrl 和其他信息。
Returns:
