Class CloudQueueClient

Namespace

Microsoft.WindowsAzure.Storage.Queue

Assembly

Microsoft.WindowsAzure.Storage.dll

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

Inheritance

object

CloudQueueClient

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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)

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

public CloudQueueClient(StorageUri storageUri, StorageCredentials credentials)

Parameters

storageUri StorageUri

A StorageUri object containing the Queue service endpoint to use to create the client.

credentials StorageCredentials

A StorageCredentials object.

CloudQueueClient(Uri, StorageCredentials)

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

public CloudQueueClient(Uri baseUri, StorageCredentials credentials)

Parameters

baseUri Uri

The System.Uri containing the Queue service endpoint to use to create the client.

credentials StorageCredentials

A StorageCredentials object.

Properties

AuthenticationScheme

Gets or sets the authentication scheme to use to sign HTTP requests.

public AuthenticationScheme AuthenticationScheme { get; set; }

Property Value

AuthenticationScheme

Remarks

This property is set only when Shared Key or Shared Key Lite credentials are used; it does not apply to authentication via a shared access signature or anonymous access.

BaseUri

Gets the base URI for the Queue service client, at the primary location.

public Uri BaseUri { get; }

Property Value

Uri

A System.Uri object 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.

public IBufferManager BufferManager { get; set; }

Property Value

IBufferManager

An object of type IBufferManager.

Credentials

Gets the account credentials used to create the Queue service client.

public StorageCredentials Credentials { get; }

Property Value

StorageCredentials

A StorageCredentials object.

DefaultRequestOptions

Gets and sets the default request options for requests made via the Queue service client.

public QueueRequestOptions DefaultRequestOptions { get; set; }

Property Value

QueueRequestOptions

A QueueRequestOptions object.

StorageUri

Gets the Queue service endpoints for both the primary and secondary locations.

public StorageUri StorageUri { get; }

Property Value

StorageUri

An object of type StorageUri containing Queue service URIs for both the primary and secondary locations.

Methods

