Dela via

QueueClient.PeekMessageAsync(CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Storage.Queues
Assembly:
Azure.Storage.Queues.dll
Package:
Azure.Storage.Queues v12.21.0
Package:
Azure.Storage.Queues v12.21.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 System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>> PeekMessageAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member PeekMessageAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>>
override this.PeekMessageAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.PeekedMessage>>
Public Overridable Function PeekMessageAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PeekedMessage))

Parameters

cancellationToken
CancellationToken

Optional CancellationToken

Returns

Task<Response<PeekedMessage>>

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

Applies to