CloudBlobContainer Class

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Blob

Assembly:: Microsoft.Azure.Storage.Blob.dll

Package:: Microsoft.Azure.Storage.Blob v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a container in the Microsoft Azure Blob service.

public class CloudBlobContainer

type CloudBlobContainer = class

Public Class CloudBlobContainer

Inheritance: Object
CloudBlobContainer

Constructors

CloudBlobContainer(StorageUri, StorageCredentials)	Initializes a new instance of the CloudBlobContainer class.
CloudBlobContainer(Uri, StorageCredentials)	Initializes a new instance of the CloudBlobContainer class.
CloudBlobContainer(Uri)	Initializes a new instance of the CloudBlobContainer class.

Properties

Metadata	Gets the container's metadata.
Name	Gets the name of the container.
Properties	Gets the container's system properties.
ServiceClient	Gets the Blob service client for the container.
StorageUri	Gets the container's URIs for both the primary and secondary locations.
Uri	Gets the container's URI for the primary location.

Methods

AcquireLease(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext)	Acquires a lease on this container.
AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that acquires a lease on this container.
AcquireLeaseAsync(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that acquires a lease on this container.
AcquireLeaseAsync(Nullable<TimeSpan>, String, CancellationToken)	Initiates an asynchronous operation that acquires a lease on this container.
AcquireLeaseAsync(Nullable<TimeSpan>, String)	Initiates an asynchronous operation that acquires a lease on this container.
BeginAcquireLease(Nullable<TimeSpan>, String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to acquire a lease on this container.
BeginAcquireLease(Nullable<TimeSpan>, String, AsyncCallback, Object)	Begins an asynchronous operation to acquire a lease on this container.
BeginBreakLease(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to break the current lease on this container.
BeginBreakLease(Nullable<TimeSpan>, AsyncCallback, Object)	Begins an asynchronous operation to break the current lease on this container.
BeginChangeLease(String, AccessCondition, AsyncCallback, Object)	Begins an asynchronous operation to change the lease on this container.
BeginChangeLease(String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to change the lease on this container.
BeginCreate(AsyncCallback, Object)	Begins an asynchronous operation to create a container.
BeginCreate(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a container and specify the level of access to the container's data.
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.
BeginCreate(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a container.
BeginCreateIfNotExists(AsyncCallback, Object)	Begins an asynchronous request to create the container if it does not already exist.
BeginCreateIfNotExists(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the container if it does not already exist.
BeginCreateIfNotExists(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the container if it does not already exist.
BeginCreateIfNotExists(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the container if it does not already exist.
BeginDelete(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a container.
BeginDelete(AsyncCallback, Object)	Begins an asynchronous operation to delete a container.
BeginDeleteIfExists(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to delete the container if it already exists.
BeginDeleteIfExists(AsyncCallback, Object)	Begins an asynchronous request to delete the container if it already exists.
BeginExists(AsyncCallback, Object)	Begins an asynchronous request to check whether the container exists.
BeginExists(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to check whether the container exists.
BeginFetchAttributes(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to retrieve the container's attributes.
BeginFetchAttributes(AsyncCallback, Object)	Begins an asynchronous operation to retrieve the container's attributes.
BeginGetAccountProperties(AsyncCallback, Object)	Begins an asynchronous operation to get properties for the account this container resides on.
BeginGetAccountProperties(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get properties for the account this container resides on.
BeginGetBlobReferenceFromServer(String, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get a reference to a blob in this container.
BeginGetBlobReferenceFromServer(String, AsyncCallback, Object)	Begins an asynchronous operation to get a reference to a blob in this container.
BeginGetPermissions(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the container.
BeginGetPermissions(AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the container.
BeginListBlobsSegmented(BlobContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
BeginListBlobsSegmented(String, BlobContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
BeginListBlobsSegmented(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
BeginReleaseLease(AccessCondition, AsyncCallback, Object)	Begins an asynchronous operation to release the lease on this container.
BeginReleaseLease(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to release the lease on this container.
BeginRenewLease(AccessCondition, AsyncCallback, Object)	Begins an asynchronous operation to renew a lease on this container.
BeginRenewLease(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to renew a lease on this container.
BeginSetMetadata(AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the container.
BeginSetMetadata(AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the container.
BeginSetPermissions(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the container.
BeginSetPermissions(BlobContainerPermissions, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the container.
BreakLease(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext)	Breaks the current lease on this container.
BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that breaks the current lease on this container.
BreakLeaseAsync(Nullable<TimeSpan>, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that breaks the current lease on this container.
BreakLeaseAsync(Nullable<TimeSpan>, CancellationToken)	Initiates an asynchronous operation that breaks the current lease on this container.
BreakLeaseAsync(Nullable<TimeSpan>)	Initiates an asynchronous operation that breaks the current lease on this container.
ChangeLease(String, AccessCondition, BlobRequestOptions, OperationContext)	Changes the lease ID on this container.
ChangeLeaseAsync(String, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that changes the lease ID on this container.
ChangeLeaseAsync(String, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that changes the lease ID on this container.
ChangeLeaseAsync(String, AccessCondition, CancellationToken)	Initiates an asynchronous operation that changes the lease ID on this container.
ChangeLeaseAsync(String, AccessCondition)	Initiates an asynchronous operation that changes the lease ID on this container.
Create(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext)	Creates the container and specifies the level of access to the container's data.
Create(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)	Creates the container and specifies the level of access to the container's data.
Create(BlobRequestOptions, OperationContext)	Creates the container.
CreateAsync()	Initiates an asynchronous operation that creates a container.
CreateAsync(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that creates a container and specifies the level of access to the container's data.
CreateAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that creates a container and specifies the level of access to the container's data.
CreateAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that creates a container.
CreateAsync(CancellationToken)	Initiates an asynchronous operation that creates a container.
CreateIfNotExists(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext)	Creates the container if it does not already exist and specifies whether the container or its blobs are publicly accessible.
CreateIfNotExists(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)	Creates the container if it does not already exist and specifies whether the container or its blobs are publicly accessible.
CreateIfNotExists(BlobRequestOptions, OperationContext)	Creates the container if it does not already exist.
CreateIfNotExistsAsync()	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(BlobContainerPublicAccessType, BlobContainerEncryptionScopeOptions, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(BlobContainerPublicAccessType, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that creates the container if it does not already exist.
CreateIfNotExistsAsync(CancellationToken)	Initiates an asynchronous operation that creates the container if it does not already exist.
Delete(AccessCondition, BlobRequestOptions, OperationContext)	Deletes the container.
DeleteAsync()	Initiates an asynchronous operation that deletes the container.
DeleteAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that deletes the container.
DeleteAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that deletes the container.
DeleteAsync(CancellationToken)	Initiates an asynchronous operation that deletes the container.
DeleteIfExists(AccessCondition, BlobRequestOptions, OperationContext)	Deletes the container if it already exists.
DeleteIfExistsAsync()	Initiates an asynchronous operation that deletes the container if it already exists.
DeleteIfExistsAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that deletes the container if it already exists.
DeleteIfExistsAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that deletes the container if it already exists.
DeleteIfExistsAsync(CancellationToken)	Initiates an asynchronous operation that deletes the container if it already exists.
EndAcquireLease(IAsyncResult)	Ends an asynchronous operation to acquire a lease on this container.
EndBreakLease(IAsyncResult)	Ends an asynchronous operation to break the current lease on this container.
EndChangeLease(IAsyncResult)	Ends an asynchronous operation to change the lease on this container.
EndCreate(IAsyncResult)	Ends an asynchronous operation to create a container.
EndCreateIfNotExists(IAsyncResult)	Returns the result of an asynchronous request to create the container if it does not already exist.
EndDelete(IAsyncResult)	Ends an asynchronous operation to delete a container.
EndDeleteIfExists(IAsyncResult)	Returns the result of an asynchronous request to delete the container if it already exists.
EndExists(IAsyncResult)	Returns the asynchronous result of the request to check whether the container exists.
EndFetchAttributes(IAsyncResult)	Ends an asynchronous operation to retrieve the container's attributes.
EndGetAccountProperties(IAsyncResult)	Ends an asynchronous operation to get properties for the account this container resides on.
EndGetBlobReferenceFromServer(IAsyncResult)	Ends an asynchronous operation to get a reference to a blob in this container.
EndGetPermissions(IAsyncResult)	Returns the asynchronous result of the request to get the permissions settings for the container.
EndListBlobsSegmented(IAsyncResult)	Ends an asynchronous operation to return a result segment containing a collection of blob items in the container.
EndReleaseLease(IAsyncResult)	Ends an asynchronous operation to release the lease on this container.
EndRenewLease(IAsyncResult)	Ends an asynchronous operation to renew a lease on this container.
EndSetMetadata(IAsyncResult)	Ends an asynchronous request operation to set user-defined metadata on the container.
EndSetPermissions(IAsyncResult)	Returns the result of an asynchronous request to set permissions for the container.
Exists(BlobRequestOptions, OperationContext)	Checks whether the container exists.
ExistsAsync()	Initiates an asynchronous operation that checks whether the container exists.
ExistsAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that checks whether the container exists.
ExistsAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that checks whether the container exists.
ExistsAsync(Boolean, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that checks whether the container exists.
ExistsAsync(CancellationToken)	Initiates an asynchronous operation that checks whether the container exists.
FetchAttributes(AccessCondition, BlobRequestOptions, OperationContext)	Retrieves the container's attributes.
FetchAttributesAsync()	Initiates an asynchronous operation that retrieves the container's attributes.
FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that retrieves the container's attributes.
FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that retrieves the container's attributes.
FetchAttributesAsync(CancellationToken)	Initiates an asynchronous operation that retrieves the container's attributes.
GetAccountProperties(BlobRequestOptions, OperationContext)	Gets properties for the account this container resides on.
GetAccountPropertiesAsync()	Initiates an asynchronous operation to get properties for the account this container resides on.
GetAccountPropertiesAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get properties for the account this container resides on.
GetAccountPropertiesAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to get properties for the account this container resides on.
GetAccountPropertiesAsync(CancellationToken)	Initiates an asynchronous operation to get properties for the account this container resides on.
GetAppendBlobReference(String, Nullable<DateTimeOffset>)	Gets a reference to an append blob in this container.
GetAppendBlobReference(String)	Gets a reference to an append blob in this container.
GetBlobReference(String, Nullable<DateTimeOffset>)	Gets a reference to a blob in this container.
GetBlobReference(String)	Gets a reference to a blob in this container.
GetBlobReferenceFromServer(String, AccessCondition, BlobRequestOptions, OperationContext)	Gets a reference to a blob in this container.
GetBlobReferenceFromServerAsync(String, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets a reference to a blob in this container.
GetBlobReferenceFromServerAsync(String, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that gets a reference to a blob in this container.
GetBlobReferenceFromServerAsync(String, CancellationToken)	Initiates an asynchronous operation that gets a reference to a blob in this container.
GetBlobReferenceFromServerAsync(String)	Initiates an asynchronous operation that gets a reference to a blob in this container.
GetBlockBlobReference(String, Nullable<DateTimeOffset>)	Gets a reference to a block blob in this container.
GetBlockBlobReference(String)	Gets a reference to a block blob in this container.
GetDirectoryReference(String)	Gets a reference to a virtual blob directory beneath this container.
GetPageBlobReference(String, Nullable<DateTimeOffset>)	Returns a reference to a page blob in this virtual directory.
GetPageBlobReference(String)	Gets a reference to a page blob in this container.
GetPermissions(AccessCondition, BlobRequestOptions, OperationContext)	Gets the permissions settings for the container.
GetPermissionsAsync()	Initiates an asynchronous operation that gets the permissions settings for the container.
GetPermissionsAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets the permissions settings for the container.
GetPermissionsAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that gets the permissions settings for the container.
GetPermissionsAsync(CancellationToken)	Initiates an asynchronous operation that gets the permissions settings for the container.
GetSharedAccessSignature(SharedAccessBlobPolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)	Returns a shared access signature for the container.
GetSharedAccessSignature(SharedAccessBlobPolicy, String)	Returns a shared access signature for the container.
GetSharedAccessSignature(SharedAccessBlobPolicy)	Returns a shared access signature for the container.
GetUserDelegationSharedAccessSignature(UserDelegationKey, SharedAccessBlobPolicy, SharedAccessBlobHeaders, Nullable<SharedAccessProtocol>, IPAddressOrRange)	Returns an user-delegation-based shared access signature for the container, with credentials solely based on the UserDelegationKey provided.
ListBlobs(String, Boolean, BlobListingDetails, BlobRequestOptions, OperationContext)	Returns an enumerable collection of the blobs in the container that are retrieved lazily.
ListBlobsSegmented(BlobContinuationToken)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmented(String, BlobContinuationToken)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmented(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(BlobContinuationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ReleaseLease(AccessCondition, BlobRequestOptions, OperationContext)	Releases the lease on this container.
ReleaseLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that releases the lease on this container.
ReleaseLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that releases the lease on this container.
ReleaseLeaseAsync(AccessCondition, CancellationToken)	Initiates an asynchronous operation that releases the lease on this container.
ReleaseLeaseAsync(AccessCondition)	Initiates an asynchronous operation that releases the lease on this container.
RenewLease(AccessCondition, BlobRequestOptions, OperationContext)	Renews a lease on this container.
RenewLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that renews a lease on this container.
RenewLeaseAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that renews a lease on this container.
RenewLeaseAsync(AccessCondition, CancellationToken)	Initiates an asynchronous operation that renews a lease on this container.
RenewLeaseAsync(AccessCondition)	Initiates an asynchronous operation that renews a lease on this container.
SetMetadata(AccessCondition, BlobRequestOptions, OperationContext)	Sets the container's user-defined metadata.
SetMetadataAsync()	Initiates an asynchronous operation that sets container's user-defined metadata.
SetMetadataAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that sets container's user-defined metadata.
SetMetadataAsync(AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that sets container's user-defined metadata.
SetMetadataAsync(CancellationToken)	Initiates an asynchronous operation that sets container's user-defined metadata.
SetPermissions(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext)	Sets permissions for the container.
SetPermissionsAsync(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that sets permissions for the container.
SetPermissionsAsync(BlobContainerPermissions, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that sets permissions for the container.
SetPermissionsAsync(BlobContainerPermissions, CancellationToken)	Initiates an asynchronous operation that sets permissions for the container.
SetPermissionsAsync(BlobContainerPermissions)	Initiates an asynchronous operation that sets permissions for the container.

Applies to

Share via