BeginGetServiceProperties(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetServiceProperties(QueueRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginGetServiceProperties(AsyncCallback, object)

Begins an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetServiceProperties(AsyncCallback callback, object state)

Parameters

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginGetServiceStats(QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetServiceStats(QueueRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginGetServiceStats(AsyncCallback, object)

Begins an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetServiceStats(AsyncCallback callback, object state)

Parameters

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginListQueuesSegmented(QueueContinuationToken, AsyncCallback, object)

Begins an asynchronous operation to return a result segment containing a collection of queues.

public virtual ICancellableAsyncResult BeginListQueuesSegmented(QueueContinuationToken currentToken, AsyncCallback callback, object state)

Parameters

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginListQueuesSegmented(string, QueueListingDetails, int?, QueueContinuationToken, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to return a result segment containing a collection of queues.

public virtual ICancellableAsyncResult BeginListQueuesSegmented(string prefix, QueueListingDetails queueListingDetails, int? maxResults, QueueContinuationToken currentToken, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the queue name prefix.

queueListingDetails QueueListingDetails

A QueueListingDetails enumeration describing which items to include in the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginListQueuesSegmented(string, QueueContinuationToken, AsyncCallback, object)

Begins an asynchronous operation to return a result segment containing a collection of queues.

public virtual ICancellableAsyncResult BeginListQueuesSegmented(string prefix, QueueContinuationToken currentToken, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the queue name prefix.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginSetServiceProperties(ServiceProperties, QueueRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetServiceProperties(ServiceProperties properties, QueueRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

BeginSetServiceProperties(ServiceProperties, AsyncCallback, object)

Begins an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetServiceProperties(ServiceProperties properties, AsyncCallback callback, object state)

Parameters

properties ServiceProperties

A ServiceProperties object.

callback AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state object

A user-defined object to be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

EndGetServiceProperties(IAsyncResult)

Ends an asynchronous operation to get service properties for the Queue service.

public virtual ServiceProperties EndGetServiceProperties(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The result returned from a prior call to BeginGetServiceProperties(AsyncCallback, object).

Returns

ServiceProperties

A ServiceProperties object.

EndGetServiceStats(IAsyncResult)

Ends an asynchronous operation to get service stats for the secondary Queue service endpoint.

public virtual ServiceStats EndGetServiceStats(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

ServiceStats

A ServiceStats object.

EndListQueuesSegmented(IAsyncResult)

Ends an asynchronous operation to return a result segment containing a collection of queues.

public virtual QueueResultSegment EndListQueuesSegmented(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

QueueResultSegment

A QueueResultSegment object.

EndSetServiceProperties(IAsyncResult)

Ends an asynchronous operation to set service properties for the Queue service.

public virtual void EndSetServiceProperties(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

The IAsyncResult returned from a prior call to BeginSetServiceProperties(ServiceProperties, AsyncCallback, object).

GetQueueReference(string)

Returns a reference to a CloudQueue object with the specified name.

public virtual CloudQueue GetQueueReference(string queueName)

Parameters

queueName string

A string containing the name of the queue.

Returns

CloudQueue

A CloudQueue object.

GetServiceProperties(QueueRequestOptions, OperationContext)

Gets service properties for the Queue service.

[DoesServiceRequest]
public virtual ServiceProperties GetServiceProperties(QueueRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

ServiceProperties

A ServiceProperties containing the Queue service properties.

GetServicePropertiesAsync()

Initiates an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual Task<ServiceProperties> GetServicePropertiesAsync()

Returns

Task<ServiceProperties>

A Task<TResult> object of type ServiceProperties that represents the asynchronous operation.

GetServicePropertiesAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual Task<ServiceProperties> GetServicePropertiesAsync(QueueRequestOptions requestOptions, OperationContext operationContext)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

Task<ServiceProperties>

A Task<TResult> object of type ServiceProperties that represents the asynchronous operation.

GetServicePropertiesAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual Task<ServiceProperties> GetServicePropertiesAsync(QueueRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<ServiceProperties>

A Task<TResult> object of type ServiceProperties that represents the asynchronous operation.

GetServicePropertiesAsync(CancellationToken)

Initiates an asynchronous operation to get service properties for the Queue service.

[DoesServiceRequest]
public virtual Task<ServiceProperties> GetServicePropertiesAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<ServiceProperties>

A Task<TResult> object of type ServiceProperties that represents the asynchronous operation.

GetServiceStats(QueueRequestOptions, OperationContext)

Gets service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual ServiceStats GetServiceStats(QueueRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

ServiceStats

A ServiceStats object.

GetServiceStatsAsync()

Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual Task<ServiceStats> GetServiceStatsAsync()

Returns

Task<ServiceStats>

A Task<TResult> object of type ServiceStats that represents the asynchronous operation.

GetServiceStatsAsync(QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual Task<ServiceStats> GetServiceStatsAsync(QueueRequestOptions requestOptions, OperationContext operationContext)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

Task<ServiceStats>

A Task<TResult> object of type ServiceStats that represents the asynchronous operation.

GetServiceStatsAsync(QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual Task<ServiceStats> GetServiceStatsAsync(QueueRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<ServiceStats>

A Task<TResult> object of type ServiceStats that represents the asynchronous operation.

GetServiceStatsAsync(CancellationToken)

Initiates an asynchronous operation to get service stats for the secondary Queue service endpoint.

[DoesServiceRequest]
public virtual Task<ServiceStats> GetServiceStatsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<ServiceStats>

A Task<TResult> object of type ServiceStats that represents the asynchronous operation.

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.

public virtual IEnumerable<CloudQueue> ListQueues(string prefix = null, QueueListingDetails queueListingDetails = QueueListingDetails.None, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

prefix string

A string containing the queue name prefix.

queueListingDetails QueueListingDetails

A QueueListingDetails enumeration value that indicates which details to include in the listing.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

IEnumerable<CloudQueue>

An enumerable collection of objects of type CloudQueue that are retrieved lazily.

ListQueuesSegmented(QueueContinuationToken)

Returns a result segment containing a collection of queues.

public virtual QueueResultSegment ListQueuesSegmented(QueueContinuationToken currentToken)

Parameters

currentToken QueueContinuationToken

A QueueContinuationToken continuation token returned by a previous listing operation.

Returns

QueueResultSegment

A QueueResultSegment object.

ListQueuesSegmented(string, QueueListingDetails, int?, QueueContinuationToken, QueueRequestOptions, OperationContext)

Returns a result segment containing a collection of queues.

public virtual QueueResultSegment ListQueuesSegmented(string prefix, QueueListingDetails queueListingDetails, int? maxResults, QueueContinuationToken currentToken, QueueRequestOptions options = null, OperationContext operationContext = null)

Parameters

prefix string

A string containing the queue name prefix.

queueListingDetails QueueListingDetails

A QueueListingDetails enumeration describing which items to include in the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

QueueResultSegment

A QueueResultSegment object.

ListQueuesSegmented(string, QueueContinuationToken)

Returns a result segment containing a collection of queues.

public virtual QueueResultSegment ListQueuesSegmented(string prefix, QueueContinuationToken currentToken)

Parameters

prefix string

A string containing the queue name prefix.

currentToken QueueContinuationToken

A QueueContinuationToken continuation token returned by a previous listing operation.

Returns

QueueResultSegment

A QueueResultSegment object.

ListQueuesSegmentedAsync(QueueContinuationToken)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(QueueContinuationToken currentToken)

Parameters

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

ListQueuesSegmentedAsync(QueueContinuationToken, CancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(QueueContinuationToken currentToken, CancellationToken cancellationToken)

Parameters

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

ListQueuesSegmentedAsync(string, QueueListingDetails, int?, QueueContinuationToken, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(string prefix, QueueListingDetails queueListingDetails, int? maxResults, QueueContinuationToken currentToken, QueueRequestOptions options, OperationContext operationContext)

Parameters

prefix string

A string containing the queue name prefix.

queueListingDetails QueueListingDetails

A QueueListingDetails enumeration describing which items to include in the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

ListQueuesSegmentedAsync(string, QueueListingDetails, int?, QueueContinuationToken, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(string prefix, QueueListingDetails queueListingDetails, int? maxResults, QueueContinuationToken currentToken, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the queue name prefix.

queueListingDetails QueueListingDetails

A QueueListingDetails enumeration describing which items to include in the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

ListQueuesSegmentedAsync(string, QueueContinuationToken)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(string prefix, QueueContinuationToken currentToken)

Parameters

prefix string

A string containing the queue name prefix.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

ListQueuesSegmentedAsync(string, QueueContinuationToken, CancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of queues.

[DoesServiceRequest]
public virtual Task<QueueResultSegment> ListQueuesSegmentedAsync(string prefix, QueueContinuationToken currentToken, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the queue name prefix.

currentToken QueueContinuationToken

A QueueContinuationToken returned by a previous listing operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<QueueResultSegment>

A Task<TResult> object of type QueueResultSegment that represents the asynchronous operation.

SetServiceProperties(ServiceProperties, QueueRequestOptions, OperationContext)

Sets service properties for the Queue service.

[DoesServiceRequest]
public virtual void SetServiceProperties(ServiceProperties properties, QueueRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

SetServicePropertiesAsync(ServiceProperties)

Initiates an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual Task SetServicePropertiesAsync(ServiceProperties properties)

Parameters

properties ServiceProperties

A ServiceProperties object.

Returns

Task

A Task object that represents the asynchronous operation.

SetServicePropertiesAsync(ServiceProperties, QueueRequestOptions, OperationContext)

Initiates an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual Task SetServicePropertiesAsync(ServiceProperties properties, QueueRequestOptions options, OperationContext operationContext)

Parameters

properties ServiceProperties

A ServiceProperties object.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.

SetServicePropertiesAsync(ServiceProperties, QueueRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual Task SetServicePropertiesAsync(ServiceProperties properties, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

properties ServiceProperties

A ServiceProperties object.

options QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

SetServicePropertiesAsync(ServiceProperties, CancellationToken)

Initiates an asynchronous operation to set service properties for the Queue service.

[DoesServiceRequest]
public virtual Task SetServicePropertiesAsync(ServiceProperties properties, CancellationToken cancellationToken)

Parameters

properties ServiceProperties

A ServiceProperties object.

cancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.