<PackageReference Include="Microsoft.Azure.Storage.Blob" Version="11.1.2" />

Microsoft.Azure.Storage.Blob.CloudBlobContainer

public class CloudBlobContainer
Represents a container in the Microsoft Azure Blob service.
public IDictionary<string, string> Metadata { get; }

Gets the container's metadata.

public string Name { get; }

Gets the name of the container.

Gets the container's system properties.

Gets the Blob service client for the container.

public StorageUri StorageUri { get; }

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

public Uri Uri { get; }

Gets the container's URI for the primary location.

public CloudBlobContainer(Uri containerAddress)

Initializes a new instance of the CloudBlobContainer class.

public CloudBlobContainer(Uri containerAddress, StorageCredentials credentials)

Initializes a new instance of the CloudBlobContainer class.

public CloudBlobContainer(StorageUri containerAddress, StorageCredentials credentials)

Initializes a new instance of the CloudBlobContainer class.

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

Acquires a lease on this container.

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

Acquires a lease on this container.

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

Acquires a lease on this container.

public virtual Task<TimeSpan> BreakLeaseAsync(TimeSpan? breakPeriod)

Breaks the current lease on this container.

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

Breaks the current lease on this container.

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

Breaks the current lease on this container.

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

Changes the lease ID on this container.

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

Changes the lease ID on this container.

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

Changes the lease ID on this container.

public virtual Task CreateAsync()

Creates the container.

public virtual Task CreateAsync(BlobRequestOptions options, OperationContext operationContext)

Creates the container.

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

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

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

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

public virtual Task<bool> CreateIfNotExistsAsync()

Creates the container if it does not already exist.

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

Creates the container if it does not already exist.

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

Creates the container if it does not already exist and specifies the level of access to the container's data.

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

Creates the container if it does not already exist and specifies the level of access to the container's data.

public virtual Task DeleteAsync()

Deletes the container.

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

Deletes the container.

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

Deletes the container.

public virtual Task<bool> DeleteIfExistsAsync()

Deletes the container if it already exists.

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

Deletes the container if it already exists.

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

Deletes the container if it already exists.

public virtual Task<bool> ExistsAsync()

Checks existence of the container.

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

Checks existence of the container.

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

Checks existence of the container.

public virtual Task FetchAttributesAsync()

Retrieves the container's attributes.

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

Retrieves the container's attributes.

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

Retrieves the container's attributes.

public virtual Task<AccountProperties> GetAccountPropertiesAsync()

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

public virtual Task<AccountProperties> GetAccountPropertiesAsync(CancellationToken cancellationToken)

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

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

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

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

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

public virtual CloudAppendBlob GetAppendBlobReference(string blobName)

Gets a reference to an append blob in this container.

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

Gets a reference to an append blob in this container.

public virtual CloudBlob GetBlobReference(string blobName)

Gets a reference to a blob in this container.

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

Gets a reference to a blob in this container.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(string blobName)

Gets a reference to a blob in this container.

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

Gets a reference to a blob in this container.

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

Gets a reference to a blob in this container.

public virtual CloudBlockBlob GetBlockBlobReference(string blobName)

Gets a reference to a block blob in this container.

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

Gets a reference to a block blob in this container.

public virtual CloudBlobDirectory GetDirectoryReference(string relativeAddress)

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

public virtual CloudPageBlob GetPageBlobReference(string blobName)

Gets a reference to a page blob in this container.

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

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

Gets the permissions settings for the container.

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

Gets the permissions settings for the container.

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

Gets the permissions settings for the container.

Returns a shared access signature for the container.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, string groupPolicyIdentifier)

Returns a shared access signature for the container.

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

Returns a shared access signature for the container.

public string GetUserDelegationSharedAccessSignature(UserDelegationKey delegationKey, SharedAccessBlobPolicy policy, SharedAccessBlobHeaders headers = null, SharedAccessProtocol? protocols = default, IPAddressOrRange ipAddressOrRange = null)

Returns an user-delegation-based shared access signature for the container, with credentials solely based on the UserDelegationKey provided.

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

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

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

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

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

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

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

public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition)

Releases the lease on this container.

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

Releases the lease on this container.

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

Releases the lease on this container.

public virtual Task RenewLeaseAsync(AccessCondition accessCondition)

Renews a lease on this container.

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

Renews a lease on this container.

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

Renews a lease on this container.

public virtual Task SetMetadataAsync()

Sets the container's user-defined metadata.

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

Sets the container's user-defined metadata.

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

Sets the container's user-defined metadata.

Sets permissions for the container.

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

Sets permissions for the container.

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

Sets permissions for the container.