Share via

CloudQueue.AddMessage Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.Queue
Assembly:
Microsoft.Azure.Storage.Queue.dll
Package:
Microsoft.Azure.Storage.Queue v11.2.3

Adds a message to the queue.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual void AddMessage (Microsoft.Azure.Storage.Queue.CloudQueueMessage message, TimeSpan? timeToLive = default, TimeSpan? initialVisibilityDelay = default, Microsoft.Azure.Storage.Queue.QueueRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member AddMessage : Microsoft.Azure.Storage.Queue.CloudQueueMessage * Nullable<TimeSpan> * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> unit
override this.AddMessage : Microsoft.Azure.Storage.Queue.CloudQueueMessage * Nullable<TimeSpan> * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> unit
Public Overridable Sub AddMessage (message As CloudQueueMessage, Optional timeToLive As Nullable(Of TimeSpan) = Nothing, Optional initialVisibilityDelay As Nullable(Of TimeSpan) = Nothing, Optional options As QueueRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing)

Parameters

message
CloudQueueMessage

A CloudQueueMessage object.

timeToLive
Nullable<TimeSpan>

A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.

initialVisibilityDelay
Nullable<TimeSpan>

A TimeSpan specifying the interval of time from now during which the message will be invisible. If null then the message will be visible immediately.

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.

Attributes
DoesServiceRequestAttribute

Remarks

The CloudQueueMessage message passed in will be populated with the pop receipt, message ID, and the insertion/expiration time.

Applies to