CloudQueue.PeekMessage(QueueRequestOptions, OperationContext) Method

Definition

Peeks a single message from the queue. A peek request retrieves a message from the queue without changing its visibility.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.Queue.CloudQueueMessage PeekMessage (Microsoft.Azure.Storage.Queue.QueueRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member PeekMessage : Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Queue.CloudQueueMessage
override this.PeekMessage : Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Queue.CloudQueueMessage
Public Overridable Function PeekMessage (Optional options As QueueRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As CloudQueueMessage

Parameters

options
QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

Returns

CloudQueueMessage

A CloudQueueMessage object.

Attributes

Applies to