QueueClient.PeekMessagesAsync Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.20.1

Source:

QueueClient.cs

Retrieves one or more messages from the front of the queue but does not alter the visibility of the message.

For more information, see Peek Messages.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>> PeekMessagesAsync (int? maxMessages = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessagesAsync : Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>>
override this.PeekMessagesAsync : Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>>

Public Overridable Function PeekMessagesAsync (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PeekedMessage()))

Parameters

maxMessages

Nullable<Int32>

Optional. A nonzero integer value that specifies the number of messages to peek from the queue, up to a maximum of 32. By default, a single message is peeked from the queue with this operation.

cancellationToken

CancellationToken

Optional CancellationToken

Returns

Task<Response<PeekedMessage[]>>

Response<T> where T is an array of PeekedMessage