Class CloudBlobContainer

Namespace: Microsoft.WindowsAzure.Storage.Blob

Assembly: Microsoft.WindowsAzure.Storage.dll

Represents a container in the Microsoft Azure Blob service.

public class CloudBlobContainer

Inheritance: object

CloudBlobContainer

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CloudBlobContainer(StorageUri, StorageCredentials)

Initializes a new instance of the CloudBlobContainer class.

public CloudBlobContainer(StorageUri containerAddress, StorageCredentials credentials)

Parameters

containerAddress StorageUri: A System.Uri object specifying the absolute URI to the container.
credentials StorageCredentials: A StorageCredentials object.

CloudBlobContainer(Uri)

Initializes a new instance of the CloudBlobContainer class.

public CloudBlobContainer(Uri containerAddress)

Parameters

containerAddress Uri: A System.Uri object specifying the absolute URI to the container.

CloudBlobContainer(Uri, StorageCredentials)

Initializes a new instance of the CloudBlobContainer class.

public CloudBlobContainer(Uri containerAddress, StorageCredentials credentials)

Parameters

containerAddress Uri: A System.Uri object specifying the absolute URI to the container.
credentials StorageCredentials: A StorageCredentials object.

Properties

Metadata

Gets the container's metadata.

public IDictionary<string, string> Metadata { get; }

Property Value

IDictionary<string, string>: An IDictionary<TKey, TValue> object containing the container's metadata.

Name

Gets the name of the container.

public string Name { get; }

Property Value

string: A string containing the container name.

Properties

Gets the container's system properties.

public BlobContainerProperties Properties { get; }

Property Value

BlobContainerProperties: A BlobContainerProperties object.

ServiceClient

Gets the Blob service client for the container.

public CloudBlobClient ServiceClient { get; }

Property Value

CloudBlobClient: A CloudBlobClient object.

StorageUri

Gets the container's URIs for both the primary and secondary locations.

public StorageUri StorageUri { get; }

Property Value

StorageUri: An object of type StorageUri containing the container's URIs for both the primary and secondary locations.

Uri

Gets the container's URI for the primary location.

public Uri Uri { get; }

Property Value

Uri: A System.Uri specifying the absolute URI to the container at the primary location.

Methods

AcquireLease(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext)

Acquires a lease on this container.

