QueueClient.PeekMessageAsync(CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
Response<T> where T is a PeekedMessage. Returns null if there are no messages in the queue.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for