ServiceBusReceiveActions.ReceiveMessagesAsync メソッド

定義

名前空間:

Microsoft.Azure.WebJobs.ServiceBus

アセンブリ:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

パッケージ:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.0

ソース:

ServiceBusReceiveActions.cs

エンティティから の ServiceBusReceivedMessage 一覧を受け取ります。 このメソッドは、キューまたはトピックに使用可能なメッセージがあるmaxMessages場合でも、正確なmaxMessagesメッセージを返す保証はありません。 このメソッドを使用して受信したメッセージは、 で定義されている動作の AutoCompleteMessages対象となります。 このメソッドが単一ディスパッチ関数で使用される場合、受信したメッセージは の MaxAutoLockRenewalDuration対象になります。

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

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

Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

パラメーター

maxMessages

Int32

受信するメッセージの最大数。

maxWaitTime

Nullable<TimeSpan>

使用可能なメッセージがない場合に空のリストを返す前に、最初のメッセージを待機する最大時間を指定する省略可能 TimeSpan です。 指定しない場合は、 が TryTimeout 使用されます。

cancellationToken

CancellationToken

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

戻り値

Task<IReadOnlyList<ServiceBusReceivedMessage>>

受信したメッセージの一覧。 メッセージが見つからない場合は、空のリストを返します。