QueueClient.PeekMessage(CancellationToken) Method

Definition

Retrieves one message 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> PeekMessage(System.Threading.CancellationToken cancellationToken = default);

Parameters

cancellationToken
CancellationToken

Optional CancellationToken

Returns

Response<T> where T is a PeekedMessage. Returns null if there are no messages in the queue.

Applies to

Product Versions
Azure SDK for .NET Latest, Preview