Class CloudQueue

Namespace: Microsoft.WindowsAzure.Storage.Queue

Assembly: Microsoft.WindowsAzure.Storage.dll

This class represents a queue in the Microsoft Azure Queue service.

public class CloudQueue

Inheritance: object

CloudQueue

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CloudQueue(StorageUri, StorageCredentials)

Initializes a new instance of the CloudQueue class.

public CloudQueue(StorageUri queueAddress, StorageCredentials credentials)

Parameters

queueAddress StorageUri: A StorageUri containing the absolute URI to the queue at both the primary and secondary locations.
credentials StorageCredentials: A StorageCredentials object.

CloudQueue(Uri)

Initializes a new instance of the CloudQueue class.

public CloudQueue(Uri queueAddress)

Parameters

queueAddress Uri: A System.Uri specifying the absolute URI to the queue.

CloudQueue(Uri, StorageCredentials)

Initializes a new instance of the CloudQueue class.

public CloudQueue(Uri queueAddress, StorageCredentials credentials)

Parameters

queueAddress Uri: A System.Uri specifying the absolute URI to the queue.
credentials StorageCredentials: A StorageCredentials object.

Properties

ApproximateMessageCount

Gets the approximate message count for the queue.

public int? ApproximateMessageCount { get; }

Property Value

int?: The approximate message count.

EncodeMessage

Gets or sets a value indicating whether to apply base64 encoding when adding or retrieving messages.

public bool EncodeMessage { get; set; }

Property Value

bool: true to encode messages; otherwise, false. The default value is true.

Metadata

Gets the queue's metadata.

public IDictionary<string, string> Metadata { get; }

Property Value

IDictionary<string, string>: An IDictionary<TKey, TValue> object containing the queue's metadata.

Name

Gets the name of the queue.

public string Name { get; }

Property Value

string: A string containing the name of the queue.

ServiceClient

Gets the CloudQueueClient object that represents the Queue service.

public CloudQueueClient ServiceClient { get; }

Property Value

CloudQueueClient: A CloudQueueClient object.

StorageUri

Gets the queue URIs for both the primary and secondary locations.

public StorageUri StorageUri { get; }

Property Value

StorageUri: An object of type StorageUri containing the queue's URIs for both the primary and secondary locations.

Uri

Gets the queue URI for the primary location.

public Uri Uri { get; }

Property Value

Uri: A System.Uri specifying the absolute URI to the queue at the primary location.

Methods

AddMessage(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext)

Adds a message to the queue.

