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

ServiceBusClient 类

定义

命名空间:

Azure.Messaging.ServiceBus

程序集:

Azure.Messaging.ServiceBus.dll

包:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusClient.cs

ServiceBusClient是可以与之交互的所有服务总线实体的顶级客户端。 从此处检索到的任何较低级别类型（如 ServiceBusSender 和 ServiceBusReceiver ）将共享相同的 AMQP 连接。 释放 ServiceBusClient 将导致 AMQP 连接关闭。

public class ServiceBusClient : IAsyncDisposable

type ServiceBusClient = class
    interface IAsyncDisposable

Public Class ServiceBusClient
Implements IAsyncDisposable

继承

Object

ServiceBusClient

实现

IAsyncDisposable

注解

ServiceBusClient在应用程序的生存期内可以安全地缓存和使用 ，这是应用程序定期或半定期使用服务总线时的最佳做法。 客户端负责确保高效使用网络、CPU 和内存。 在应用程序关闭时调用 DisposeAsync() 可确保正确清理网络资源和其他非托管对象。

构造函数

ServiceBusClient()	可用于模拟。
ServiceBusClient(String)	初始化 ServiceBusClient 类的新实例。
ServiceBusClient(String, AzureNamedKeyCredential, ServiceBusClientOptions)	初始化 ServiceBusClient 类的新实例。
ServiceBusClient(String, AzureSasCredential, ServiceBusClientOptions)	初始化 ServiceBusClient 类的新实例。
ServiceBusClient(String, ServiceBusClientOptions)	初始化 ServiceBusClient 类的新实例。
ServiceBusClient(String, TokenCredential)	初始化 ServiceBusClient 类的新实例。
ServiceBusClient(String, TokenCredential, ServiceBusClientOptions)	初始化 ServiceBusClient 类的新实例。

属性

FullyQualifiedNamespace	与连接关联的完全限定的服务总线命名空间。 这可能类似于 {yournamespace}.servicebus.windows.net。
Identifier	用于标识此 ServiceBusClient的名称。
IsClosed	指示是否已关闭。ServiceBusClient
TransportType	用于此 ServiceBusClient的传输类型。

方法

AcceptNextSessionAsync(String, ServiceBusSessionReceiverOptions, CancellationToken)	创建一个 ServiceBusSessionReceiver 实例，该实例可用于通过接受包含活动消息的下一个解锁会话来接收和解决已启用会话的队列的消息。 如果没有具有活动消息的已解锁会话，则调用将在配置 TryTimeout 的值之后超时，并引发并将 ServiceBusExceptionReason 设置为 ServiceTimeout的 。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ，以配置消息的接收方式。 默认值为 PeekLock。
AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)	创建一个 ServiceBusSessionReceiver 实例，该实例可用于通过接受包含活动消息的下一个解锁会话来接收和解决已启用会话的订阅的消息。 如果没有具有活动消息的已解锁会话，则调用将在配置 TryTimeout 的值之后超时，并引发并将 ServiceBusExceptionReason 设置为 ServiceTimeout的 。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ，以配置消息的接收方式。 默认值为 PeekLock。
AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)	创建一个 ServiceBusSessionReceiver 实例，该实例可用于通过接受特定会话从已启用会话的队列接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ，以配置消息的接收方式。 默认值为 PeekLock。
AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)	创建一个 ServiceBusSessionReceiver 实例，该实例可用于通过接受特定会话从启用了会话的订阅接收和解决消息。 ServiceBusReceiveMode可以在 中ServiceBusReceiverOptions指定 ，以配置消息的接收方式。 默认值为 PeekLock。
CreateProcessor(String)	创建一个 ServiceBusProcessor 实例，该实例可用于使用处理器上设置的事件处理程序来处理消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 如果要更改 ， ServiceBusReceiveMode请使用 CreateProcessor(String, ServiceBusProcessorOptions) 方法。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
CreateProcessor(String, ServiceBusProcessorOptions)	创建一个 ServiceBusProcessor 实例，该实例可用于使用处理器上设置的事件处理程序来处理消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
CreateProcessor(String, String)	创建一个 ServiceBusProcessor 实例，该实例可用于使用处理器上设置的事件处理程序来处理消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 如果要更改 ， ServiceBusReceiveMode请使用 CreateProcessor(String, String, ServiceBusProcessorOptions) 方法。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
CreateProcessor(String, String, ServiceBusProcessorOptions)	创建一个 ServiceBusProcessor 实例，该实例可用于使用处理器上设置的事件处理程序来处理消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
CreateReceiver(String)	创建一个 ServiceBusReceiver 实例，该实例可用于从特定队列接收和解决消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 如果要更改 ， ServiceBusReceiveMode请使用 CreateReceiver(String, ServiceBusReceiverOptions) 方法。 ServiceBusReceiveMode在 中ServiceBusReceiverOptions设置 。
CreateReceiver(String, ServiceBusReceiverOptions)	创建一个 ServiceBusReceiver 实例，该实例可用于从特定队列接收和解决消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 ServiceBusReceiveMode在 中ServiceBusReceiverOptions设置 。
CreateReceiver(String, String)	ServiceBusReceiver创建可用于从特定订阅接收和解决消息的实例。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 如果要更改 ， ServiceBusReceiveMode请使用 CreateReceiver(String, String, ServiceBusReceiverOptions) 方法。 ServiceBusReceiveMode在 中ServiceBusReceiverOptions设置 。
CreateReceiver(String, String, ServiceBusReceiverOptions)	ServiceBusReceiver创建可用于从特定订阅接收和解决消息的实例。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 ServiceBusReceiveMode在 中ServiceBusReceiverOptions设置 。
CreateRuleManager(String, String)	ServiceBusRuleManager用于管理订阅的规则。
CreateSender(String)	ServiceBusSender创建可用于将消息发送到特定队列或主题的实例。
CreateSender(String, ServiceBusSenderOptions)	ServiceBusSender创建可用于将消息发送到特定队列或主题的实例。
CreateSessionProcessor(String, ServiceBusSessionProcessorOptions)	创建一个 ServiceBusSessionProcessor 实例，该实例可用于使用处理器上设置的事件处理程序处理会话消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
CreateSessionProcessor(String, String, ServiceBusSessionProcessorOptions)	创建一个 ServiceBusSessionProcessor 实例，该实例可用于使用处理器上设置的事件处理程序来处理消息。 它使用 ServiceBusReceiveMode 指定接收消息的方式。 默认为“PeekLock”模式。 在 ServiceBusReceiveMode 类型中 ServiceBusProcessorOptions 设置 。
DisposeAsync()	执行清理 使用 ServiceBusClient的资源所需的任务，包括确保客户端本身已关闭。