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

ServiceBusAdministrationClientBuilder 类

包:

com.azure.messaging.servicebus.administration

Maven 项目:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder

实现

AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder> ConfigurationTrait<ServiceBusAdministrationClientBuilder> ConnectionStringTrait<ServiceBusAdministrationClientBuilder> EndpointTrait<ServiceBusAdministrationClientBuilder> HttpTrait<ServiceBusAdministrationClientBuilder> TokenCredentialTrait<ServiceBusAdministrationClientBuilder>

public final class ServiceBusAdministrationClientBuilder
implements TokenCredentialTrait<ServiceBusAdministrationClientBuilder>, AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder>, ConnectionStringTrait<ServiceBusAdministrationClientBuilder>, HttpTrait<ServiceBusAdministrationClientBuilder>, ConfigurationTrait<ServiceBusAdministrationClientBuilder>, EndpointTrait<ServiceBusAdministrationClientBuilder>

此类提供 Fluent 生成器 API 来帮助配置和实例化 ServiceBusAdministrationClient 和 ServiceBusAdministrationAsyncClient。 分别调用 buildClient() 和 buildAsyncClient() 以构造所需客户端的实例。

需要凭据才能对Azure 服务总线执行操作。 可以使用以下方法之一设置它们：

• connectionString(String connectionString)与服务总线命名空间连接字符串。
• credential(String fullyQualifiedNamespace, TokenCredential credential) 替换为完全限定的服务总线命名空间和一组授权使用该命名空间的凭据。
• credential(TokenCredential credential) 和 credential(AzureSasCredential credential) 重载可以与其各自的凭据一起使用。 此外， endpoint(String endpoint) 必须设置。

以下示例 DefaultAzureCredential 中使用的凭据用于身份验证。 它适用于大多数方案，包括本地开发和生产环境。 此外，我们建议使用 托管标识 在生产环境中进行身份验证。 可以在 Azure 标识文档中找到有关不同身份验证方式及其相应凭据类型的详细信息。

示例：创建同步客户端

以下代码示例演示如何创建同步管理客户端。

HttpLogOptions logOptions = new HttpLogOptions()
     .setLogLevel(HttpLogDetailLevel.HEADERS);

 // DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, tokenCredential)
     .httpLogOptions(logOptions)
     .buildClient();

示例：使用 Azure 标识创建异步客户端

下面的代码示例演示如何创建异步管理客户端。

// DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

示例：创建异步客户端

以下代码示例演示如何创建配置了重试选项和 HTTP 日志选项的异步管理客户端。

// DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 RetryOptions retryOptions = new RetryOptions(new FixedDelayOptions(4, Duration.ofSeconds(20)));

 // "<<fully-qualified-namespace>>" will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
     .credential("<<fully-qualified-namespace>>", credential)
     .retryOptions(retryOptions)
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.HEADERS))
     .buildAsyncClient();

构造函数摘要

构造函数	说明
ServiceBusAdministrationClientBuilder()	使用默认参数构造生成器。

方法摘要

修饰符和类型	方法和描述
ServiceBusAdministrationClientBuilder	addPolicy(HttpPipelinePolicy policy) 添加 ， HttpPipelinePolicy 以应用于发送的每个请求。
ServiceBusAdministrationAsyncClient	buildAsyncClient() ServiceBusAdministrationAsyncClient基于生成器中设置的选项创建 。
ServiceBusAdministrationClient	buildClient() ServiceBusAdministrationClient基于生成器中设置的选项创建 。
ServiceBusAdministrationClientBuilder	clientOptions(ClientOptions clientOptions) 允许设置常见属性，例如应用程序 ID、标头、代理配置等。
ServiceBusAdministrationClientBuilder	configuration(Configuration configuration) 设置在构造服务客户端期间使用的配置存储。
ServiceBusAdministrationClientBuilder	connectionString(String connectionString) 设置服务总线命名空间或特定服务总线资源的连接字符串。
ServiceBusAdministrationClientBuilder	credential(AzureSasCredential credential) 为服务总线资源设置具有共享访问签名的凭据。
ServiceBusAdministrationClientBuilder	credential(TokenCredential credential) TokenCredential设置用于授权发送到服务的请求的 。
ServiceBusAdministrationClientBuilder	credential(String fullyQualifiedNamespace, TokenCredential credential) 设置用于对服务总线命名空间的 HTTP 请求进行身份验证的凭据。
ServiceBusAdministrationClientBuilder	endpoint(String endpoint) 设置服务总线命名空间的服务终结点。
ServiceBusAdministrationClientBuilder	httpClient(HttpClient client) HttpClient设置用于向/从服务发送和接收请求的 。
ServiceBusAdministrationClientBuilder	httpLogOptions(HttpLogOptions logOptions) 设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。
ServiceBusAdministrationClientBuilder	pipeline(HttpPipeline pipeline) HttpPipeline设置要用于服务客户端的 。
ServiceBusAdministrationClientBuilder	retryOptions(RetryOptions retryOptions) RetryOptions为通过客户端发出的所有请求设置 。
ServiceBusAdministrationClientBuilder	retryPolicy(HttpPipelinePolicy retryPolicy) HttpPipelinePolicy设置发送每个请求时使用的 。
ServiceBusAdministrationClientBuilder	serviceVersion(ServiceBusServiceVersion serviceVersion) ServiceBusServiceVersion设置使用的 。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

