Table of Contents

Class CloudBlobClient

Namespace
Microsoft.WindowsAzure.Storage.Blob
Assembly
Microsoft.WindowsAzure.Storage.dll

Provides a client-side logical representation of Microsoft Azure Blob storage.

public class CloudBlobClient
Inheritance
CloudBlobClient
Inherited Members

Constructors

CloudBlobClient(StorageUri, StorageCredentials)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

public CloudBlobClient(StorageUri storageUri, StorageCredentials credentials)

Parameters

storageUri StorageUri

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

credentials StorageCredentials

A StorageCredentials object.

CloudBlobClient(Uri)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.

public CloudBlobClient(Uri baseUri)

Parameters

baseUri Uri

A System.Uri object containing the Blob service endpoint to use to create the client.

CloudBlobClient(Uri, StorageCredentials)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

public CloudBlobClient(Uri baseUri, StorageCredentials credentials)

Parameters

baseUri Uri

A System.Uri object containing the Blob 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 Blob service client at the primary location.

public Uri BaseUri { get; }

Property Value

Uri

A System.Uri object containing the base URI used to construct the Blob 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 Blob service client.

public IBufferManager BufferManager { get; set; }

Property Value

IBufferManager

An object of type IBufferManager.

Credentials

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

public StorageCredentials Credentials { get; }

Property Value

StorageCredentials

A StorageCredentials object.

DefaultDelimiter

Gets or sets the default delimiter that may be used to create a virtual directory structure of blobs.

public string DefaultDelimiter { get; set; }

Property Value

string

A string containing the default delimiter for the Blob service.

DefaultRequestOptions

Gets or sets the default request options for requests made via the Blob service client.

public BlobRequestOptions DefaultRequestOptions { get; set; }

Property Value

BlobRequestOptions

A BlobRequestOptions object.

RetryPolicy

Gets or sets the default retry policy for requests made via the Blob service client.

[Obsolete("Use DefaultRequestOptions.RetryPolicy.")]
public IRetryPolicy RetryPolicy { get; set; }

Property Value

IRetryPolicy

An object of type IRetryPolicy.

StorageUri

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

public StorageUri StorageUri { get; }

Property Value

StorageUri

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

Methods

