SubscriptionClient.PeekBatchAsync Method

Definition

Overloads

PeekBatchAsync(Int32)

Asynchronously returns without removing the first messages in a batch.

PeekBatchAsync(Int64, Int32)

Asynchronously returns without removing the first messages in a batch.

PeekBatchAsync(Int32)

Asynchronously returns without removing the first messages in a batch.

public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (int messageCount);
abstract member PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
Public Function PeekBatchAsync (messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))

Parameters

messageCount
Int32

The number of messages in a batch.

Returns

Task<IEnumerable<BrokeredMessage>>

A task instance that represents the asynchronous peek batch operation.

Implements

Microsoft.ServiceBus.Messaging.IMessageBrowser.PeekBatchAsync(System.Int32)

Applies to

Product Introduced

PeekBatchAsync(Int64, Int32)

Asynchronously returns without removing the first messages in a batch.

public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (long fromSequenceNumber, int messageCount);
abstract member PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
Public Function PeekBatchAsync (fromSequenceNumber As Long, messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))

Parameters

fromSequenceNumber
Int64

The starting point from which to browse a message.

messageCount
Int32

The number of messages in a batch.

Returns

Task<IEnumerable<BrokeredMessage>>

A task instance that represents the asynchronous peek batch operation.

Implements

Microsoft.ServiceBus.Messaging.IMessageBrowser.PeekBatchAsync(System.Int64,System.Int32)

Applies to

Product Introduced