ServiceBusAdministrationClientBuilder

public ServiceBusAdministrationClientBuilder()

使用默认参数构造生成器。

方法详细信息

addPolicy

public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

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

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

Parameters:

policy - 一个 HttpPipelinePolicy。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

buildAsyncClient

public ServiceBusAdministrationAsyncClient buildAsyncClient()

ServiceBusAdministrationAsyncClient基于生成器中设置的选项创建 。 每次 buildAsyncClient 调用 时，都会创建客户端的新实例。

如果 pipeline(HttpPipeline pipeline) 设置了 ，则 pipeline 使用 和 endpoint(String endpoint) 创建 ServiceBusAdministrationAsyncClient。 将忽略所有其他生成器设置。

Returns:

在 ServiceBusAdministrationAsyncClient 生成器中设置了选项的 。

buildClient

public ServiceBusAdministrationClient buildClient()

ServiceBusAdministrationClient基于生成器中设置的选项创建 。 每次 buildClient 调用 时，都会创建客户端的新实例。

如果 pipeline(HttpPipeline pipeline) 设置了 ，则 pipeline 使用 和 endpoint(String endpoint) 创建 ServiceBusAdministrationClient。 将忽略所有其他生成器设置。

Returns:

在 ServiceBusAdministrationClient 生成器中设置了选项的 。

clientOptions

public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

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

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

Parameters:

clientOptions - 的已配置实例 HttpClientOptions。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

configuration

public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

设置在构造服务客户端期间使用的配置存储。 默认配置存储区是 的 global configuration store克隆，用于 NONE 在构造过程中绕过使用配置设置。

Parameters:

configuration - 用于

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

connectionString

public ServiceBusAdministrationClientBuilder connectionString(String connectionString)

设置服务总线命名空间或特定服务总线资源的连接字符串。

Parameters:

connectionString - 服务总线命名空间或特定服务总线资源的连接字符串。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

credential

public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

为服务总线资源设置具有共享访问签名的凭据。 请参阅 使用共享访问签名的服务总线访问控制。

Parameters:

credential - AzureSasCredential 用于身份验证。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

credential

public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

TokenCredential设置用于授权发送到服务的请求的 。 有关正确使用 TokenCredential 类型的更多详细信息，请参阅 Azure SDK for Java 标识和身份验证文档。

Parameters:

credential - TokenCredential 用于授权发送到服务的请求。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

credential

public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

设置用于对服务总线命名空间的 HTTP 请求进行身份验证的凭据。

Parameters:

fullyQualifiedNamespace - 服务总线的 。

credential - TokenCredential 用于身份验证。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

endpoint

public ServiceBusAdministrationClientBuilder endpoint(String endpoint)

设置服务总线命名空间的服务终结点。

Parameters:

endpoint - 服务总线命名空间的 URL。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

httpClient

public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

HttpClient设置用于向/从服务发送和接收请求的 。

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

Parameters:

client - 要 HttpClient 用于请求的 。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

httpLogOptions

public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

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

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

Parameters:

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

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

pipeline

public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

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

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

endpoint(String endpoint)设置 时pipeline不会忽略 。

Parameters:

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

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

retryOptions

public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

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

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

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

Parameters:

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

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

retryPolicy

public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

HttpPipelinePolicy设置发送每个请求时使用的 。 如果未提供 buildAsyncClient() 用于生成 ServiceBusAdministrationClient 或 ServiceBusAdministrationAsyncClient，将使用默认重试策略。 设置此项与使用 是互斥的 retryOptions(RetryOptions retryOptions)。

Parameters:

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

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。

serviceVersion

public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

ServiceBusServiceVersion设置使用的 。 默认情况下 getLatest() ，如果未指定任何值，则使用 。

Parameters:

serviceVersion - 要使用的服务版本。

Returns:

已更新的 ServiceBusAdministrationClientBuilder 对象。