Storage Client Library for Windows Runtime (Version 7.0)

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

Namespace:   Microsoft.WindowsAzure.Storage.Queue
Assembly:  Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Inheritance Hierarchy

System.::..Object
  Microsoft.WindowsAzure.Storage.Queue.::..CloudQueue

Syntax

C#

Copy Code

 

public class CloudQueue

C++

Copy Code

 

public ref class CloudQueue 

F#

Copy Code

 

type CloudQueue = class end

VB

Copy Code

 

Public Class CloudQueue

Constructors

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

Properties

	Name	Description
	ApproximateMessageCountApproximateMessageCountApproximateMessageCountApproximateMessageCount	Gets the approximate message count for the queue.
	EncodeMessageEncodeMessageEncodeMessageEncodeMessage	Gets or sets a value indicating whether to apply base64 encoding when adding or retrieving messages.
	MetadataMetadataMetadataMetadata	Gets the queue's metadata.
	NameNameNameName	Gets the name of the queue.
	ServiceClientServiceClientServiceClientServiceClient	Gets the CloudQueueClient object that represents the Queue service.
	StorageUriStorageUriStorageUriStorageUri	Gets the queue URIs for both the primary and secondary locations.
	UriUriUriUri	Gets the queue URI for the primary location.

Methods

	Name	Description
	AddMessageAsync(CloudQueueMessage)(CloudQueueMessage^)(CloudQueueMessage)(CloudQueueMessage)	Adds a message to the queue.
	AddMessageAsync(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(CloudQueueMessage^, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^)(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(CloudQueueMessage, Nullable(Of TimeSpan), Nullable(Of TimeSpan), QueueRequestOptions, OperationContext)	Adds a message to the queue.
	AddMessageAsync(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(CloudQueueMessage^, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^, CancellationToken)(CloudQueueMessage, Nullable<TimeSpan>, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(CloudQueueMessage, Nullable(Of TimeSpan), Nullable(Of TimeSpan), QueueRequestOptions, OperationContext, CancellationToken)	Adds a message to the queue.
	ClearAsync()()()()	Clears the messages of the queue.
	ClearAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Clears the messages of the queue.
	ClearAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Clears the messages of the queue.
	CreateAsync()()()()	Creates the queue.
	CreateAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Creates the queue.
	CreateAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Creates the queue.
	CreateIfNotExistsAsync()()()()	Creates the queue if it does not already exist.
	CreateIfNotExistsAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Creates the queue if it does not already exist.
	CreateIfNotExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Creates the queue if it does not already exist.
	DeleteAsync()()()()	Deletes the queue.
	DeleteAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Deletes the queue.
	DeleteAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Deletes the queue.
	DeleteIfExistsAsync()()()()	Deletes the queue if it already exists.
	DeleteIfExistsAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Deletes the queue if it already exists.
	DeleteIfExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Deletes the queue if it already exists.
	DeleteMessageAsync(CloudQueueMessage)(CloudQueueMessage^)(CloudQueueMessage)(CloudQueueMessage)	Deletes the message.
	DeleteMessageAsync(CloudQueueMessage, QueueRequestOptions, OperationContext)(CloudQueueMessage^, QueueRequestOptions^, OperationContext^)(CloudQueueMessage, QueueRequestOptions, OperationContext)(CloudQueueMessage, QueueRequestOptions, OperationContext)	Deletes the message.
	DeleteMessageAsync(String, String)(String^, String^)(String, String)(String, String)	Deletes the message.
	DeleteMessageAsync(String, String, QueueRequestOptions, OperationContext)(String^, String^, QueueRequestOptions^, OperationContext^)(String, String, QueueRequestOptions, OperationContext)(String, String, QueueRequestOptions, OperationContext)	Deletes the message.
	DeleteMessageAsync(String, String, QueueRequestOptions, OperationContext, CancellationToken)(String^, String^, QueueRequestOptions^, OperationContext^, CancellationToken)(String, String, QueueRequestOptions, OperationContext, CancellationToken)(String, String, QueueRequestOptions, OperationContext, CancellationToken)	Deletes the message.
	Equals(Object)(Object^)(Object)(Object)	(Inherited from Object.)
	ExistsAsync()()()()	Checks existence of the queue.
	ExistsAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Checks existence of the queue.
	ExistsAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Checks existence of the queue.
	FetchAttributesAsync()()()()	Retrieves the queue's attributes.
	FetchAttributesAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Retrieves the queue's attributes.
	FetchAttributesAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Retrieves the queue's attributes.
	Finalize()()()()	(Inherited from Object.)
	GetHashCode()()()()	(Inherited from Object.)
	GetMessageAsync()()()()	Gets a single message from the queue.
	GetMessageAsync(Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^)(Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(Nullable(Of TimeSpan), QueueRequestOptions, OperationContext)	Gets a single message from the queue.
	GetMessageAsync(Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^, CancellationToken)(Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Nullable(Of TimeSpan), QueueRequestOptions, OperationContext, CancellationToken)	Gets a single message from the queue.
	GetMessagesAsync(Int32)(Int32)(Int32)(Int32)	Gets a list of messages from the queue.
	GetMessagesAsync(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(Int32, Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^)(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext)(Int32, Nullable(Of TimeSpan), QueueRequestOptions, OperationContext)	Gets a list of messages from the queue.
	GetMessagesAsync(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Int32, Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^, CancellationToken)(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Int32, Nullable(Of TimeSpan), QueueRequestOptions, OperationContext, CancellationToken)	Gets a list of messages from the queue.
	GetPermissionsAsync()()()()	Gets the permissions settings for the queue.
	GetPermissionsAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Gets the permissions settings for the queue.
	GetPermissionsAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Gets the permissions settings for the queue.
	GetSharedAccessSignature(SharedAccessQueuePolicy)(SharedAccessQueuePolicy^)(SharedAccessQueuePolicy)(SharedAccessQueuePolicy)	Returns a shared access signature for the queue.
	GetSharedAccessSignature(SharedAccessQueuePolicy, String)(SharedAccessQueuePolicy^, String^)(SharedAccessQueuePolicy, String)(SharedAccessQueuePolicy, String)	Returns a shared access signature for the queue.
	GetSharedAccessSignature(SharedAccessQueuePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)(SharedAccessQueuePolicy^, String^, Nullable<SharedAccessProtocol>, IPAddressOrRange^)(SharedAccessQueuePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)(SharedAccessQueuePolicy, String, Nullable(Of SharedAccessProtocol), IPAddressOrRange)	Returns a shared access signature for the queue.
	GetType()()()()	(Inherited from Object.)
	MemberwiseClone()()()()	(Inherited from Object.)
	PeekMessageAsync()()()()	Peeks a single message from the queue.
	PeekMessageAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Peeks a single message from the queue.
	PeekMessageAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Peeks a single message from the queue.
	PeekMessagesAsync(Int32)(Int32)(Int32)(Int32)	Peeks a list of messages from the queue.
	PeekMessagesAsync(Int32, QueueRequestOptions, OperationContext)(Int32, QueueRequestOptions^, OperationContext^)(Int32, QueueRequestOptions, OperationContext)(Int32, QueueRequestOptions, OperationContext)	Peeks a list of messages from the queue.
	PeekMessagesAsync(Int32, QueueRequestOptions, OperationContext, CancellationToken)(Int32, QueueRequestOptions^, OperationContext^, CancellationToken)(Int32, QueueRequestOptions, OperationContext, CancellationToken)(Int32, QueueRequestOptions, OperationContext, CancellationToken)	Peeks a list of messages from the queue.
	SetMetadataAsync()()()()	Sets the queue's user-defined metadata.
	SetMetadataAsync(QueueRequestOptions, OperationContext)(QueueRequestOptions^, OperationContext^)(QueueRequestOptions, OperationContext)(QueueRequestOptions, OperationContext)	Sets the queue's user-defined metadata.
	SetMetadataAsync(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions^, OperationContext^, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)(QueueRequestOptions, OperationContext, CancellationToken)	Sets the queue's user-defined metadata.
	SetPermissionsAsync(QueuePermissions)(QueuePermissions^)(QueuePermissions)(QueuePermissions)	Sets permissions for the queue.
	SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext)(QueuePermissions^, QueueRequestOptions^, OperationContext^)(QueuePermissions, QueueRequestOptions, OperationContext)(QueuePermissions, QueueRequestOptions, OperationContext)	Sets permissions for the queue.
	SetPermissionsAsync(QueuePermissions, QueueRequestOptions, OperationContext, CancellationToken)(QueuePermissions^, QueueRequestOptions^, OperationContext^, CancellationToken)(QueuePermissions, QueueRequestOptions, OperationContext, CancellationToken)(QueuePermissions, QueueRequestOptions, OperationContext, CancellationToken)	Sets permissions for the queue.
	ToString()()()()	(Inherited from Object.)
	UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields)(CloudQueueMessage^, TimeSpan, MessageUpdateFields)(CloudQueueMessage, TimeSpan, MessageUpdateFields)(CloudQueueMessage, TimeSpan, MessageUpdateFields)	Updates a message.
	UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)(CloudQueueMessage^, TimeSpan, MessageUpdateFields, QueueRequestOptions^, OperationContext^)(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext)	Updates a message.
	UpdateMessageAsync(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, CancellationToken)(CloudQueueMessage^, TimeSpan, MessageUpdateFields, QueueRequestOptions^, OperationContext^, CancellationToken)(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, CancellationToken)(CloudQueueMessage, TimeSpan, MessageUpdateFields, QueueRequestOptions, OperationContext, CancellationToken)	Updates a message.

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.WindowsAzure.Storage.Queue Namespace

Return to top