BeginGetAccountProperties(BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get account properties for the Blob service.

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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.

BeginGetAccountProperties(AsyncCallback, object)

Begins an asynchronous operation to get account properties for the Blob service.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetAccountProperties(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.

BeginGetBlobReferenceFromServer(StorageUri, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get a reference to a blob.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

blobUri StorageUri

A StorageUri containing the URI of the blob.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions object that specifies any 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.

BeginGetBlobReferenceFromServer(Uri, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get a reference to a blob.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions 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.

BeginGetBlobReferenceFromServer(Uri, AsyncCallback, object)

Begins an asynchronous operation to get a reference to a blob.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(Uri blobUri, AsyncCallback callback, object state)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

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.

BeginGetServiceProperties(BlobRequestOptions, OperationContext, AsyncCallback, object)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob 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(BlobRequestOptions, OperationContext, AsyncCallback, object)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob 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.

BeginListBlobsSegmented(string, BlobContinuationToken, AsyncCallback, object)

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginListBlobsSegmented(string prefix, BlobContinuationToken currentToken, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the blob name prefix, including the container name.

currentToken BlobContinuationToken

A BlobContinuationToken object 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.

BeginListBlobsSegmented(string, bool, BlobListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginListBlobsSegmented(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the blob name prefix, including the container name.

useFlatBlobListing bool

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails BlobListingDetails

A BlobListingDetails 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 BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions 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.

BeginListContainersSegmented(BlobContinuationToken, AsyncCallback, object)

Begins an asynchronous request to return a result segment containing a collection of containers.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginListContainersSegmented(BlobContinuationToken continuationToken, AsyncCallback callback, object state)

Parameters

continuationToken BlobContinuationToken

A BlobContinuationToken object 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.

BeginListContainersSegmented(string, BlobContinuationToken, AsyncCallback, object)

Begins an asynchronous request to return a result segment containing a collection of containers.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginListContainersSegmented(string prefix, BlobContinuationToken continuationToken, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the container name prefix.

continuationToken BlobContinuationToken

A BlobContinuationToken object 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.

BeginListContainersSegmented(string, ContainerListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to return a result segment containing a collection of containers whose names begin with the specified prefix.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

prefix string

A string containing the container name prefix.

detailsIncluded ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned in the result segment, 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.

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions 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.

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

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

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

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob 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.

EndGetAccountProperties(IAsyncResult)

Ends an asynchronous operation to get account properties for the Blob service.

public virtual AccountProperties EndGetAccountProperties(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

AccountProperties

A AccountProperties object.

EndGetBlobReferenceFromServer(IAsyncResult)

Ends an asynchronous operation to get a reference to a blob.

public virtual ICloudBlob EndGetBlobReferenceFromServer(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

ICloudBlob

An ICloudBlob object.

EndGetServiceProperties(IAsyncResult)

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

public virtual ServiceProperties EndGetServiceProperties(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

ServiceProperties

A ServiceProperties object.

EndGetServiceStats(IAsyncResult)

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

public virtual ServiceStats EndGetServiceStats(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

ServiceStats

A ServiceStats object.

EndListBlobsSegmented(IAsyncResult)

Ends an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual BlobResultSegment EndListBlobsSegmented(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

BlobResultSegment

A BlobResultSegment object.

EndListContainersSegmented(IAsyncResult)

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

public virtual ContainerResultSegment EndListContainersSegmented(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

Returns

ContainerResultSegment

A ContainerResultSegment object.

EndSetServiceProperties(IAsyncResult)

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

public virtual void EndSetServiceProperties(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult

An IAsyncResult that references the pending asynchronous operation.

GetAccountProperties(BlobRequestOptions, OperationContext)

Gets account properties for the Blob service.

[DoesServiceRequest]
public virtual AccountProperties GetAccountProperties(BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

AccountProperties

An AccountProperties object.

GetAccountPropertiesAsync()

Initiates an asynchronous operation to get account properties for the Blob service.

[DoesServiceRequest]
public virtual Task<AccountProperties> GetAccountPropertiesAsync()

Returns

Task<AccountProperties>

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

GetAccountPropertiesAsync(BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to get account properties for the Blob service.

[DoesServiceRequest]
public virtual Task<AccountProperties> GetAccountPropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext)

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

Task<AccountProperties>

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

GetAccountPropertiesAsync(BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to get account properties for the Blob service.

[DoesServiceRequest]
public virtual Task<AccountProperties> GetAccountPropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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<AccountProperties>

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

GetAccountPropertiesAsync(CancellationToken)

Initiates an asynchronous operation to get account properties for the Blob service.

[DoesServiceRequest]
public virtual Task<AccountProperties> GetAccountPropertiesAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

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

Returns

Task<AccountProperties>

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

GetBlobReferenceFromServer(StorageUri, AccessCondition, BlobRequestOptions, OperationContext)

Gets a reference to a blob.

[DoesServiceRequest]
public virtual ICloudBlob GetBlobReferenceFromServer(StorageUri blobUri, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

blobUri StorageUri

A StorageUri containing the URI of the blob.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions object that specifies any 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

ICloudBlob

An ICloudBlob object.

GetBlobReferenceFromServer(Uri, AccessCondition, BlobRequestOptions, OperationContext)

Gets a reference to a blob.

[DoesServiceRequest]
public virtual ICloudBlob GetBlobReferenceFromServer(Uri blobUri, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions 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

ICloudBlob

An ICloudBlob object.

GetBlobReferenceFromServerAsync(StorageUri, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

blobUri StorageUri

A StorageUri containing the URI of the blob.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

An BlobRequestOptions object that specifies any additional options for the request.

operationContext OperationContext

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

Returns

Task<ICloudBlob>

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

GetBlobReferenceFromServerAsync(StorageUri, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

blobUri StorageUri

A StorageUri containing the URI of the blob.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

An BlobRequestOptions object that specifies any 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<ICloudBlob>

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

GetBlobReferenceFromServerAsync(Uri)

Initiates an asynchronous operation that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

Returns

Task<ICloudBlob>

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

GetBlobReferenceFromServerAsync(Uri, AccessCondition, BlobRequestOptions, OperationContext)

Returns a Task<TResult> object that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

Task<ICloudBlob>

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

GetBlobReferenceFromServerAsync(Uri, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

accessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options BlobRequestOptions

A BlobRequestOptions 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<ICloudBlob>

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

GetBlobReferenceFromServerAsync(Uri, CancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, CancellationToken cancellationToken)

Parameters

blobUri Uri

A System.Uri containing the URI of the blob. The service assumes this is the URI for the blob at the primary location.

cancellationToken CancellationToken

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

Returns

Task<ICloudBlob>

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

GetContainerReference(string)

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

public virtual CloudBlobContainer GetContainerReference(string containerName)

Parameters

containerName string

A string containing the name of the container.

Returns

CloudBlobContainer

A CloudBlobContainer object.

GetRootContainerReference()

Returns a reference to the root container.

public virtual CloudBlobContainer GetRootContainerReference()

Returns

CloudBlobContainer

A CloudBlobContainer object.

Remarks

Note that the root container must be explicitly created, if it does not already exist, before you can read from it or write to it.

GetServiceProperties(BlobRequestOptions, OperationContext)

Gets service properties for the Blob service.

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 object.

GetServicePropertiesAsync()

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

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

Returns

Task<ServiceProperties>

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

GetServicePropertiesAsync(BlobRequestOptions, OperationContext)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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(BlobRequestOptions, OperationContext, CancellationToken)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob 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(BlobRequestOptions, OperationContext)

Gets service stats for the secondary Blob service endpoint.

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob service endpoint.

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

Returns

Task<ServiceStats>

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

GetServiceStatsAsync(BlobRequestOptions, OperationContext)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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(BlobRequestOptions, OperationContext, CancellationToken)

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

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

Parameters

requestOptions BlobRequestOptions

A BlobRequestOptions 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 Blob 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.

ListBlobs(string, bool, BlobListingDetails, BlobRequestOptions, OperationContext)

Returns an enumerable collection of blobs in the container, retrieved lazily.

[DoesServiceRequest]
public virtual IEnumerable<IListBlobItem> ListBlobs(string prefix, bool useFlatBlobListing = false, BlobListingDetails blobListingDetails = BlobListingDetails.None, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

prefix string

A string containing the blob name prefix.

useFlatBlobListing bool

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails BlobListingDetails

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

options BlobRequestOptions

A BlobRequestOptions 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<IListBlobItem>

An enumerable collection of objects that implement IListBlobItem and are retrieved lazily.

ListBlobsSegmented(string, BlobContinuationToken)

Returns a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual BlobResultSegment ListBlobsSegmented(string prefix, BlobContinuationToken currentToken)

Parameters

prefix string

A string containing the blob name prefix, including the container name.

currentToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

BlobResultSegment

A BlobResultSegment object.

ListBlobsSegmented(string, bool, BlobListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext)

Returns a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual BlobResultSegment ListBlobsSegmented(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext)

Parameters

prefix string

A string containing the blob name prefix, including the container name.

useFlatBlobListing bool

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails BlobListingDetails

A BlobListingDetails 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 BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

BlobResultSegment

A BlobResultSegment object.

ListBlobsSegmentedAsync(string, BlobContinuationToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, BlobContinuationToken currentToken)

Parameters

prefix string

A string containing the blob name prefix, including the container name.

currentToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

Task<BlobResultSegment>

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

ListBlobsSegmentedAsync(string, BlobContinuationToken, CancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, BlobContinuationToken currentToken, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the blob name prefix.

currentToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

cancellationToken CancellationToken

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

Returns

Task<BlobResultSegment>

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

ListBlobsSegmentedAsync(string, bool, BlobListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext)

Parameters

prefix string

A string containing the blob name prefix.

useFlatBlobListing bool

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails BlobListingDetails

A BlobListingDetails 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 BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

Task<BlobResultSegment>

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

ListBlobsSegmentedAsync(string, bool, BlobListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

[DoesServiceRequest]
public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the blob name prefix.

useFlatBlobListing bool

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails BlobListingDetails

A BlobListingDetails 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 BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions 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<BlobResultSegment>

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

ListContainers(string, ContainerListingDetails, BlobRequestOptions, OperationContext)

Returns an enumerable collection of containers whose names begin with the specified prefix and that are retrieved lazily.

[DoesServiceRequest]
public virtual IEnumerable<CloudBlobContainer> ListContainers(string prefix = null, ContainerListingDetails detailsIncluded = ContainerListingDetails.None, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

prefix string

A string containing the container name prefix.

detailsIncluded ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

options BlobRequestOptions

A BlobRequestOptions 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<CloudBlobContainer>

An enumerable collection of CloudBlobContainer objects that are retrieved lazily.

ListContainersSegmented(BlobContinuationToken)

Returns a result segment containing a collection of CloudBlobContainer objects.

[DoesServiceRequest]
public virtual ContainerResultSegment ListContainersSegmented(BlobContinuationToken currentToken)

Parameters

currentToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

ContainerResultSegment

A ContainerResultSegment object.

ListContainersSegmented(string, BlobContinuationToken)

Returns a result segment containing a collection of CloudBlobContainer objects.

[DoesServiceRequest]
public virtual ContainerResultSegment ListContainersSegmented(string prefix, BlobContinuationToken currentToken)

Parameters

prefix string

A string containing the container name prefix.

currentToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

ContainerResultSegment

A ContainerResultSegment object.

ListContainersSegmented(string, ContainerListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext)

Returns a result segment containing a collection of containers whose names begin with the specified prefix.

[DoesServiceRequest]
public virtual ContainerResultSegment ListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

prefix string

A string containing the container name prefix.

detailsIncluded ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned in the result segment, 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 BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions 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

ContainerResultSegment

A ContainerResultSegment object.

ListContainersSegmentedAsync(BlobContinuationToken)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(BlobContinuationToken continuationToken)

Parameters

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

Task<ContainerResultSegment>

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

ListContainersSegmentedAsync(BlobContinuationToken, CancellationToken)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(BlobContinuationToken continuationToken, CancellationToken cancellationToken)

Parameters

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

cancellationToken CancellationToken

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

Returns

Task<ContainerResultSegment>

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

ListContainersSegmentedAsync(string, BlobContinuationToken)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, BlobContinuationToken continuationToken)

Parameters

prefix string

A string containing the container name prefix.

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

Task<ContainerResultSegment>

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

ListContainersSegmentedAsync(string, BlobContinuationToken, CancellationToken)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, BlobContinuationToken continuationToken, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the container name prefix.

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

cancellationToken CancellationToken

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

Returns

Task<ContainerResultSegment>

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

ListContainersSegmentedAsync(string, ContainerListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext)

Parameters

prefix string

A string containing the container name prefix.

detailsIncluded ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned in the result segment, 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.

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext OperationContext

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

Returns

Task<ContainerResultSegment>

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

ListContainersSegmentedAsync(string, ContainerListingDetails, int?, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)

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

[DoesServiceRequest]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

prefix string

A string containing the container name prefix.

detailsIncluded ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

maxResults int?

A non-negative integer value that indicates the maximum number of results to be returned in the result segment, 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.

continuationToken BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

options BlobRequestOptions

A BlobRequestOptions 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<ContainerResultSegment>

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

SetServiceProperties(ServiceProperties, BlobRequestOptions, OperationContext)

Sets service properties for the Blob service.

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

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions BlobRequestOptions

A BlobRequestOptions 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 that sets service properties for the Blob 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, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that sets service properties for the Blob service.

[DoesServiceRequest]
public virtual Task SetServicePropertiesAsync(ServiceProperties properties, BlobRequestOptions requestOptions, OperationContext operationContext)

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions BlobRequestOptions

A BlobRequestOptions 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, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that sets service properties for the Blob service.

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

Parameters

properties ServiceProperties

A ServiceProperties object.

requestOptions BlobRequestOptions

A BlobRequestOptions 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 that sets service properties for the Blob 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.