QueueServiceClient Class
Definition
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.
A QueueServiceClient represents a URL to the Azure Storage Queue service.
public class QueueServiceClient
type QueueServiceClient = class
Public Class QueueServiceClient
- Inheritance
-
QueueServiceClient
Constructors
QueueServiceClient() |
Initializes a new instance of the QueueServiceClient class for mocking. |
QueueServiceClient(String, QueueClientOptions) |
Initializes a new instance of the QueueServiceClient class. |
QueueServiceClient(String) |
Initializes a new instance of the QueueServiceClient class. |
QueueServiceClient(Uri, AzureSasCredential, QueueClientOptions) |
Initializes a new instance of the QueueServiceClient class. |
QueueServiceClient(Uri, QueueClientOptions) |
Initializes a new instance of the QueueServiceClient class. |
QueueServiceClient(Uri, StorageSharedKeyCredential, QueueClientOptions) |
Initializes a new instance of the QueueServiceClient class. |
QueueServiceClient(Uri, TokenCredential, QueueClientOptions) |
Initializes a new instance of the QueueServiceClient class. |
Properties
AccountName |
Gets the Storage account name corresponding to the service client. |
CanGenerateAccountSasUri |
Determines whether the client is able to generate a SAS. If the client is authenticated with a StorageSharedKeyCredential. |
Uri |
The Uri endpoint used by the object. |
Methods
CreateQueue(String, IDictionary<String,String>, CancellationToken) |
Creates a queue. For more information, see Create Queue. |
CreateQueueAsync(String, IDictionary<String,String>, CancellationToken) |
Creates a queue. For more information, see Create Queue. |
DeleteQueue(String, CancellationToken) |
Deletes a queue. For more information, see Delete Queue. |
DeleteQueueAsync(String, CancellationToken) |
Deletes a queue. For more information, see Delete Queue. |
GenerateAccountSasUri(AccountSasBuilder) |
The GenerateAccountSasUri(AccountSasBuilder) returns a Uri that generates a Service SAS based on the Client properties and builder passed. For more information, see Constructing a Service SAS |
GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) |
The GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) returns a Uri that generates a Queue Account Shared Access Signature based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client. For more information, see Constructing a Service SAS |
GetProperties(CancellationToken) |
Gets the properties of the queue service. For more information, see Get Queue Service Properties. |
GetPropertiesAsync(CancellationToken) |
Gets the properties of the queue service. For more information, see Get Queue Service Properties. |
GetQueueClient(String) |
Create a new QueueClient object by appending
|
GetQueues(QueueTraits, String, CancellationToken) |
The GetQueues(QueueTraits, String, CancellationToken) operation returns an async sequence of queues in the storage account. Enumerating the queues may make multiple requests to the service while fetching all the values. Queue names are returned in lexicographic order. For more information, see List Queues. |
GetQueuesAsync(QueueTraits, String, CancellationToken) |
The GetQueuesAsync(QueueTraits, String, CancellationToken) operation returns an async collection of queues in the storage account. Enumerating the queues may make multiple requests to the service while fetching all the values. Queue names are returned in lexicographic order. For more information, see List Queues. |
GetStatistics(CancellationToken) |
Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see Get Queue Service Stats. |
GetStatisticsAsync(CancellationToken) |
Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see Get Queue Service Stats. |
SetProperties(QueueServiceProperties, CancellationToken) |
Sets the properties of the queue service. For more information, see Set Queue Service Properties. |
SetPropertiesAsync(QueueServiceProperties, CancellationToken) |
Sets the properties of the queue service. For more information, see Set Queue Service Properties. |