CloudQueueClient 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.

Provides a client-side logical representation of the Microsoft Azure Queue service. This client is used to configure and execute requests against the Queue service.

public class CloudQueueClient

type CloudQueueClient = class

Public Class CloudQueueClient

Inheritance: Object
CloudQueueClient

Remarks

The service client encapsulates the endpoint or endpoints for the Queue service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.

Constructors

CloudQueueClient(StorageUri, StorageCredentials, DelegatingHandler)	Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.
CloudQueueClient(Uri, StorageCredentials, DelegatingHandler)	Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

Properties

AuthenticationScheme	Gets or sets the authentication scheme to use to sign HTTP requests.
BaseUri	Gets the base URI for the Queue service client, at the primary location.
BufferManager	Gets or sets a buffer manager that implements the IBufferManager interface, specifying a buffer pool for use with operations against the Queue service client.
Credentials	Gets the account credentials used to create the Queue service client.
DefaultRequestOptions	Gets and sets the default request options for requests made via the Queue service client.
StorageUri	Gets the Queue service endpoints for both the primary and secondary locations.

Methods

BeginGetServiceProperties(AsyncCallback, Object)	Begins an asynchronous operation to get service properties for the Queue service.
BeginGetServiceProperties(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get service properties for the Queue service.
BeginGetServiceStats(AsyncCallback, Object)	Begins an asynchronous operation to get service stats for the secondary Queue service endpoint.
BeginGetServiceStats(QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get service stats for the secondary Queue service endpoint.
BeginListQueuesSegmented(QueueContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of queues.
BeginListQueuesSegmented(String, QueueContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of queues.
BeginListQueuesSegmented(String, QueueListingDetails, Nullable<Int32>, QueueContinuationToken, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of queues.
BeginSetServiceProperties(ServiceProperties, AsyncCallback, Object)	Begins an asynchronous operation to set service properties for the Queue service.
BeginSetServiceProperties(ServiceProperties, QueueRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set service properties for the Queue service.
EndGetServiceProperties(IAsyncResult)	Ends an asynchronous operation to get service properties for the Queue service.
EndGetServiceStats(IAsyncResult)	Ends an asynchronous operation to get service stats for the secondary Queue service endpoint.
EndListQueuesSegmented(IAsyncResult)	Ends an asynchronous operation to return a result segment containing a collection of queues.
EndSetServiceProperties(IAsyncResult)	Ends an asynchronous operation to set service properties for the Queue service.
GetQueueReference(String)	Returns a reference to a CloudQueue object with the specified name.
GetServiceProperties(QueueRequestOptions, OperationContext)	Gets service properties for the Queue service.
GetServicePropertiesAsync()	Initiates an asynchronous operation to get service properties for the Queue service.
GetServicePropertiesAsync(CancellationToken)	Initiates an asynchronous operation to get service properties for the Queue service.
GetServicePropertiesAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to get service properties for the Queue service.
GetServicePropertiesAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get service properties for the Queue service.
GetServiceStats(QueueRequestOptions, OperationContext)	Gets service stats for the secondary Queue service endpoint.
GetServiceStatsAsync()	Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.
GetServiceStatsAsync(CancellationToken)	Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.
GetServiceStatsAsync(QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.
GetServiceStatsAsync(QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.
ListQueues(String, QueueListingDetails, QueueRequestOptions, OperationContext)	Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix and that are retrieved lazily.
ListQueuesSegmented(QueueContinuationToken)	Returns a result segment containing a collection of queues.
ListQueuesSegmented(String, QueueContinuationToken)	Returns a result segment containing a collection of queues.
ListQueuesSegmented(String, QueueListingDetails, Nullable<Int32>, QueueContinuationToken, QueueRequestOptions, OperationContext)	Returns a result segment containing a collection of queues.
ListQueuesSegmentedAsync(QueueContinuationToken)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
ListQueuesSegmentedAsync(QueueContinuationToken, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
ListQueuesSegmentedAsync(String, QueueContinuationToken)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
ListQueuesSegmentedAsync(String, QueueContinuationToken, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
ListQueuesSegmentedAsync(String, QueueListingDetails, Nullable<Int32>, QueueContinuationToken, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
ListQueuesSegmentedAsync(String, QueueListingDetails, Nullable<Int32>, QueueContinuationToken, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of queues.
SetServiceProperties(ServiceProperties, QueueRequestOptions, OperationContext)	Sets service properties for the Queue service.
SetServicePropertiesAsync(ServiceProperties)	Initiates an asynchronous operation to set service properties for the Queue service.
SetServicePropertiesAsync(ServiceProperties, CancellationToken)	Initiates an asynchronous operation to set service properties for the Queue service.
SetServicePropertiesAsync(ServiceProperties, QueueRequestOptions, OperationContext)	Initiates an asynchronous operation to set service properties for the Queue service.
SetServicePropertiesAsync(ServiceProperties, QueueRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to set service properties for the Queue service.

Applies to