Share via

QueueClient.PeekMessage(CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Storage.Queues
Assembly:
Azure.Storage.Queues.dll
Package:
Azure.Storage.Queues v12.18.0
Package:
Azure.Storage.Queues v12.18.0-beta.2
Source:
QueueClient.cs
Source:
QueueClient.cs

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

For more information, see Peek Messages.

public virtual Azure.Response<Azure.Storage.Queues.Models.PeekedMessage> PeekMessage (System.Threading.CancellationToken cancellationToken = default);
abstract member PeekMessage : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>
override this.PeekMessage : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>
Public Overridable Function PeekMessage (Optional cancellationToken As CancellationToken = Nothing) As Response(Of PeekedMessage)

Parameters

cancellationToken
CancellationToken

Optional CancellationToken

Returns

Response<PeekedMessage>

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

Applies to