QueueClient.PeekMessages(Nullable<Int32>, CancellationToken) Method

Definition

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.

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

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

Response<T> where T is an array of PeekedMessage

Applies to

Продукт Версии
Azure SDK for .NET Latest, Preview