[DoesServiceRequest]
public virtual void AddMessage(CloudQueueMessage message, TimeSpan? timeToLive = null, TimeSpan? initialVisibilityDelay = null, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
timeToLive TimeSpan?: A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.
initialVisibilityDelay 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.

Remarks

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

AddMessageAsync(CloudQueueMessage)

Initiates an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual Task AddMessageAsync(CloudQueueMessage message)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.

Returns

Task: A Task object that represents the asynchronous operation.

Remarks

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

AddMessageAsync(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual Task AddMessageAsync(CloudQueueMessage message, TimeSpan? timeToLive, TimeSpan? initialVisibilityDelay, QueueRequestOptions options, OperationContext operationContext)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
timeToLive TimeSpan?: A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.
initialVisibilityDelay 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.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

Remarks

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

AddMessageAsync(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual Task AddMessageAsync(CloudQueueMessage message, TimeSpan? timeToLive, TimeSpan? initialVisibilityDelay, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
timeToLive TimeSpan?: A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.
initialVisibilityDelay 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.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

Remarks

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

AddMessageAsync(CloudQueueMessage, CancellationToken)

Initiates an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual Task AddMessageAsync(CloudQueueMessage message, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

Remarks

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

BeginAddMessage(CloudQueueMessage, AsyncCallback, object)

Begins an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginAddMessage(CloudQueueMessage message, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginAddMessage(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to add a message to the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginAddMessage(CloudQueueMessage message, TimeSpan? timeToLive, TimeSpan? initialVisibilityDelay, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
timeToLive TimeSpan?: A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.
initialVisibilityDelay 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.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginClear(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginClear(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginClear(AsyncCallback, object)

Begins an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginClear(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginCreate(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreate(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginCreate(AsyncCallback, object)

Begins an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreate(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginCreateIfNotExists(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreateIfNotExists(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

Remarks

This API requires Create or Write permissions.

BeginCreateIfNotExists(AsyncCallback, object)

Begins an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreateIfNotExists(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

Remarks

This API requires Create or Write permissions.

BeginDelete(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDelete(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDelete(AsyncCallback, object)

Begins an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDelete(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteIfExists(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteIfExists(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteIfExists(AsyncCallback, object)

Begins an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteIfExists(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteMessage(CloudQueueMessage, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteMessage(CloudQueueMessage message, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteMessage(CloudQueueMessage, AsyncCallback, object)

Begins an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteMessage(CloudQueueMessage message, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteMessage(string, string, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteMessage(string messageId, string popReceipt, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteMessage(string, string, AsyncCallback, object)

Begins an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteMessage(string messageId, string popReceipt, AsyncCallback callback, object state)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginExists(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginExists(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginExists(AsyncCallback, object)

Begins an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginExists(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginFetchAttributes(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginFetchAttributes(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginFetchAttributes(AsyncCallback, object)

Begins an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginFetchAttributes(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetMessage(AsyncCallback, object)

Begins an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetMessage(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetMessage(TimeSpan?, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get a single message from the queue, and specifies how long the message should be reserved before it becomes visible, and therefore available for deletion.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetMessage(TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetMessages(int, AsyncCallback, object)

Begins an asynchronous operation to get messages from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetMessages(int messageCount, AsyncCallback callback, object state)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetMessages(int, TimeSpan?, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetMessages(int messageCount, TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetPermissions(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetPermissions(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetPermissions(AsyncCallback, object)

Begins an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetPermissions(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginPeekMessage(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to peek a single message from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginPeekMessage(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginPeekMessage(AsyncCallback, object)

Begins an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginPeekMessage(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginPeekMessages(int, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginPeekMessages(int messageCount, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginPeekMessages(int, AsyncCallback, object)

Begins an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginPeekMessages(int messageCount, AsyncCallback callback, object state)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginSetMetadata(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetMetadata(QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginSetMetadata(AsyncCallback, object)

Begins an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetMetadata(AsyncCallback callback, object state)

Parameters

callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginSetPermissions(QueuePermissions, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetPermissions(QueuePermissions permissions, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

permissions QueuePermissions: A QueuePermissions object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginSetPermissions(QueuePermissions, AsyncCallback, object)

Begins an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetPermissions(QueuePermissions permissions, AsyncCallback callback, object state)

Parameters

permissions QueuePermissions: A QueuePermissions object.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginUpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginUpdateMessage(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginUpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, AsyncCallback, object)

Begins an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginUpdateMessage(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, AsyncCallback callback, object state)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.
callback AsyncCallback: An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
state object: A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

Clear(QueueRequestOptions, OperationContext)

Clears all messages from the queue.

[DoesServiceRequest]
public virtual void Clear(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

ClearAsync()

Initiates an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual Task ClearAsync()

Returns

Task: A Task object that represents the asynchronous operation.

ClearAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual Task ClearAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

ClearAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual Task ClearAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

ClearAsync(CancellationToken)

Initiates an asynchronous operation to clear all messages from the queue.

[DoesServiceRequest]
public virtual Task ClearAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

Create(QueueRequestOptions, OperationContext)

Creates the queue.

[DoesServiceRequest]
public virtual void Create(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

CreateAsync()

Initiates an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual Task CreateAsync()

Returns

Task: A Task object that represents the asynchronous operation.

CreateAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual Task CreateAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

CreateAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual Task CreateAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

CreateAsync(CancellationToken)

Initiates an asynchronous operation to create a queue.

[DoesServiceRequest]
public virtual Task CreateAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

CreateIfNotExists(QueueRequestOptions, OperationContext)

Creates the queue if it does not already exist.

[DoesServiceRequest]
public virtual bool CreateIfNotExists(QueueRequestOptions options = null, OperationContext operationContext = null)

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

bool: true if the queue did not already exist and was created; otherwise false.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync()

Initiates an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync()

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(CancellationToken)

Initiates an asynchronous operation to create the queue if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

Delete(QueueRequestOptions, OperationContext)

Deletes the queue.

[DoesServiceRequest]
public virtual void Delete(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

DeleteAsync()

Initiates an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual Task DeleteAsync()

Returns

Task: A Task object that represents the asynchronous operation.

DeleteAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual Task DeleteAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual Task DeleteAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteAsync(CancellationToken)

Initiates an asynchronous operation to delete a queue.

[DoesServiceRequest]
public virtual Task DeleteAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteIfExists(QueueRequestOptions, OperationContext)

Deletes the queue if it already exists.

[DoesServiceRequest]
public virtual bool DeleteIfExists(QueueRequestOptions options = null, OperationContext operationContext = null)

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

bool: true if the queue did not already exist and was created; otherwise false.

DeleteIfExistsAsync()

Initiates an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync()

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

DeleteIfExistsAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

DeleteIfExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

DeleteIfExistsAsync(CancellationToken)

Initiates an asynchronous operation to delete the queue if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

DeleteMessage(CloudQueueMessage, QueueRequestOptions, OperationContext)

Deletes a message.

[DoesServiceRequest]
public virtual void DeleteMessage(CloudQueueMessage message, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
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.

DeleteMessage(string, string, QueueRequestOptions, OperationContext)

Deletes the specified message from the queue.

[DoesServiceRequest]
public virtual void DeleteMessage(string messageId, string popReceipt, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
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.

DeleteMessageAsync(CloudQueueMessage)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(CloudQueueMessage message)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(CloudQueueMessage, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(CloudQueueMessage message, QueueRequestOptions options, OperationContext operationContext)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(CloudQueueMessage, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(CloudQueueMessage message, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(CloudQueueMessage, CancellationToken)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(CloudQueueMessage message, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(string, string)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(string messageId, string popReceipt)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(string, string, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(string messageId, string popReceipt, QueueRequestOptions options, OperationContext operationContext)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(string, string, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(string messageId, string popReceipt, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

DeleteMessageAsync(string, string, CancellationToken)

Initiates an asynchronous operation to delete a message.

[DoesServiceRequest]
public virtual Task DeleteMessageAsync(string messageId, string popReceipt, CancellationToken cancellationToken)

Parameters

messageId string: A string specifying the message ID.
popReceipt string: A string specifying the pop receipt value.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

EndAddMessage(IAsyncResult)

Ends an asynchronous operation to add a message to the queue.

public virtual void EndAddMessage(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Remarks

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

EndClear(IAsyncResult)

Ends an asynchronous operation to clear all messages from the queue.

public virtual void EndClear(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndCreate(IAsyncResult)

Ends an asynchronous operation to create a queue.

public virtual void EndCreate(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndCreateIfNotExists(IAsyncResult)

Returns the result of an asynchronous operation to create the queue if it does not already exist.

public virtual bool EndCreateIfNotExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the queue did not already exist and was created; otherwise, false.

EndDelete(IAsyncResult)

Ends an asynchronous operation to delete a queue.

public virtual void EndDelete(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndDeleteIfExists(IAsyncResult)

Returns the result of an asynchronous operation to delete the queue if it already exists.

public virtual bool EndDeleteIfExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the queue did not already exist and was created; otherwise, false.

EndDeleteMessage(IAsyncResult)

Ends an asynchronous operation to delete a message.

public virtual void EndDeleteMessage(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndExists(IAsyncResult)

Returns the asynchronous result of the request to check the existence of the queue.

public virtual bool EndExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the queue exists.

EndFetchAttributes(IAsyncResult)

Ends an asynchronous operation to fetch a queue's attributes.

public virtual void EndFetchAttributes(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndGetMessage(IAsyncResult)

Ends an asynchronous operation to get a single message from the queue.

public virtual CloudQueueMessage EndGetMessage(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

CloudQueueMessage: A CloudQueueMessage object.

EndGetMessages(IAsyncResult)

Ends an asynchronous operation to get messages from the queue.

public virtual IEnumerable<CloudQueueMessage> EndGetMessages(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

IEnumerable<CloudQueueMessage>: An enumerable collection of messages.

EndGetPermissions(IAsyncResult)

Returns the asynchronous result of the request to get the permissions settings for the queue.

public virtual QueuePermissions EndGetPermissions(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

QueuePermissions: A QueuePermissions object.

EndPeekMessage(IAsyncResult)

Ends an asynchronous operation to peek a single message from the queue.

public virtual CloudQueueMessage EndPeekMessage(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

CloudQueueMessage: A CloudQueueMessage object.

EndPeekMessages(IAsyncResult)

Ends an asynchronous operation to peek messages from the queue.

public virtual IEnumerable<CloudQueueMessage> EndPeekMessages(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

IEnumerable<CloudQueueMessage>: An enumerable collection of CloudQueueMessage objects.

EndSetMetadata(IAsyncResult)

Ends an asynchronous operation to set user-defined metadata on the queue.

public virtual void EndSetMetadata(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndSetPermissions(IAsyncResult)

Returns the result of an asynchronous operation to set permissions for the queue.

public virtual void EndSetPermissions(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndUpdateMessage(IAsyncResult)

Ends an asynchronous operation to add a message to the queue.

public virtual void EndUpdateMessage(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Exists(QueueRequestOptions, OperationContext)

Checks existence of the queue.

[DoesServiceRequest]
public virtual bool Exists(QueueRequestOptions options = null, OperationContext operationContext = null)

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

bool: true if the queue exists.

ExistsAsync()

Initiates an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync()

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

ExistsAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

ExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

ExistsAsync(CancellationToken)

Initiates an asynchronous operation to check the existence of the queue.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<bool>: A Task<TResult> object of type bool that represents the asynchronous operation.

FetchAttributes(QueueRequestOptions, OperationContext)

Fetches the queue's attributes.

[DoesServiceRequest]
public virtual void FetchAttributes(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

FetchAttributesAsync()

Initiates an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync()

Returns

Task: A Task object that represents the asynchronous operation.

FetchAttributesAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

FetchAttributesAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

FetchAttributesAsync(CancellationToken)

Initiates an asynchronous operation to fetch the queue's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

GetMessage(TimeSpan?, QueueRequestOptions, OperationContext)

Gets a message from the queue using the default request options. This operation marks the retrieved message as invisible in the queue for the default visibility timeout period.

[DoesServiceRequest]
public virtual CloudQueueMessage GetMessage(TimeSpan? visibilityTimeout = null, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
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.

GetMessageAsync()

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> GetMessageAsync()

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

GetMessageAsync(TimeSpan?, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get a single message from the queue, and specifies how long the message should be reserved before it becomes visible, and therefore available for deletion.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> GetMessageAsync(TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext)

Parameters

visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

GetMessageAsync(TimeSpan?, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get a single message from the queue, and specifies how long the message should be reserved before it becomes visible, and therefore available for deletion.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> GetMessageAsync(TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

GetMessageAsync(CancellationToken)

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> GetMessageAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

GetMessages(int, TimeSpan?, QueueRequestOptions, OperationContext)

Gets the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

[DoesServiceRequest]
public virtual IEnumerable<CloudQueueMessage> GetMessages(int messageCount, TimeSpan? visibilityTimeout = null, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
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

IEnumerable<CloudQueueMessage>: An enumerable collection of messages.

GetMessagesAsync(int)

Initiates an asynchronous operation to get messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(int messageCount)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

GetMessagesAsync(int, TimeSpan?, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(int messageCount, TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

GetMessagesAsync(int, TimeSpan?, QueueRequestOptions, OperationContext, CancellationToken)

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(int messageCount, TimeSpan? visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
visibilityTimeout TimeSpan?: A TimeSpan specifying the visibility timeout interval.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

GetMessagesAsync(int, CancellationToken)

Initiates an asynchronous operation to get messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(int messageCount, CancellationToken cancellationToken)

Parameters

messageCount int: The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

GetPermissions(QueueRequestOptions, OperationContext)

Gets the permissions settings for the queue.

[DoesServiceRequest]
public virtual QueuePermissions GetPermissions(QueueRequestOptions options = null, OperationContext operationContext = null)

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

QueuePermissions: A QueuePermissions object.

GetPermissionsAsync()

Initiates an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual Task<QueuePermissions> GetPermissionsAsync()

Returns

Task<QueuePermissions>: A Task<TResult> object of type QueuePermissions that represents the asynchronous operation.

GetPermissionsAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual Task<QueuePermissions> GetPermissionsAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<QueuePermissions>: A Task<TResult> object of type QueuePermissions that represents the asynchronous operation.

GetPermissionsAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual Task<QueuePermissions> GetPermissionsAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<QueuePermissions>: A Task<TResult> object of type QueuePermissions that represents the asynchronous operation.

GetPermissionsAsync(CancellationToken)

Initiates an asynchronous operation to get the permissions settings for the queue.

[DoesServiceRequest]
public virtual Task<QueuePermissions> GetPermissionsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<QueuePermissions>: A Task<TResult> object of type QueuePermissions that represents the asynchronous operation.

GetSharedAccessSignature(SharedAccessQueuePolicy)

Returns a shared access signature for the queue.

public string GetSharedAccessSignature(SharedAccessQueuePolicy policy)

Parameters

policy SharedAccessQueuePolicy: A SharedAccessQueuePolicy object specifying the access policy for the shared access signature.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessQueuePolicy, string)

Returns a shared access signature for the queue.

public string GetSharedAccessSignature(SharedAccessQueuePolicy policy, string accessPolicyIdentifier)

Parameters

policy SharedAccessQueuePolicy: A SharedAccessQueuePolicy object specifying the access policy for the shared access signature.
accessPolicyIdentifier string: A string identifying a stored access policy.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessQueuePolicy, string, SharedAccessProtocol?, IPAddressOrRange)

Returns a shared access signature for the queue.

public string GetSharedAccessSignature(SharedAccessQueuePolicy policy, string accessPolicyIdentifier, SharedAccessProtocol? protocols, IPAddressOrRange ipAddressOrRange)

Parameters

policy SharedAccessQueuePolicy: A SharedAccessQueuePolicy object specifying the access policy for the shared access signature.
accessPolicyIdentifier string: A string identifying a stored access policy.
protocols SharedAccessProtocol?: The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol.
ipAddressOrRange IPAddressOrRange: The allowed IP address or IP address range. Null if you don't want to restrict based on IP address.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

PeekMessage(QueueRequestOptions, OperationContext)

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

[DoesServiceRequest]
public virtual CloudQueueMessage PeekMessage(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

PeekMessageAsync()

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> PeekMessageAsync()

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

PeekMessageAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> PeekMessageAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

PeekMessageAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> PeekMessageAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

PeekMessageAsync(CancellationToken)

Initiates an asynchronous operation to get a single message from the queue.

[DoesServiceRequest]
public virtual Task<CloudQueueMessage> PeekMessageAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<CloudQueueMessage>: A Task<TResult> object of type CloudQueueMessage that represents the asynchronous operation.

PeekMessages(int, QueueRequestOptions, OperationContext)

Peeks a message from the queue, using the specified request options and operation context. A peek request retrieves a message from the queue without changing its visibility.

[DoesServiceRequest]
public virtual IEnumerable<CloudQueueMessage> PeekMessages(int messageCount, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
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

IEnumerable<CloudQueueMessage>: An enumerable collection of CloudQueueMessage objects.

PeekMessagesAsync(int)

Initiates an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync(int messageCount)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

PeekMessagesAsync(int, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync(int messageCount, QueueRequestOptions options, OperationContext operationContext)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

PeekMessagesAsync(int, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync(int messageCount, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

PeekMessagesAsync(int, CancellationToken)

Initiates an asynchronous operation to peek messages from the queue.

[DoesServiceRequest]
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync(int messageCount, CancellationToken cancellationToken)

Parameters

messageCount int: The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<IEnumerable<CloudQueueMessage>>: A Task<TResult> object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

SetMetadata(QueueRequestOptions, OperationContext)

Sets the queue's user-defined metadata.

[DoesServiceRequest]
public virtual void SetMetadata(QueueRequestOptions options = null, OperationContext operationContext = null)

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.

SetMetadataAsync()

Initiates an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual Task SetMetadataAsync()

Returns

Task: A Task object that represents the asynchronous operation.

SetMetadataAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(QueueRequestOptions options, OperationContext operationContext)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

SetMetadataAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

SetMetadataAsync(CancellationToken)

Initiates an asynchronous operation to set user-defined metadata on the queue.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissions(QueuePermissions, QueueRequestOptions, OperationContext)

Sets permissions for the queue.

[DoesServiceRequest]
public virtual void SetPermissions(QueuePermissions permissions, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

permissions QueuePermissions: A QueuePermissions object.
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.

SetPermissionsAsync(QueuePermissions)

Initiates an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(QueuePermissions permissions)

Parameters

permissions QueuePermissions: A QueuePermissions object.

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(QueuePermissions permissions, QueueRequestOptions options, OperationContext operationContext)

Parameters

permissions QueuePermissions: A QueuePermissions object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(QueuePermissions permissions, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

permissions QueuePermissions: A QueuePermissions object.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissionsAsync(QueuePermissions, CancellationToken)

Initiates an asynchronous operation to set permissions for the queue.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(QueuePermissions permissions, CancellationToken cancellationToken)

Parameters

permissions QueuePermissions: A QueuePermissions object.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

UpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)

Updates the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual void UpdateMessage(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: Flags of MessageUpdateFields values that specifies which parts of the message are to be updated.
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.

UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields)

Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual Task UpdateMessageAsync(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.

Returns

Task: A Task object that represents the asynchronous operation.

UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual Task UpdateMessageAsync(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, QueueRequestOptions options, OperationContext operationContext)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.

Returns

Task: A Task object that represents the asynchronous operation.

UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual Task UpdateMessageAsync(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.
options QueueRequestOptions: A QueueRequestOptions object that specifies additional options for the request.
operationContext OperationContext: An OperationContext object that represents the context for the current operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, CancellationToken)

Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.

[DoesServiceRequest]
public virtual Task UpdateMessageAsync(CloudQueueMessage message, TimeSpan visibilityTimeout, MessageUpdateFields updateFields, CancellationToken cancellationToken)

Parameters

message CloudQueueMessage: A CloudQueueMessage object.
visibilityTimeout TimeSpan: A TimeSpan specifying the visibility timeout interval.
updateFields MessageUpdateFields: A set of MessageUpdateFields values that specify which parts of the message are to be updated.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

Table of Contents

Class CloudQueue

Constructors

CloudQueue(StorageUri, StorageCredentials)

Parameters

CloudQueue(Uri)

Parameters

CloudQueue(Uri, StorageCredentials)

Parameters

Properties

ApproximateMessageCount

Property Value

EncodeMessage

Property Value

Metadata

Property Value

Name

Property Value

ServiceClient

Property Value

StorageUri

Property Value

Uri

Property Value

Methods

AddMessage(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext)

Parameters

Remarks

AddMessageAsync(CloudQueueMessage)

Parameters

Returns

Remarks

AddMessageAsync(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext)

Parameters

Returns

Remarks

AddMessageAsync(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext, CancellationToken)

Parameters

Returns

Remarks

AddMessageAsync(CloudQueueMessage, CancellationToken)

Parameters

Returns

Remarks

BeginAddMessage(CloudQueueMessage, AsyncCallback, object)

Parameters

Returns

BeginAddMessage(CloudQueueMessage, TimeSpan?, TimeSpan?, QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginClear(QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginClear(AsyncCallback, object)

Parameters

Returns

BeginCreate(QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginCreate(AsyncCallback, object)

Parameters

Returns

BeginCreateIfNotExists(QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

Remarks

BeginCreateIfNotExists(AsyncCallback, object)

Parameters

Returns

Remarks

BeginDelete(QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginDelete(AsyncCallback, object)

Parameters

Returns

BeginDeleteIfExists(QueueRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginDeleteIfExists(AsyncCallback, object)