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

ServiceBusReceiveActions.ReceiveMessagesAsync 方法

定义

命名空间:

Microsoft.Azure.WebJobs.ServiceBus

程序集:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

包:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.1

Source:

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>>

收到的消息列表。 如果未找到消息，则返回空列表。