通过

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

SubscriptionClient 类

  • 参考

定义

命名空间:
Microsoft.ServiceBus.Messaging
程序集:
Microsoft.ServiceBus.dll
包:
WindowsAzure.ServiceBus v6.2.2

表示在与主题订阅相关的运行时操作中使用的定位点类。

public abstract class SubscriptionClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient
type SubscriptionClient = class
    inherit MessagingEntityClient
Public MustInherit Class SubscriptionClient
Inherits MessagingEntityClient
继承
Object
ClientEntity
MessagingEntityClient
SubscriptionClient

示例

// Create subscription client
SubscriptionClient mySubscriptionClient = 
factory.CreateSubscriptionClient(mySubscription);

// Receive messages
for (int count = 0; count < MsgCount; count++)
{
    var message = mySubscriptionClient.Receive();
    message.Complete();
}

属性

IsClosed

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
MessagingFactory

获取用于创建此订阅客户端的消息工厂。
Mode

获取处理收到的消息时的消息接收模式。
Name

获取订阅的名称。
Path

获取队列、主题或订阅相对于 MessagingFactory 基址的路径。

(继承自 MessagingEntityClient)
PrefetchCount

获取或设置消息接收方可以同时请求的消息数。
RetryPolicy

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
ThisLock

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
TopicPath

获取主题的完整路径名。

方法

Abandon(Guid)

放弃消息并放弃消息锁的所有权。
Abandon(Guid, IDictionary<String,Object>)

放弃消息并放弃消息锁的所有权。
AbandonAsync(Guid)

异步放弃消息并放弃消息锁所有权。
AbandonAsync(Guid, IDictionary<String,Object>)

异步放弃消息并放弃消息锁所有权。
Abort()

对消息传送实体执行中止功能。

(继承自 ClientEntity)
AcceptMessageSession()