[DoesServiceRequest]
public virtual string AcquireLease(TimeSpan? leaseTime, string proposedLeaseId, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
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

string: The ID of the acquired lease.

AcquireLeaseAsync(TimeSpan?, string)

Initiates an asynchronous operation that acquires a lease on this container.

[DoesServiceRequest]
public virtual Task<string> AcquireLeaseAsync(TimeSpan? leaseTime, string proposedLeaseId = null)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.

Returns

Task<string>: A Task<TResult> object that represents the asynchronous operation.

AcquireLeaseAsync(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that acquires a lease on this container.

[DoesServiceRequest]
public virtual Task<string> AcquireLeaseAsync(TimeSpan? leaseTime, string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
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<string>: A Task<TResult> object that represents the asynchronous operation.

AcquireLeaseAsync(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that acquires a lease on this container.

[DoesServiceRequest]
public virtual Task<string> AcquireLeaseAsync(TimeSpan? leaseTime, string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
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<string>: A Task<TResult> object that represents the asynchronous operation.

AcquireLeaseAsync(TimeSpan?, string, CancellationToken)

Initiates an asynchronous operation that acquires a lease on this container.

[DoesServiceRequest]
public virtual Task<string> AcquireLeaseAsync(TimeSpan? leaseTime, string proposedLeaseId, CancellationToken cancellationToken)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<string>: A Task<TResult> object that represents the asynchronous operation.

BeginAcquireLease(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to acquire a lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginAcquireLease(TimeSpan? leaseTime, string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
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.
callback AsyncCallback: An optional callback 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.

BeginAcquireLease(TimeSpan?, string, AsyncCallback, object)

Begins an asynchronous operation to acquire a lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginAcquireLease(TimeSpan? leaseTime, string proposedLeaseId, AsyncCallback callback, object state)

Parameters

leaseTime TimeSpan?: A TimeSpan representing the span of time for which to acquire the lease, which will be rounded down to seconds. If null, an infinite lease will be acquired. If not null, this must be 15 to 60 seconds.
proposedLeaseId string: A string representing the proposed lease ID for the new lease, or null if no lease ID is proposed.
callback AsyncCallback: An optional callback 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.

BeginBreakLease(TimeSpan?, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to break the current lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginBreakLease(TimeSpan? breakPeriod, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
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.
callback AsyncCallback: An optional callback 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.

BeginBreakLease(TimeSpan?, AsyncCallback, object)

Begins an asynchronous operation to break the current lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginBreakLease(TimeSpan? breakPeriod, AsyncCallback callback, object state)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
callback AsyncCallback: An optional callback 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.

BeginChangeLease(string, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to change the lease on this container.

public virtual ICancellableAsyncResult BeginChangeLease(string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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.
callback AsyncCallback: An optional callback 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.

BeginChangeLease(string, AccessCondition, AsyncCallback, object)

Begins an asynchronous operation to change the lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginChangeLease(string proposedLeaseId, AccessCondition accessCondition, AsyncCallback callback, object state)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
callback AsyncCallback: An optional callback 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.

BeginCreate(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to create a container and specify the level of access to the container's data.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreate(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
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.

BeginCreate(BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to create a container.

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

Parameters

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.

BeginCreate(AsyncCallback, object)

Begins an asynchronous operation to create a container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreate(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginCreateIfNotExists(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to create the container if it does not already exist.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreateIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and the level of access.
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.

Remarks

This API requires Create or Write permissions.

BeginCreateIfNotExists(BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to create the container if it does not already exist.

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

Parameters

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.

Remarks

This API requires Create or Write permissions.

BeginCreateIfNotExists(AsyncCallback, object)

Begins an asynchronous request to create the container if it does not already exist.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginCreateIfNotExists(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

Remarks

This API requires Create or Write permissions.

BeginDelete(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to delete a container.

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

Parameters

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.

BeginDelete(AsyncCallback, object)

Begins an asynchronous operation to delete a container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDelete(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginDeleteIfExists(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to delete the container if it already exists.

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

Parameters

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.

BeginDeleteIfExists(AsyncCallback, object)

Begins an asynchronous request to delete the container if it already exists.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginDeleteIfExists(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginExists(BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to check whether the container exists.

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

Parameters

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.

BeginExists(AsyncCallback, object)

Begins an asynchronous request to check whether the container exists.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginExists(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginFetchAttributes(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to retrieve the container's attributes.

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

Parameters

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.

BeginFetchAttributes(AsyncCallback, object)

Begins an asynchronous operation to retrieve the container's attributes.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginFetchAttributes(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginGetAccountProperties(BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get properties for the account this container resides on.

[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 properties for the account this container resides on.

[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(string, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to get a reference to a blob in this container.

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

Parameters

blobName string: A string containing the name 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 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(string, AsyncCallback, object)

Begins an asynchronous operation to get a reference to a blob in this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(string blobName, AsyncCallback callback, object state)

Parameters

blobName string: A string containing the name of the blob.
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.

BeginGetPermissions(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to get the permissions settings for the container.

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

Parameters

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.

BeginGetPermissions(AsyncCallback, object)

Begins an asynchronous request to get the permissions settings for the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginGetPermissions(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginListBlobsSegmented(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(BlobContinuationToken currentToken, AsyncCallback callback, object state)

Parameters

currentToken BlobContinuationToken: A continuation token 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, 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.
currentToken BlobContinuationToken: A continuation token 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.
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 continuation token 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.

BeginReleaseLease(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to release the lease on this container.

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

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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.
callback AsyncCallback: An optional callback 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.

BeginReleaseLease(AccessCondition, AsyncCallback, object)

Begins an asynchronous operation to release the lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginReleaseLease(AccessCondition accessCondition, AsyncCallback callback, object state)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
callback AsyncCallback: An optional callback 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.

BeginRenewLease(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to renew a lease on this container.

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

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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.
callback AsyncCallback: An optional callback 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.

BeginRenewLease(AccessCondition, AsyncCallback, object)

Begins an asynchronous operation to renew a lease on this container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginRenewLease(AccessCondition accessCondition, AsyncCallback callback, object state)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
callback AsyncCallback: An optional callback 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.

BeginSetMetadata(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous operation to set user-defined metadata on the container.

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

Parameters

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.

BeginSetMetadata(AsyncCallback, object)

Begins an asynchronous operation to set user-defined metadata on the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetMetadata(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 that will be passed to the callback delegate.

Returns

ICancellableAsyncResult: An ICancellableAsyncResult that references the asynchronous operation.

BeginSetPermissions(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Begins an asynchronous request to set permissions for the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetPermissions(BlobContainerPermissions permissions, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
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.

BeginSetPermissions(BlobContainerPermissions, AsyncCallback, object)

Begins an asynchronous request to set permissions for the container.

[DoesServiceRequest]
public virtual ICancellableAsyncResult BeginSetPermissions(BlobContainerPermissions permissions, AsyncCallback callback, object state)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
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.

BreakLease(TimeSpan?, AccessCondition, BlobRequestOptions, OperationContext)

Breaks the current lease on this container.

[DoesServiceRequest]
public virtual TimeSpan BreakLease(TimeSpan? breakPeriod = null, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
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

TimeSpan: A TimeSpan representing the amount of time before the lease ends, to the second.

BreakLeaseAsync(TimeSpan?)

Initiates an asynchronous operation that breaks the current lease on this container.

[DoesServiceRequest]
public virtual Task<TimeSpan> BreakLeaseAsync(TimeSpan? breakPeriod)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.

Returns

Task<TimeSpan>: A Task<TResult> object that represents the asynchronous operation.

BreakLeaseAsync(TimeSpan?, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that breaks the current lease on this container.

[DoesServiceRequest]
public virtual Task<TimeSpan> BreakLeaseAsync(TimeSpan? breakPeriod, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
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<TimeSpan>: A Task<TResult> object that represents the asynchronous operation.

BreakLeaseAsync(TimeSpan?, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that breaks the current lease on this container.

[DoesServiceRequest]
public virtual Task<TimeSpan> BreakLeaseAsync(TimeSpan? breakPeriod, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
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<TimeSpan>: A Task<TResult> object that represents the asynchronous operation.

BreakLeaseAsync(TimeSpan?, CancellationToken)

Initiates an asynchronous operation that breaks the current lease on this container.

[DoesServiceRequest]
public virtual Task<TimeSpan> BreakLeaseAsync(TimeSpan? breakPeriod, CancellationToken cancellationToken)

Parameters

breakPeriod TimeSpan?: A TimeSpan representing the amount of time to allow the lease to remain, which will be rounded down to seconds. If null, the break period is the remainder of the current lease, or zero for infinite leases.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<TimeSpan>: A Task<TResult> object that represents the asynchronous operation.

ChangeLease(string, AccessCondition, BlobRequestOptions, OperationContext)

Changes the lease ID on this container.

[DoesServiceRequest]
public virtual string ChangeLease(string proposedLeaseId, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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

string: The new lease ID.

ChangeLeaseAsync(string, AccessCondition)

Initiates an asynchronous operation that changes the lease ID on this container.

[DoesServiceRequest]
public virtual Task<string> ChangeLeaseAsync(string proposedLeaseId, AccessCondition accessCondition)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.

Returns

Task<string>: A Task<TResult> object that represents the asynchronous operation.

ChangeLeaseAsync(string, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that changes the lease ID on this container.

[DoesServiceRequest]
public virtual Task<string> ChangeLeaseAsync(string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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<string>: A Task<TResult> object that represents the asynchronous operation.

ChangeLeaseAsync(string, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that changes the lease ID on this container.

[DoesServiceRequest]
public virtual Task<string> ChangeLeaseAsync(string proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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<string>: A Task<TResult> object that represents the asynchronous operation.

ChangeLeaseAsync(string, AccessCondition, CancellationToken)

Initiates an asynchronous operation that changes the lease ID on this container.

[DoesServiceRequest]
public virtual Task<string> ChangeLeaseAsync(string proposedLeaseId, AccessCondition accessCondition, CancellationToken cancellationToken)

Parameters

proposedLeaseId string: A string representing the proposed lease ID for the new lease. This cannot be null.
accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<string>: A Task<TResult> object that represents the asynchronous operation.

Create(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)

Creates the container and specifies the level of access to the container's data.

[DoesServiceRequest]
public virtual void Create(BlobContainerPublicAccessType accessType, BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
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.

Create(BlobRequestOptions, OperationContext)

Creates the container.

[DoesServiceRequest]
public virtual void Create(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.

CreateAsync()

Initiates an asynchronous operation that creates a container.

[DoesServiceRequest]
public virtual Task CreateAsync()

Returns

Task: A Task object that represents the asynchronous operation.

CreateAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that creates a container.

[DoesServiceRequest]
public virtual Task CreateAsync(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
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: A Task object that represents the asynchronous operation.

CreateAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that creates a container and specifies the level of access to the container's data.

[DoesServiceRequest]
public virtual Task CreateAsync(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
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: A Task object that represents the asynchronous operation.

CreateAsync(CancellationToken)

Initiates an asynchronous operation that creates a container.

[DoesServiceRequest]
public virtual Task CreateAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task: A Task object that represents the asynchronous operation.

CreateIfNotExists(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)

Creates the container if it does not already exist and specifies whether the container or its blobs are publicly accessible.

[DoesServiceRequest]
public virtual bool CreateIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.
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

bool: true if the container did not already exist and was created; otherwise false.

Remarks

This API requires Create or Write permissions.

CreateIfNotExists(BlobRequestOptions, OperationContext)

Creates the container if it does not already exist.

[DoesServiceRequest]
public virtual bool CreateIfNotExists(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

bool: true if the container did not already exist and was created; otherwise false.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync()

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync()

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and the level of access.
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<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

accessType BlobContainerPublicAccessType: An BlobContainerPublicAccessType object that specifies whether data in the container may be accessed publicly and the level of access.
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<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(BlobRequestOptions options, OperationContext operationContext)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

CreateIfNotExistsAsync(CancellationToken)

Initiates an asynchronous operation that creates the container if it does not already exist.

[DoesServiceRequest]
public virtual Task<bool> CreateIfNotExistsAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

Remarks

This API requires Create or Write permissions.

Delete(AccessCondition, BlobRequestOptions, OperationContext)

Deletes the container.

[DoesServiceRequest]
public virtual void Delete(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

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.

DeleteAsync()

Initiates an asynchronous operation that deletes the container.

[DoesServiceRequest]
public virtual Task DeleteAsync()

Returns

Task: A Task object that represents the asynchronous operation.

DeleteAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that deletes the container.

[DoesServiceRequest]
public virtual Task DeleteAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

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: A Task object that represents the asynchronous operation.

DeleteAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that deletes the container.

[DoesServiceRequest]
public virtual Task DeleteAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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: A Task object that represents the asynchronous operation.

DeleteAsync(CancellationToken)

Initiates an asynchronous operation that deletes the container.

[DoesServiceRequest]
public virtual Task DeleteAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task: A Task object that represents the asynchronous operation.

DeleteIfExists(AccessCondition, BlobRequestOptions, OperationContext)

Deletes the container if it already exists.

[DoesServiceRequest]
public virtual bool DeleteIfExists(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

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

bool: true if the container existed and was deleted successfully; otherwise false.

DeleteIfExistsAsync()

Initiates an asynchronous operation that deletes the container if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync()

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

DeleteIfExistsAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that deletes the container if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

DeleteIfExistsAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that deletes the container if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

DeleteIfExistsAsync(CancellationToken)

Initiates an asynchronous operation that deletes the container if it already exists.

[DoesServiceRequest]
public virtual Task<bool> DeleteIfExistsAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

EndAcquireLease(IAsyncResult)

Ends an asynchronous operation to acquire a lease on this container.

public virtual string EndAcquireLease(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

string: The ID of the acquired lease.

EndBreakLease(IAsyncResult)

Ends an asynchronous operation to break the current lease on this container.

public virtual TimeSpan EndBreakLease(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

TimeSpan: A TimeSpan representing the amount of time before the lease ends, to the second.

EndChangeLease(IAsyncResult)

Ends an asynchronous operation to change the lease on this container.

public virtual string EndChangeLease(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

string: The new lease ID.

EndCreate(IAsyncResult)

Ends an asynchronous operation to create a container.

public virtual void EndCreate(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndCreateIfNotExists(IAsyncResult)

Returns the result of an asynchronous request to create the container if it does not already exist.

public virtual bool EndCreateIfNotExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the container did not already exist and was created; otherwise, false.

EndDelete(IAsyncResult)

Ends an asynchronous operation to delete a container.

public virtual void EndDelete(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndDeleteIfExists(IAsyncResult)

Returns the result of an asynchronous request to delete the container if it already exists.

public virtual bool EndDeleteIfExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the container did not already exist and was created; otherwise, false.

EndExists(IAsyncResult)

Returns the asynchronous result of the request to check whether the container exists.

public virtual bool EndExists(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

bool: true if the container exists.

EndFetchAttributes(IAsyncResult)

Ends an asynchronous operation to retrieve the container's attributes.

public virtual void EndFetchAttributes(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndGetAccountProperties(IAsyncResult)

Ends an asynchronous operation to get properties for the account this container resides on.

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 in this container.

public virtual ICloudBlob EndGetBlobReferenceFromServer(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

ICloudBlob: A reference to the blob.

EndGetPermissions(IAsyncResult)

Returns the asynchronous result of the request to get the permissions settings for the container.

public virtual BlobContainerPermissions EndGetPermissions(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Returns

BlobContainerPermissions: The container's permissions.

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 result segment containing objects that implement IListBlobItem.

EndReleaseLease(IAsyncResult)

Ends an asynchronous operation to release the lease on this container.

public virtual void EndReleaseLease(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndRenewLease(IAsyncResult)

Ends an asynchronous operation to renew a lease on this container.

public virtual void EndRenewLease(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndSetMetadata(IAsyncResult)

Ends an asynchronous request operation to set user-defined metadata on the container.

public virtual void EndSetMetadata(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

EndSetPermissions(IAsyncResult)

Returns the result of an asynchronous request to set permissions for the container.

public virtual void EndSetPermissions(IAsyncResult asyncResult)

Parameters

asyncResult IAsyncResult: An IAsyncResult that references the pending asynchronous operation.

Exists(BlobRequestOptions, OperationContext)

Checks whether the container exists.

[DoesServiceRequest]
public virtual bool Exists(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

bool: true if the container exists.

ExistsAsync()

Initiates an asynchronous operation that checks whether the container exists.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync()

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

ExistsAsync(BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that checks whether the container exists.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(BlobRequestOptions options, OperationContext operationContext)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

ExistsAsync(BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that checks whether the container exists.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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<bool>: A Task<TResult> object that represents the asynchronous operation.

ExistsAsync(CancellationToken)

Initiates an asynchronous operation that checks whether the container exists.

[DoesServiceRequest]
public virtual Task<bool> ExistsAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task<bool>: A Task<TResult> object that represents the asynchronous operation.

FetchAttributes(AccessCondition, BlobRequestOptions, OperationContext)

Retrieves the container's attributes.

[DoesServiceRequest]
public virtual void FetchAttributes(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

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.

FetchAttributesAsync()

Initiates an asynchronous operation that retrieves the container's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync()

Returns

Task: A Task object that represents the asynchronous operation.

FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that retrieves the container's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

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: A Task object that represents the asynchronous operation.

FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that retrieves the container's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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: A Task object that represents the asynchronous operation.

FetchAttributesAsync(CancellationToken)

Initiates an asynchronous operation that retrieves the container's attributes.

[DoesServiceRequest]
public virtual Task FetchAttributesAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task: A Task object that represents the asynchronous operation.

GetAccountProperties(BlobRequestOptions, OperationContext)

Gets properties for the account this container resides on.

[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 properties for the account this container resides on.

[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 properties for the account this container resides on.

[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 properties for the account this container resides on.

[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 properties for the account this container resides on.

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

GetAppendBlobReference(string)

Gets a reference to an append blob in this container.

public virtual CloudAppendBlob GetAppendBlobReference(string blobName)

Parameters

blobName string: A string containing the name of the append blob.

Returns

CloudAppendBlob: A CloudAppendBlob object.

GetAppendBlobReference(string, DateTimeOffset?)

Gets a reference to an append blob in this container.

public virtual CloudAppendBlob GetAppendBlobReference(string blobName, DateTimeOffset? snapshotTime)

Parameters

blobName string: A string containing the name of the append blob.
snapshotTime DateTimeOffset?: A DateTimeOffset specifying the snapshot timestamp, if the blob is a snapshot.

Returns

CloudAppendBlob: A CloudAppendBlob object.

GetBlobReference(string)

Gets a reference to a blob in this container.

public virtual CloudBlob GetBlobReference(string blobName)

Parameters

blobName string: A string containing the name of the blob.

Returns

CloudBlob: A CloudBlob object.

GetBlobReference(string, DateTimeOffset?)

Gets a reference to a blob in this container.

public virtual CloudBlob GetBlobReference(string blobName, DateTimeOffset? snapshotTime)

Parameters

blobName string: A string containing the name of the blob.
snapshotTime DateTimeOffset?: A DateTimeOffset specifying the snapshot timestamp, if the blob is a snapshot.

Returns

CloudBlob: A CloudBlob object.

GetBlobReferenceFromServer(string, AccessCondition, BlobRequestOptions, OperationContext)

Gets a reference to a blob in this container.

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

Parameters

blobName string: A string containing the name 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 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: A reference to the blob.

GetBlobReferenceFromServerAsync(string)

Initiates an asynchronous operation that gets a reference to a blob in this container.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(string blobName)

Parameters

blobName string: A string containing the name of the blob.

Returns

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

GetBlobReferenceFromServerAsync(string, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that gets a reference to a blob in this container.

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

Parameters

blobName string: A string containing the name 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 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 that represents the asynchronous operation.

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

Initiates an asynchronous operation that gets a reference to a blob in this container.

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

Parameters

blobName string: A string containing the name 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 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 that represents the asynchronous operation.

GetBlobReferenceFromServerAsync(string, CancellationToken)

Initiates an asynchronous operation that gets a reference to a blob in this container.

[DoesServiceRequest]
public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(string blobName, CancellationToken cancellationToken)

Parameters

blobName string: A string containing the name of the blob.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

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

GetBlockBlobReference(string)

Gets a reference to a block blob in this container.

public virtual CloudBlockBlob GetBlockBlobReference(string blobName)

Parameters

blobName string: A string containing the name of the block blob.

Returns

CloudBlockBlob: A CloudBlockBlob object.

Remarks

Examples

Warning

It looks like the sample you are looking for does not exist.

GetBlockBlobReference(string, DateTimeOffset?)

Gets a reference to a block blob in this container.

public virtual CloudBlockBlob GetBlockBlobReference(string blobName, DateTimeOffset? snapshotTime)

Parameters

blobName string: A string containing the name of the block blob.
snapshotTime DateTimeOffset?: A DateTimeOffset specifying the snapshot timestamp, if the blob is a snapshot.

Returns

CloudBlockBlob: A CloudBlockBlob object.

GetDirectoryReference(string)

Gets a reference to a virtual blob directory beneath this container.

public virtual CloudBlobDirectory GetDirectoryReference(string relativeAddress)

Parameters

relativeAddress string: A string containing the name of the virtual blob directory.

Returns

CloudBlobDirectory: A CloudBlobDirectory object.

GetPageBlobReference(string)

Gets a reference to a page blob in this container.

public virtual CloudPageBlob GetPageBlobReference(string blobName)

Parameters

blobName string: A string containing the name of the page blob.

Returns

CloudPageBlob: A CloudPageBlob object.

GetPageBlobReference(string, DateTimeOffset?)

Returns a reference to a page blob in this virtual directory.

public virtual CloudPageBlob GetPageBlobReference(string blobName, DateTimeOffset? snapshotTime)

Parameters

blobName string: A string containing the name of the page blob.
snapshotTime DateTimeOffset?: A DateTimeOffset specifying the snapshot timestamp, if the blob is a snapshot.

Returns

CloudPageBlob: A CloudPageBlob object.

GetPermissions(AccessCondition, BlobRequestOptions, OperationContext)

Gets the permissions settings for the container.

[DoesServiceRequest]
public virtual BlobContainerPermissions GetPermissions(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

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

BlobContainerPermissions: The container's permissions.

GetPermissionsAsync()

Initiates an asynchronous operation that gets the permissions settings for the container.

[DoesServiceRequest]
public virtual Task<BlobContainerPermissions> GetPermissionsAsync()

Returns

Task<BlobContainerPermissions>: A Task<TResult> object that represents the asynchronous operation.

GetPermissionsAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that gets the permissions settings for the container.

[DoesServiceRequest]
public virtual Task<BlobContainerPermissions> GetPermissionsAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

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<BlobContainerPermissions>: A Task<TResult> object that represents the asynchronous operation.

GetPermissionsAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that gets the permissions settings for the container.

[DoesServiceRequest]
public virtual Task<BlobContainerPermissions> GetPermissionsAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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<BlobContainerPermissions>: A Task<TResult> object that represents the asynchronous operation.

GetPermissionsAsync(CancellationToken)

Initiates an asynchronous operation that gets the permissions settings for the container.

[DoesServiceRequest]
public virtual Task<BlobContainerPermissions> GetPermissionsAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task<BlobContainerPermissions>: A Task<TResult> object that represents the asynchronous operation.

GetSharedAccessSignature(SharedAccessBlobPolicy)

Returns a shared access signature for the container.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy)

Parameters

policy SharedAccessBlobPolicy: A SharedAccessBlobPolicy object specifying the access policy for the shared access signature.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessBlobPolicy, string)

Returns a shared access signature for the container.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, string groupPolicyIdentifier)

Parameters

policy SharedAccessBlobPolicy: A SharedAccessBlobPolicy object specifying the access policy for the shared access signature.
groupPolicyIdentifier string: A container-level access policy.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

GetSharedAccessSignature(SharedAccessBlobPolicy, string, SharedAccessProtocol?, IPAddressOrRange)

Returns a shared access signature for the container.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, string groupPolicyIdentifier, SharedAccessProtocol? protocols, IPAddressOrRange ipAddressOrRange)

Parameters

policy SharedAccessBlobPolicy: A SharedAccessBlobPolicy object specifying the access policy for the shared access signature.
groupPolicyIdentifier string: A container-level access policy.
protocols SharedAccessProtocol?: The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol.
ipAddressOrRange IPAddressOrRange: The allowed IP address or IP address range. Null if you don't want to restrict based on IP address.

Returns

string: A shared access signature, as a URI query string.

Remarks

The query string returned includes the leading question mark.

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

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

[DoesServiceRequest]
public virtual IEnumerable<IListBlobItem> ListBlobs(string prefix = null, 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(BlobContinuationToken)

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

[DoesServiceRequest]
public virtual BlobResultSegment ListBlobsSegmented(BlobContinuationToken currentToken)

Parameters

currentToken BlobContinuationToken: A continuation token returned by a previous listing operation.

Returns

BlobResultSegment: A result segment containing objects that implement IListBlobItem.

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.
currentToken BlobContinuationToken: A continuation token returned by a previous listing operation.

Returns

BlobResultSegment: A result segment containing objects that implement IListBlobItem.

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.
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 continuation token 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 result segment containing objects that implement IListBlobItem.

ListBlobsSegmentedAsync(BlobContinuationToken)

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

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

Parameters

currentToken BlobContinuationToken: A continuation token returned by a previous listing operation.

Returns

Task<BlobResultSegment>

ListBlobsSegmentedAsync(BlobContinuationToken, CancellationToken)

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

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

Parameters

currentToken BlobContinuationToken: A continuation token returned by a previous listing operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<BlobResultSegment>

ListBlobsSegmentedAsync(string, BlobContinuationToken)

Initiates an asynchronous operation that returns 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.
currentToken BlobContinuationToken: A continuation token returned by a previous listing operation.

Returns

Task<BlobResultSegment>

ListBlobsSegmentedAsync(string, BlobContinuationToken, CancellationToken)

Initiates an asynchronous operation that returns 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 continuation token returned by a previous listing operation.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task<BlobResultSegment>

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

Initiates an asynchronous operation that returns 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 continuation token 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 that represents the asynchronous operation.

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

Initiates an asynchronous operation that returns 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 continuation token 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 that represents the asynchronous operation.

ReleaseLease(AccessCondition, BlobRequestOptions, OperationContext)

Releases the lease on this container.

[DoesServiceRequest]
public virtual void ReleaseLease(AccessCondition accessCondition, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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.

ReleaseLeaseAsync(AccessCondition)

Initiates an asynchronous operation that releases the lease on this container.

[DoesServiceRequest]
public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.

Returns

Task: A Task object that represents the asynchronous operation.

ReleaseLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that releases the lease on this container.

[DoesServiceRequest]
public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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: A Task object that represents the asynchronous operation.

ReleaseLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that releases the lease on this container.

[DoesServiceRequest]
public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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: A Task object that represents the asynchronous operation.

ReleaseLeaseAsync(AccessCondition, CancellationToken)

Initiates an asynchronous operation that releases the lease on this container.

[DoesServiceRequest]
public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition, CancellationToken cancellationToken)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

RenewLease(AccessCondition, BlobRequestOptions, OperationContext)

Renews a lease on this container.

[DoesServiceRequest]
public virtual void RenewLease(AccessCondition accessCondition, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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.

RenewLeaseAsync(AccessCondition)

Initiates an asynchronous operation that renews a lease on this container.

[DoesServiceRequest]
public virtual Task RenewLeaseAsync(AccessCondition accessCondition)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.

Returns

Task: A Task object that represents the asynchronous operation.

RenewLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that renews a lease on this container.

[DoesServiceRequest]
public virtual Task RenewLeaseAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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: A Task object that represents the asynchronous operation.

RenewLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that renews a lease on this container.

[DoesServiceRequest]
public virtual Task RenewLeaseAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
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: A Task object that represents the asynchronous operation.

RenewLeaseAsync(AccessCondition, CancellationToken)

Initiates an asynchronous operation that renews a lease on this container.

[DoesServiceRequest]
public virtual Task RenewLeaseAsync(AccessCondition accessCondition, CancellationToken cancellationToken)

Parameters

accessCondition AccessCondition: An AccessCondition object that represents the condition that must be met in order for the request to proceed, including a required lease ID.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

SetMetadata(AccessCondition, BlobRequestOptions, OperationContext)

Sets the container's user-defined metadata.

[DoesServiceRequest]
public virtual void SetMetadata(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

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.

SetMetadataAsync()

Initiates an asynchronous operation that sets container's user-defined metadata.

[DoesServiceRequest]
public virtual Task SetMetadataAsync()

Returns

Task: A Task object that represents the asynchronous operation.

SetMetadataAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that sets container's user-defined metadata.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

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: A Task object that represents the asynchronous operation.

SetMetadataAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that sets container's user-defined metadata.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

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: A Task object that represents the asynchronous operation.

SetMetadataAsync(CancellationToken)

Initiates an asynchronous operation that sets container's user-defined metadata.

[DoesServiceRequest]
public virtual Task SetMetadataAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissions(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext)

Sets permissions for the container.

[DoesServiceRequest]
public virtual void SetPermissions(BlobContainerPermissions permissions, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
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.

SetPermissionsAsync(BlobContainerPermissions)

Initiates an asynchronous operation that sets permissions for the container.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(BlobContainerPermissions permissions)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.

Returns

Task: A Task object that represents the asynchronous operation.

SetPermissionsAsync(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that sets permissions for the container.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(BlobContainerPermissions permissions, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
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: A Task object that represents the asynchronous operation.

SetPermissionsAsync(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that sets permissions for the container.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(BlobContainerPermissions permissions, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
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: A Task object that represents the asynchronous operation.

SetPermissionsAsync(BlobContainerPermissions, CancellationToken)

Initiates an asynchronous operation that sets permissions for the container.

[DoesServiceRequest]
public virtual Task SetPermissionsAsync(BlobContainerPermissions permissions, CancellationToken cancellationToken)

Parameters

permissions BlobContainerPermissions: The permissions to apply to the container.
cancellationToken CancellationToken: A CancellationToken to observe while waiting for a task to complete.

Returns

Task: A Task object that represents the asynchronous operation.

Table of Contents

Class CloudBlobContainer

Constructors

CloudBlobContainer(StorageUri, StorageCredentials)

Parameters

CloudBlobContainer(Uri)

Parameters

CloudBlobContainer(Uri, StorageCredentials)

Parameters

Properties

Metadata

Property Value

Name

Property Value

Properties

Property Value

ServiceClient

Property Value

StorageUri

Property Value

Uri

Property Value

Methods

AcquireLease(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext)

Parameters

Returns

AcquireLeaseAsync(TimeSpan?, string)

Parameters

Returns

AcquireLeaseAsync(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext)

Parameters

Returns

AcquireLeaseAsync(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Parameters

Returns

AcquireLeaseAsync(TimeSpan?, string, CancellationToken)

Parameters

Returns

BeginAcquireLease(TimeSpan?, string, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginAcquireLease(TimeSpan?, string, AsyncCallback, object)

Parameters

Returns

BeginBreakLease(TimeSpan?, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginBreakLease(TimeSpan?, AsyncCallback, object)

Parameters

Returns

BeginChangeLease(string, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginChangeLease(string, AccessCondition, AsyncCallback, object)

Parameters

Returns

BeginCreate(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginCreate(BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

BeginCreate(AsyncCallback, object)

Parameters

Returns

BeginCreateIfNotExists(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

Remarks

BeginCreateIfNotExists(BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns

Remarks

BeginCreateIfNotExists(AsyncCallback, object)

Parameters

Returns

Remarks

BeginDelete(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, object)

Parameters

Returns