CloudQueue Class

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Queue

Assembly:: Microsoft.Azure.Storage.Queue.dll

Package:: Microsoft.Azure.Storage.Queue v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class CloudQueue

type CloudQueue = class

Public Class CloudQueue

Inheritance: Object
CloudQueue

Constructors

CloudQueue(StorageUri, StorageCredentials)	Initializes a new instance of the CloudQueue class.
CloudQueue(Uri)	Initializes a new instance of the CloudQueue class.
CloudQueue(Uri, StorageCredentials)	Initializes a new instance of the CloudQueue class.

Properties

ApproximateMessageCount	Gets the approximate message count for the queue.
EncodeMessage	Gets or sets a value indicating whether to apply base64 encoding when adding or retrieving messages.
Metadata	Gets the queue's metadata.
Name	Gets the name of the queue.
ServiceClient	Gets the CloudQueueClient object that represents the Queue service.
StorageUri	Gets the queue URIs for both the primary and secondary locations.
Uri	Gets the queue URI for the primary location.

Methods

AddMessage(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)	Adds a message to the queue.
AddMessageAsync(CloudQueueMessage)	Initiates an asynchronous operation to add a message to the queue.
AddMessageAsync(CloudQueueMessage, CancellationToken)	Initiates an asynchronous operation to add a message to the queue.
AddMessageAsync(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to add a message to the queue.
AddMessageAsync(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to add a message to the queue.
BeginAddMessage(CloudQueueMessage, AsyncCallback, Object)	Begins an asynchronous operation to add a message to the queue.
BeginAddMessage(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to add a message to the queue.
BeginClear(AsyncCallback, Object)	Begins an asynchronous operation to clear all messages from the queue.
BeginClear(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to clear all messages from the queue.
BeginCreate(AsyncCallback, Object)	Begins an asynchronous operation to create a queue.
BeginCreate(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a queue.
BeginCreateIfNotExists(AsyncCallback, Object)	Begins an asynchronous operation to create the queue if it does not already exist.
BeginCreateIfNotExists(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create the queue if it does not already exist.
BeginDelete(AsyncCallback, Object)	Begins an asynchronous operation to delete a queue.
BeginDelete(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a queue.
BeginDeleteIfExists(AsyncCallback, Object)	Begins an asynchronous operation to delete the queue if it already exists.
BeginDeleteIfExists(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete the queue if it already exists.
BeginDeleteMessage(CloudQueueMessage, AsyncCallback, Object)	Begins an asynchronous operation to delete a message.
BeginDeleteMessage(CloudQueueMessage, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a message.
BeginDeleteMessage(String, String, AsyncCallback, Object)	Begins an asynchronous operation to delete a message.
BeginDeleteMessage(String, String, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a message.
BeginExists(AsyncCallback, Object)	Begins an asynchronous operation to check the existence of the queue.
BeginExists(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to check the existence of the queue.
BeginFetchAttributes(AsyncCallback, Object)	Begins an asynchronous operation to fetch the queue's attributes.
BeginFetchAttributes(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to fetch the queue's attributes.
BeginGetMessage(AsyncCallback, Object)	Begins an asynchronous operation to get a single message from the queue.
BeginGetMessage(Nullable<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.
BeginGetMessages(Int32, AsyncCallback, Object)	Begins an asynchronous operation to get messages from the queue.
BeginGetMessages(Int32, Nullable<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.
BeginGetPermissions(AsyncCallback, Object)	Begins an asynchronous operation to get the permissions settings for the queue.
BeginGetPermissions(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get the permissions settings for the queue.
BeginPeekMessage(AsyncCallback, Object)	Begins an asynchronous operation to get a single message from the queue.
BeginPeekMessage(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to peek a single message from the queue.
BeginPeekMessages(Int32, AsyncCallback, Object)	Begins an asynchronous operation to peek messages from the queue.
BeginPeekMessages(Int32, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to peek messages from the queue.
BeginSetMetadata(AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the queue.
BeginSetMetadata(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the queue.
BeginSetPermissions(QueuePermissions, AsyncCallback, Object)	Begins an asynchronous operation to set permissions for the queue.
BeginSetPermissions(QueuePermissions, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set permissions for the queue.
BeginUpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, AsyncCallback, Object)	Begins an asynchronous operation to update the visibility timeout and optionally the content of a message.
BeginUpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to update the visibility timeout and optionally the content of a message.
Clear(QueueRequestOptions, OperationContext)	Clears all messages from the queue.
ClearAsync()	Initiates an asynchronous operation to clear all messages from the queue.
ClearAsync(CancellationToken)	Initiates an asynchronous operation to clear all messages from the queue.
ClearAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to clear all messages from the queue.
ClearAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to clear all messages from the queue.
Create(QueueRequestOptions, OperationContext)	Creates the queue.
CreateAsync()	Initiates an asynchronous operation to create a queue.
CreateAsync(CancellationToken)	Initiates an asynchronous operation to create a queue.
CreateAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to create a queue.
CreateAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to create a queue.
CreateIfNotExists(QueueRequestOptions, OperationContext)	Creates the queue if it does not already exist.
CreateIfNotExistsAsync()	Initiates an asynchronous operation to create the queue if it does not already exist.
CreateIfNotExistsAsync(CancellationToken)	Initiates an asynchronous operation to create the queue if it does not already exist.
CreateIfNotExistsAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to create the queue if it does not already exist.
CreateIfNotExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to create the queue if it does not already exist.
Delete(QueueRequestOptions, OperationContext)	Deletes the queue.
DeleteAsync()	Initiates an asynchronous operation to delete a queue.
DeleteAsync(CancellationToken)	Initiates an asynchronous operation to delete a queue.
DeleteAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to delete a queue.
DeleteAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to delete a queue.
DeleteIfExists(QueueRequestOptions, OperationContext)	Deletes the queue if it already exists.
DeleteIfExistsAsync()	Initiates an asynchronous operation to delete the queue if it already exists.
DeleteIfExistsAsync(CancellationToken)	Initiates an asynchronous operation to delete the queue if it already exists.
DeleteIfExistsAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to delete the queue if it already exists.
DeleteIfExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to delete the queue if it already exists.
DeleteMessage(CloudQueueMessage, QueueRequestOptions, OperationContext)	Deletes a message.
DeleteMessage(String, String, QueueRequestOptions, OperationContext)	Deletes the specified message from the queue.
DeleteMessageAsync(CloudQueueMessage)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(CloudQueueMessage, CancellationToken)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(CloudQueueMessage, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(CloudQueueMessage, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(String, String)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(String, String, CancellationToken)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(String, String, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to delete a message.
DeleteMessageAsync(String, String, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to delete a message.
EndAddMessage(IAsyncResult)	Ends an asynchronous operation to add a message to the queue.
EndClear(IAsyncResult)	Ends an asynchronous operation to clear all messages from the queue.
EndCreate(IAsyncResult)	Ends an asynchronous operation to create a queue.
EndCreateIfNotExists(IAsyncResult)	Returns the result of an asynchronous operation to create the queue if it does not already exist.
EndDelete(IAsyncResult)	Ends an asynchronous operation to delete a queue.
EndDeleteIfExists(IAsyncResult)	Returns the result of an asynchronous operation to delete the queue if it already exists.
EndDeleteMessage(IAsyncResult)	Ends an asynchronous operation to delete a message.
EndExists(IAsyncResult)	Returns the asynchronous result of the request to check the existence of the queue.
EndFetchAttributes(IAsyncResult)	Ends an asynchronous operation to fetch a queue's attributes.
EndGetMessage(IAsyncResult)	Ends an asynchronous operation to get a single message from the queue.
EndGetMessages(IAsyncResult)	Ends an asynchronous operation to get messages from the queue.
EndGetPermissions(IAsyncResult)	Returns the asynchronous result of the request to get the permissions settings for the queue.
EndPeekMessage(IAsyncResult)	Ends an asynchronous operation to peek a single message from the queue.
EndPeekMessages(IAsyncResult)	Ends an asynchronous operation to peek messages from the queue.
EndSetMetadata(IAsyncResult)	Ends an asynchronous operation to set user-defined metadata on the queue.
EndSetPermissions(IAsyncResult)	Returns the result of an asynchronous operation to set permissions for the queue.
EndUpdateMessage(IAsyncResult)	Ends an asynchronous operation to add a message to the queue.
Exists(QueueRequestOptions, OperationContext)	Checks existence of the queue.
ExistsAsync()	Initiates an asynchronous operation to check the existence of the queue.
ExistsAsync(CancellationToken)	Initiates an asynchronous operation to check the existence of the queue.
ExistsAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to check the existence of the queue.
ExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to check the existence of the queue.
FetchAttributes(QueueRequestOptions, OperationContext)	Fetches the queue's attributes.
FetchAttributesAsync()	Initiates an asynchronous operation to fetch the queue's attributes.
FetchAttributesAsync(CancellationToken)	Initiates an asynchronous operation to fetch the queue's attributes.
FetchAttributesAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to fetch the queue's attributes.
FetchAttributesAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to fetch the queue's attributes.
GetMessage(Nullable<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.
GetMessageAsync()	Initiates an asynchronous operation to get a single message from the queue.
GetMessageAsync(CancellationToken)	Initiates an asynchronous operation to get a single message from the queue.
GetMessageAsync(Nullable<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.
GetMessageAsync(Nullable<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.
GetMessages(Int32, Nullable<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.
GetMessagesAsync(Int32)	Initiates an asynchronous operation to get messages from the queue.
GetMessagesAsync(Int32, CancellationToken)	Initiates an asynchronous operation to get messages from the queue.
GetMessagesAsync(Int32, Nullable<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.
GetMessagesAsync(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)	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.
GetPermissions(QueueRequestOptions, OperationContext)	Gets the permissions settings for the queue.
GetPermissionsAsync()	Initiates an asynchronous operation to get the permissions settings for the queue.
GetPermissionsAsync(CancellationToken)	Initiates an asynchronous operation to get the permissions settings for the queue.
GetPermissionsAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to get the permissions settings for the queue.
GetPermissionsAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get the permissions settings for the queue.
GetSharedAccessSignature(SharedAccessQueuePolicy)	Returns a shared access signature for the queue.
GetSharedAccessSignature(SharedAccessQueuePolicy, String)	Returns a shared access signature for the queue.
GetSharedAccessSignature(SharedAccessQueuePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)	Returns a shared access signature for the queue.
PeekMessage(QueueRequestOptions, OperationContext)	Peeks a single message from the queue. A peek request retrieves a message from the queue without changing its visibility.
PeekMessageAsync()	Initiates an asynchronous operation to get a single message from the queue.
PeekMessageAsync(CancellationToken)	Initiates an asynchronous operation to get a single message from the queue.
PeekMessageAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to get a single message from the queue.
PeekMessageAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get a single message from the queue.
PeekMessages(Int32, 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.
PeekMessagesAsync(Int32)	Initiates an asynchronous operation to peek messages from the queue.
PeekMessagesAsync(Int32, CancellationToken)	Initiates an asynchronous operation to peek messages from the queue.
PeekMessagesAsync(Int32, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to peek messages from the queue.
PeekMessagesAsync(Int32, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to peek messages from the queue.
SetMetadata(QueueRequestOptions, OperationContext)	Sets the queue's user-defined metadata.
SetMetadataAsync()	Initiates an asynchronous operation to set user-defined metadata on the queue.
SetMetadataAsync(CancellationToken)	Initiates an asynchronous operation to set user-defined metadata on the queue.
SetMetadataAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to set user-defined metadata on the queue.
SetMetadataAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to set user-defined metadata on the queue.
SetPermissions(QueuePermissions, QueueRequestOptions, OperationContext)	Sets permissions for the queue.
SetPermissionsAsync(QueuePermissions)	Initiates an asynchronous operation to set permissions for the queue.
SetPermissionsAsync(QueuePermissions, CancellationToken)	Initiates an asynchronous operation to set permissions for the queue.
SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to set permissions for the queue.
SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to set permissions for the queue.
UpdateMessage(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)	Updates the visibility timeout and optionally the content of a message.
UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields)	Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.
UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, CancellationToken)	Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.
UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.
UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to update the visibility timeout and optionally the content of a message.

Applies to