ServiceBusReceiver.PeekMessagesAsync メソッド

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync (int maxMessages, long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>

Public Overridable Function PeekMessagesAsync (maxMessages As Integer, Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

パラメーター

maxMessages

Int32

フェッチされるメッセージの最大数。

fromSequenceNumber

Nullable<Int64>

メッセージをピークする場所からの省略可能なシーケンス番号。 これは に対応します SequenceNumber。

cancellationToken

CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。

戻り値

Task<IReadOnlyList<ServiceBusReceivedMessage>>

IReadOnlyList<T>ピークされたメッセージの 。

注釈

受信したメッセージとは異なり、ピークされたメッセージにはロック トークンが関連付けられていないため、Completed/Abandoned/Deferred/Deadlettered/Renewed にすることはできません。 また、 とは異なり ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)、このメソッドは遅延メッセージもフェッチします (ただし、配信不能メッセージはフェッチしません)。