接受一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSession(Boolean)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(Boolean, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(String)

接受允许使用给定会话标识符在单个事务中处理的相关消息分组的消息会话。
AcceptMessageSession(String, Boolean)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(String, Boolean, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(String, Guid)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(String, Guid, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSession(String, TimeSpan)

接受一个消息会话，该会话允许使用给定的会话标识符和等待时间对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSession(TimeSpan)

接受一个消息会话，该会话允许使用指定的服务器等待时间对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSessionAsync()

异步接受一个消息会话，该会话允许使用指定的服务器等待时间对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSessionAsync(Boolean)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(Boolean, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(String)

异步接受一个消息会话，该会话允许使用指定的服务器等待时间对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSessionAsync(String, Boolean)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(String, Boolean, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(String, Guid)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(String, Guid, TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。
AcceptMessageSessionAsync(String, TimeSpan)

异步接受一个消息会话，该会话允许使用指定的服务器等待时间对相关消息进行分组，以便在单个事务中进行处理。
AcceptMessageSessionAsync(TimeSpan)

异步接受一个消息会话，该会话允许使用指定的服务器等待时间对相关消息进行分组，以便在单个事务中进行处理。
AddRule(RuleDescription)

使用指定的规则说明将新规则添加到 SubscriptionDescription 。
AddRule(String, Filter)

使用指定名称和筛选器表达式将规则添加到当前订阅。
AddRuleAsync(RuleDescription)

使用指定的规则说明以异步方式将新规则添加到 。SubscriptionDescription
AddRuleAsync(String, Filter)

以异步方式将具有指定名称和筛选器表达式的规则添加到当前订阅。
Close()

向服务总线发送清理消息，以指示实体的使用完成。

(继承自 ClientEntity)
CloseAsync()

以异步方式将清理消息发送到服务总线，以指示实体的使用完成。

(继承自 ClientEntity)
Complete(Guid)

完成消息的处理。
CompleteAsync(Guid)

异步完成消息的处理。
CompleteBatch(IEnumerable<Guid>)

完成批处理的处理。
CompleteBatchAsync(IEnumerable<Guid>)

异步完成批处理的处理。
Create(String, String)

创建具有指定名称和主题路径的新副本 SubscriptionClient 。
Create(String, String, ReceiveMode)

使用指定的名称、主题路径和模式创建 的新副本 SubscriptionClient 。
CreateFromConnectionString(String, String, String)

从具有指定主题路径和名称的连接字符串创建 的新副本 SubscriptionClient 。
CreateFromConnectionString(String, String, String, ReceiveMode)

从具有指定主题路径、名称和模式的连接字符串创建 的新副本 SubscriptionClient 。
CreateWithAzureActiveDirectory(Uri, String, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

使用身份验证回调 创建 的新实例 SubscriptionClient 。
CreateWithManagedIdentity(Uri, String, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

使用 Azure 托管标识身份验证创建 的新 SubscriptionClient 实例。
DeadLetter(Guid)

将未传递的消息移动到死信队列。
DeadLetter(Guid, IDictionary<String,Object>)

将未传递的消息移动到死信队列。
DeadLetter(Guid, String, String)

将未传递的消息移动到死信队列。
DeadLetterAsync(Guid)

异步将未传递的消息移动到死信队列。
DeadLetterAsync(Guid, IDictionary<String,Object>)

异步将未传递的消息移动到死信队列。
DeadLetterAsync(Guid, String, String)

异步将未传递的消息移动到死信队列。
Defer(Guid)

暂停消息的处理。
Defer(Guid, IDictionary<String,Object>)

暂停消息的处理。
DeferAsync(Guid)

异步挂起消息的处理。
DeferAsync(Guid, IDictionary<String,Object>)

异步挂起消息的处理。
Fault()

仅限内部使用。 请勿从此类继承。

(继承自 ClientEntity)
FormatDeadLetterPath(String, String)

使用指定的主题路径和订阅名称生成格式名称死信路径。
FormatSubscriptionPath(String, String)

使用指定的主题路径和订阅名称生成格式名称订阅路径。
GetMessageSessions()

获取一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
GetMessageSessions(DateTime)

检索自 以来 lastUpdatedTime会话状态已更新的所有消息会话。
GetMessageSessionsAsync()

异步获取一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
GetMessageSessionsAsync(DateTime)

异步获取一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
OnAbort()

执行中止操作。
OnBeginAcceptMessageSession(String, ReceiveMode, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object)

调用 BeginAcceptMessageSession 操作时执行。
OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)

调用 BeginAddRule 操作时执行。
OnBeginClose(TimeSpan, AsyncCallback, Object)

执行开始关闭操作。
OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

执行开始创建接收器操作。
OnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)

执行开始创建接收器操作。
OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

调用 BeginGetMessageSessions 操作时执行。
OnBeginGetRules(Int32, Int32, TimeSpan, AsyncCallback, Object)

表示在与主题订阅相关的运行时操作中使用的定位点类。
OnBeginOpen(TimeSpan, AsyncCallback, Object)

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)

开始通过运行时客户端协议从 SubscriptionDescription 中删除 RuleDescription 。
OnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object)

使用 标记通过运行时客户端协议开始从 SubscriptionDescription 中删除 RuleDescription 。
OnClose(TimeSpan)

执行关闭操作。
OnClosed()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
OnEndAcceptMessageSession(IAsyncResult)

调用 EndAcceptMessageSession 操作时执行。
OnEndAddRule(IAsyncResult)

结束对 的 OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)异步调用。
OnEndClose(IAsyncResult)

执行结束关闭操作。
OnEndCreateReceiver(IAsyncResult)

执行结束创建接收器操作。
OnEndGetMessageSessions(IAsyncResult)

执行结束获取消息操作。
OnEndGetRules(IAsyncResult)

表示在与主题订阅相关的运行时操作中使用的定位点类。
OnEndOpen(IAsyncResult)

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
OnEndRemoveRule(IAsyncResult)

结束对 的 OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)异步调用。
OnEndRemoveRules(IAsyncResult)

结束对 的 OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)异步调用。
OnFaulted()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
OnMessage(Action<BrokeredMessage>)

在事件驱动的消息泵中处理消息。
OnMessage(Action<BrokeredMessage>, OnMessageOptions)

使用给定的一组 OnMessageOptions 选项在事件驱动的消息泵中处理消息。
OnMessageAsync(Func<BrokeredMessage,Task>)

异步处理消息。
OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

异步处理消息。
OnOpen(TimeSpan)

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
OnOpened()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
Peek()

返回 ，但不删除队列中的第一条消息。
Peek(Int64)

返回 ，但不删除队列中的第一条消息。
PeekAsync()

在不删除队列中的第一条消息的情况下异步返回。
PeekAsync(Int64)

在不删除队列中的第一条消息的情况下异步返回。
PeekBatch(Int32)

返回 ，但不删除批中的第一条消息。
PeekBatch(Int64, Int32)

返回 ，但不删除批中的第一条消息。
PeekBatchAsync(Int32)

在不删除批中的第一条消息的情况下异步返回。
PeekBatchAsync(Int64, Int32)

在不删除批中的第一条消息的情况下异步返回。
Receive()

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver接收消息。
Receive(Int64)

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver接收延迟消息。 此方法仅适用于延迟消息，不适用于常规消息。
Receive(TimeSpan)

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver接收消息。
ReceiveAsync()

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver异步接收消息。
ReceiveAsync(Int64)

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver异步接收消息。 此方法仅适用于延迟消息，不适用于常规消息。
ReceiveAsync(TimeSpan)

使用 Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver异步接收消息。
ReceiveBatch(IEnumerable<Int64>)

在异步操作后接收批。
ReceiveBatch(Int32)

在异步操作后接收批。
ReceiveBatch(Int32, TimeSpan)

在异步操作后接收批。
ReceiveBatchAsync(IEnumerable<Int64>)

异步接收一组 (用于批处理) 的消息。
ReceiveBatchAsync(Int32)

异步接收一组 (用于批处理) 的消息。
ReceiveBatchAsync(Int32, TimeSpan)

异步接收一组 (用于批处理) 的消息。
RegisterSessionHandler(Type)

注册客户端会话的处理程序。
RegisterSessionHandler(Type, SessionHandlerOptions)

注册客户端会话的处理程序。
RegisterSessionHandlerAsync(Type)

异步注册客户端会话的处理程序。
RegisterSessionHandlerAsync(Type, SessionHandlerOptions)

异步注册客户端会话的处理程序。
RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

为客户端会话注册处理程序工厂。
RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

为客户端会话注册处理程序工厂。
RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

异步注册客户端会话的处理程序工厂。
RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

异步注册客户端会话的处理程序工厂。
RemoveRule(String)

删除 由 ruleName描述的规则。
RemoveRuleAsync(String)

异步删除 所述的 ruleName规则。
RenewMessageLock(Guid)

表示在与主题订阅相关的运行时操作中使用的定位点类。
RenewMessageLockAsync(Guid)

表示在与主题订阅相关的运行时操作中使用的定位点类。
ThrowIfClosed()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
ThrowIfDisposed()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
ThrowIfDisposedOrImmutable()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
ThrowIfDisposedOrNotOpen()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)
ThrowIfFaulted()

表示在与主题订阅相关的运行时操作中使用的定位点类。

(继承自 ClientEntity)

适用于