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

ServiceBusReceiver.PeekMessageAsync 方法

定义

命名空间:

Azure.Messaging.ServiceBus

程序集:

Azure.Messaging.ServiceBus.dll

包:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

提取下一个活动状态 ServiceBusReceivedMessage ，而不更改接收方或消息源的状态。

public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> PeekMessageAsync (long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>

Public Overridable Function PeekMessageAsync (Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)

参数

fromSequenceNumber

Nullable<Int64>

从中查看消息的可选序列号。 这对应于 SequenceNumber。

cancellationToken

CancellationToken

一个可选 CancellationToken 实例，用于发出取消操作的请求信号。

返回

Task<ServiceBusReceivedMessage>

表示 ServiceBusReceivedMessage 要读取的下一条消息的 。 当无可窥视时返回 null。

注解

对 的第一次调用 PeekMessageAsync(Nullable<Int64>, CancellationToken) 将提取此接收方的第一条活动消息。 每个后续调用都会提取实体中的后续消息。 与收到的消息不同，速览消息不会与它关联锁定令牌，因此它不能为 Completed/Abandoned/Deferred/Deadlettered/Renewed。 此外，与 不同 ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)，此方法甚至会提取 (的延迟消息，但不会提取死信) 。