QueueClient Class

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.17.1

Source:

QueueClient.cs

A QueueClient represents a URI to the Azure Storage Queue service allowing you to manipulate a queue.

public class QueueClient

type QueueClient = class

Public Class QueueClient

Inheritance

Object

QueueClient

Constructors

QueueClient()	Initializes a new instance of the QueueClient class for mocking.
QueueClient(String, String)	Initializes a new instance of the QueueClient class.
QueueClient(String, String, QueueClientOptions)	Initializes a new instance of the QueueClient class.
QueueClient(Uri, AzureSasCredential, QueueClientOptions)	Initializes a new instance of the QueueClient class.
QueueClient(Uri, QueueClientOptions)	Initializes a new instance of the QueueClient class.
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)	Initializes a new instance of the QueueClient class.
QueueClient(Uri, TokenCredential, QueueClientOptions)	Initializes a new instance of the QueueClient class.

Properties

AccountName	Gets the Storage account name corresponding to the queue client.
CanGenerateSasUri	Determines whether the client is able to generate a SAS. If the client is authenticated with a StorageSharedKeyCredential.
MaxPeekableMessages	QueueMaxMessagesPeek indicates the maximum number of messages you can retrieve with each call to Peek.
MessageMaxBytes	Gets the maximum number of bytes allowed for a message's UTF-8 text.
MessagesUri	Gets the Uri endpoint used by the object's messages.
Name	Gets the name of the queue.
Uri	Gets the Uri endpoint used by the object.

Methods

ClearMessages(CancellationToken)	Deletes all messages from a queue. For more information, see Clear Messages.
ClearMessagesAsync(CancellationToken)	Deletes all messages from a queue. For more information, see Clear Messages.
Create(IDictionary<String,String>, CancellationToken)	Creates a queue. For more information, see Create Queue.
CreateAsync(IDictionary<String,String>, CancellationToken)	Creates a queue. For more information, see Create Queue.
CreateIfNotExists(IDictionary<String,String>, CancellationToken)	The CreateIfNotExists(IDictionary<String,String>, CancellationToken) operation creates a new queue under the specified account. If the queue already exists, it is not changed. For more information, see Create Queue.
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)	The CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) operation creates a new queue under the specified account. If the queue already exists, it is not changed. For more information, see Create Queue.
Delete(CancellationToken)	Deletes a queue. For more information, see Delete Queue.
DeleteAsync(CancellationToken)	Deletes a queue. For more information, see Delete Queue.
DeleteIfExists(CancellationToken)	The DeleteIfExists(CancellationToken) operation deletes the specified queue if it exists. For more information, see Delete Queue.
DeleteIfExistsAsync(CancellationToken)	The DeleteIfExistsAsync(CancellationToken) operation deletes the specified queue if it exists. For more information, see Delete Queue.
DeleteMessage(String, String, CancellationToken)	Permanently removes the specified message from its queue. For more information, see Delete Message.
DeleteMessageAsync(String, String, CancellationToken)	Permanently removes the specified message from its queue. For more information, see Delete Message.
Exists(CancellationToken)	The Exists(CancellationToken) operation can be called on a QueueClient to see if the associated queue exists on the storage account in the storage service.
ExistsAsync(CancellationToken)	The ExistsAsync(CancellationToken) operation can be called on a QueueClient to see if the associated queue exists on the storage account in the storage service.
GenerateSasUri(QueueSasBuilder)	The GenerateSasUri(QueueSasBuilder) returns a Uri that generates a Queue Service SAS Uri based on the Client properties and builder passed. For more information, see Constructing a Service SAS
GenerateSasUri(QueueSasPermissions, DateTimeOffset)	The GenerateSasUri(QueueSasPermissions, DateTimeOffset) returns a Uri that generates a Queue Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. For more information, see Constructing a Service SAS.
GetAccessPolicy(CancellationToken)	Returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures. For more information, see Get Queue ACL.
GetAccessPolicyAsync(CancellationToken)	Returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures. For more information, see Get Queue ACL.
GetParentQueueServiceClientCore()	Create a new QueueServiceClient that pointing to this QueueClient's queue service. The new QueueServiceClient uses the same request policy pipeline as the QueueClient.
GetProperties(CancellationToken)	Retrieves queue properties and user-defined metadata and properties on the specified queue. Metadata is associated with the queue as name-values pairs. For more information, see Get Queue Metadata.
GetPropertiesAsync(CancellationToken)	Retrieves queue properties and user-defined metadata and properties on the specified queue. Metadata is associated with the queue as name-values pairs. For more information, see Get Queue Metadata.
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	Raises MessageDecodingFailed event.
PeekMessage(CancellationToken)	Retrieves one message from the front of the queue but does not alter the visibility of the message. For more information, see Peek Messages.
PeekMessageAsync(CancellationToken)	Retrieves one message from the front of the queue but does not alter the visibility of the message. For more information, see Peek Messages.
PeekMessages(Nullable<Int32>, CancellationToken)	Retrieves one or more messages from the front of the queue but does not alter the visibility of the message. For more information, see Peek Messages.
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	Retrieves one or more messages from the front of the queue but does not alter the visibility of the message. For more information, see Peek Messages.
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	Receives one message from the front of the queue. For more information, see Get Messages.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Retrieves one message from the front of the queue. For more information, see Get Messages.
ReceiveMessages()	Receives one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessages(CancellationToken)	Receives one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Receives one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessagesAsync()	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessagesAsync(CancellationToken)	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessage(String)	Adds a new message to the back of a queue. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessage(String, CancellationToken)	Adds a new message to the back of a queue. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessageAsync(String)	Adds a new message to the back of a queue. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessageAsync(String, CancellationToken)	Adds a new message to the back of a queue. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible to Dequeue and Peek operations. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Put Message.
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync sets stored access policies for the queue that may be used with Shared Access Signatures. For more information, see Set Queue ACL.
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync sets stored access policies for the queue that may be used with Shared Access Signatures. For more information, see Set Queue ACL.
SetMetadata(IDictionary<String,String>, CancellationToken)	Sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. For more information, see Set Queue Metadata.
SetMetadataAsync(IDictionary<String,String>, CancellationToken)	Sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. For more information, see Set Queue Metadata.
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)	Changes a message's visibility timeout and contents. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Update Message.
UpdateMessage(String, String, String, TimeSpan, CancellationToken)	Changes a message's visibility timeout and contents. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Update Message.
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	Changes a message's visibility timeout and contents. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Update Message.
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	Changes a message's visibility timeout and contents. A message must be in a format that can be included in an XML request with UTF-8 encoding. Otherwise MessageEncoding option can be set to Base64 to handle non compliant messages. The encoded message can be up to 64 KiB in size for versions 2011-08-18 and newer, or 8 KiB in size for previous versions. For more information, see Update Message.
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)	Creates a new instance of the QueueClient class, maintaining all the same internals but specifying new ClientSideEncryptionOptions.

Extension Methods

GetParentQueueServiceClient(QueueClient)	Create a new QueueServiceClient that pointing to this QueueClient's queue service. The new QueueServiceClient uses the same request policy pipeline as the QueueClient.
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)	Creates a new instance of the QueueClient class, maintaining all the same internals but specifying new ClientSideEncryptionOptions.