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

Microsoft.Azure.Storage.Blob.CloudBlob

public class CloudBlob : IListBlobItem
Represents an Azure blob. A blob stores text or binary data, such as documents or media files.
public BlobType BlobType { get; }

Gets the type of the blob.

public CloudBlobContainer Container { get; }

Gets a CloudBlobContainer object representing the blob's container.

public virtual CopyState CopyState { get; }

Gets the state of the most recent or pending copy operation.

public bool IsDeleted { get; }

Gets a value indicating whether or not this blob has been deleted.

public bool IsSnapshot { get; }

Gets a value indicating whether this blob is a snapshot.

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

Gets the user-defined metadata for the blob.

public virtual string Name { get; }

Gets the name of the blob.

public CloudBlobDirectory Parent { get; }

Gets the CloudBlobDirectory object representing the virtual parent directory for the blob.

public BlobProperties Properties { get; }

Gets the blob's system properties.

Gets the CloudBlobClient object that represents the Blob service.

public StorageUri SnapshotQualifiedStorageUri { get; }

Gets the blob's URI for both the primary and secondary locations, including query string information if the blob is a snapshot.

public Uri SnapshotQualifiedUri { get; }

Gets the absolute URI to the blob, including query string information if the blob is a snapshot.

public DateTimeOffset? SnapshotTime { get; }

Gets the date and time that the blob snapshot was taken, if this blob is a snapshot.

public StorageUri StorageUri { get; }

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

public int StreamMinimumReadSizeInBytes { get; set; }

Gets or sets the minimum number of bytes to buffer when reading from a blob stream.

public Uri Uri { get; }

Gets the blob's URI for the primary location.

public CloudBlob(Uri blobAbsoluteUri)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(Uri blobAbsoluteUri, StorageCredentials credentials)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(Uri blobAbsoluteUri, CloudBlobClient client)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(Uri blobAbsoluteUri, DateTimeOffset? snapshotTime, StorageCredentials credentials)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(Uri blobAbsoluteUri, DateTimeOffset? snapshotTime, CloudBlobClient client)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(StorageUri blobAbsoluteUri, DateTimeOffset? snapshotTime, StorageCredentials credentials)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public CloudBlob(StorageUri blobAbsoluteUri, DateTimeOffset? snapshotTime, CloudBlobClient client)

Initializes a new instance of the CloudBlob class using an absolute URI to the blob.

public virtual void AbortCopy(string copyId, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Aborts an ongoing blob copy operation.

public virtual Task AbortCopyAsync(string copyId)

Initiates an asynchronous operation to abort an ongoing blob copy operation.

public virtual Task AbortCopyAsync(string copyId, CancellationToken cancellationToken)

Initiates an asynchronous operation to abort an ongoing blob copy operation.

public virtual Task AbortCopyAsync(string copyId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to abort an ongoing blob copy operation.

public virtual Task AbortCopyAsync(string copyId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to abort an ongoing blob copy operation.

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

Acquires a lease on this blob.

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

Initiates an asynchronous operation to acquire a lease on this blob.

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

Initiates an asynchronous operation to acquire a lease on this blob.

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

Initiates an asynchronous operation to acquire a lease on this blob.

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

Initiates an asynchronous operation to acquire a lease on this blob.

public virtual ICancellableAsyncResult BeginAbortCopy(string copyId, AsyncCallback callback, object state)

Begins an asynchronous operation to abort an ongoing blob copy operation.

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

Begins an asynchronous operation to abort an ongoing blob copy operation.

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

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

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

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

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

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

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

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

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

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

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

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

public virtual ICancellableAsyncResult BeginDelete(AsyncCallback callback, object state)

Begins an asynchronous operation to delete the blob.

public virtual ICancellableAsyncResult BeginDelete(DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to delete the blob.

public virtual ICancellableAsyncResult BeginDeleteIfExists(AsyncCallback callback, object state)

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

public virtual ICancellableAsyncResult BeginDeleteIfExists(DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

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

public virtual ICancellableAsyncResult BeginDownloadRangeToByteArray(byte[] target, int index, long? blobOffset, long? length, AsyncCallback callback, object state)

Begins an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual ICancellableAsyncResult BeginDownloadRangeToByteArray(byte[] target, int index, long? blobOffset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual ICancellableAsyncResult BeginDownloadRangeToStream(Stream target, long? offset, long? length, AsyncCallback callback, object state)

Begins an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual ICancellableAsyncResult BeginDownloadRangeToStream(Stream target, long? offset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual ICancellableAsyncResult BeginDownloadToByteArray(byte[] target, int index, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a byte array.

public virtual ICancellableAsyncResult BeginDownloadToByteArray(byte[] target, int index, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a byte array.

public virtual ICancellableAsyncResult BeginDownloadToFile(string path, FileMode mode, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a file.

public virtual ICancellableAsyncResult BeginDownloadToFile(string path, FileMode mode, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a file.

public virtual ICancellableAsyncResult BeginDownloadToStream(Stream target, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a stream.

public virtual ICancellableAsyncResult BeginDownloadToStream(Stream target, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to download the contents of a blob to a stream.

public virtual ICancellableAsyncResult BeginExists(AsyncCallback callback, object state)

Begins an asynchronous request to check existence of the blob.

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

Begins an asynchronous request to check existence of the blob.

public virtual ICancellableAsyncResult BeginFetchAttributes(AsyncCallback callback, object state)

Begins an asynchronous operation to populate the blob's properties and metadata.

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

Begins an asynchronous operation to populate the blob's properties and metadata.

public virtual ICancellableAsyncResult BeginGetAccountProperties(AsyncCallback callback, object state)

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

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

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

public virtual ICancellableAsyncResult BeginOpenRead(AsyncCallback callback, object state)

Begins an asynchronous operation to open a stream for reading from the blob.

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

Begins an asynchronous operation to open a stream for reading from the blob.

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

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

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

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

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

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

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

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

public virtual ICancellableAsyncResult BeginRotateEncryptionKey(AsyncCallback callback, object state)

Begins an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

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

Begins an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

public virtual ICancellableAsyncResult BeginSetMetadata(AsyncCallback callback, object state)

Begins an asynchronous operation to update the blob's metadata.

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

Begins an asynchronous operation to update the blob's metadata.

public virtual ICancellableAsyncResult BeginSetProperties(AsyncCallback callback, object state)

Begins an asynchronous operation to update the blob's properties.

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

Begins an asynchronous operation to update the blob's properties.

public virtual ICancellableAsyncResult BeginSnapshot(AsyncCallback callback, object state)

Begins an asynchronous operation to create a snapshot of the blob.

public virtual ICancellableAsyncResult BeginSnapshot(IDictionary<string, string> metadata, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to create a snapshot of the blob.

public virtual ICancellableAsyncResult BeginStartCopy(Uri source, AsyncCallback callback, object state)

Begins an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual ICancellableAsyncResult BeginStartCopy(Uri source, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual ICancellableAsyncResult BeginUndelete(AsyncCallback callback, object state)

Begins an asynchronous operation to undelete the soft-deleted blob.

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

Begins an asynchronous operation to undelete the soft-deleted blob.

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

Breaks the current lease on this blob.

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

Initiates an asynchronous operation to break the current lease on this blob.

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

Initiates an asynchronous operation to break the current lease on this blob.

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

Initiates an asynchronous operation to break the current lease on this blob.

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

Initiates an asynchronous operation to break the current lease on this blob.

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

Changes the lease ID on this blob.

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

Initiates an asynchronous operation to change the lease on this blob.

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

Initiates an asynchronous operation to change the lease on this blob.

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

Initiates an asynchronous operation to change the lease on this blob.

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

Initiates an asynchronous operation to change the lease on this blob.

public virtual void Delete(DeleteSnapshotsOption deleteSnapshotsOption = 0, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Deletes the blob.

public virtual Task DeleteAsync()

Initiates an asynchronous operation to delete the blob.

public virtual Task DeleteAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to delete the blob.

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

Initiates an asynchronous operation to delete the blob.

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

Initiates an asynchronous operation to delete the blob.

public virtual bool DeleteIfExists(DeleteSnapshotsOption deleteSnapshotsOption = 0, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Deletes the blob if it already exists.

public virtual Task<bool> DeleteIfExistsAsync()

Initiates an asynchronous operation to delete the blob if it already exists.

public virtual Task<bool> DeleteIfExistsAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to delete the blob if it already exists.

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

Initiates an asynchronous operation to delete the blob if it already exists.

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

Initiates an asynchronous operation to delete the blob if it already exists.

public virtual int DownloadRangeToByteArray(byte[] target, int index, long? blobOffset, long? length, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Downloads a range of bytes from a blob to a byte array.

public virtual Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length)

Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, IProgress<StorageProgress> progressHandler, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual void DownloadRangeToStream(Stream target, long? offset, long? length, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Downloads a range of bytes from a blob to a stream.

public virtual Task DownloadRangeToStreamAsync(Stream target, long? offset, long? length)

Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual Task DownloadRangeToStreamAsync(Stream target, long? offset, long? length, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual Task DownloadRangeToStreamAsync(Stream target, long? offset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual Task DownloadRangeToStreamAsync(Stream target, long? offset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual Task DownloadRangeToStreamAsync(Stream target, long? offset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, IProgress<StorageProgress> progressHandler, CancellationToken cancellationToken)

Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual int DownloadToByteArray(byte[] target, int index, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Downloads the contents of a blob to a byte array.

public virtual Task<int> DownloadToByteArrayAsync(byte[] target, int index)

Initiates an asynchronous operation to download the contents of a blob to a byte array.

public virtual Task<int> DownloadToByteArrayAsync(byte[] target, int index, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a byte array.

public virtual Task<int> DownloadToByteArrayAsync(byte[] target, int index, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to download the contents of a blob to a byte array.

public virtual Task<int> DownloadToByteArrayAsync(byte[] target, int index, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a byte array.

public virtual Task<int> DownloadToByteArrayAsync(byte[] target, int index, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, IProgress<StorageProgress> progressHandler, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a byte array.

public virtual void DownloadToFile(string path, FileMode mode, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Downloads the contents of a blob to a file.

public virtual Task DownloadToFileAsync(string path, FileMode mode)

Initiates an asynchronous operation to download the contents of a blob to a file.

public virtual Task DownloadToFileAsync(string path, FileMode mode, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file.

public virtual Task DownloadToFileAsync(string path, FileMode mode, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to download the contents of a blob to a file.

public virtual Task DownloadToFileAsync(string path, FileMode mode, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file.

public virtual Task DownloadToFileAsync(string path, FileMode mode, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, IProgress<StorageProgress> progressHandler, CancellationToken cancellationToken)

Downloads the contents of a blob to a file.

public virtual Task DownloadToFileParallelAsync(string path, FileMode mode, int parallelIOCount, long? rangeSizeInBytes)

Initiates an asynchronous operation to download the contents of a blob to a file by making parallel requests.

public virtual Task DownloadToFileParallelAsync(string path, FileMode mode, int parallelIOCount, long? rangeSizeInBytes, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file by making parallel requests.

public virtual Task DownloadToFileParallelAsync(string path, FileMode mode, int parallelIOCount, long? rangeSizeInBytes, long offset, long? length, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file by making parallel requests.

public virtual void DownloadToStream(Stream target, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Downloads the contents of a blob to a stream.

public virtual Task DownloadToStreamAsync(Stream target)

Initiates an asynchronous operation to download the contents of a blob to a stream.

public virtual Task DownloadToStreamAsync(Stream target, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

public virtual Task DownloadToStreamAsync(Stream target, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to download the contents of a blob to a stream.

public virtual Task DownloadToStreamAsync(Stream target, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

public virtual Task DownloadToStreamAsync(Stream target, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, IProgress<StorageProgress> progressHandler, CancellationToken cancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

public virtual void EndAbortCopy(IAsyncResult asyncResult)

Ends an asynchronous operation to abort an ongoing blob copy operation.

public virtual string EndAcquireLease(IAsyncResult asyncResult)

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

public virtual TimeSpan EndBreakLease(IAsyncResult asyncResult)

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

public virtual string EndChangeLease(IAsyncResult asyncResult)

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

public virtual void EndDelete(IAsyncResult asyncResult)

Ends an asynchronous operation to delete the blob.

public virtual bool EndDeleteIfExists(IAsyncResult asyncResult)

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

public virtual int EndDownloadRangeToByteArray(IAsyncResult asyncResult)

Ends an asynchronous operation to download a range of bytes from a blob to a byte array.

public virtual void EndDownloadRangeToStream(IAsyncResult asyncResult)

Ends an asynchronous operation to download a range of bytes from a blob to a stream.

public virtual int EndDownloadToByteArray(IAsyncResult asyncResult)

Ends an asynchronous operation to download the contents of a blob to a byte array.

public virtual void EndDownloadToFile(IAsyncResult asyncResult)

Ends an asynchronous operation to download the contents of a blob to a file.

public virtual void EndDownloadToStream(IAsyncResult asyncResult)

Ends an asynchronous operation to download the contents of a blob to a stream.

public virtual bool EndExists(IAsyncResult asyncResult)

Returns the asynchronous result of the request to check existence of the blob.

public virtual void EndFetchAttributes(IAsyncResult asyncResult)

Ends an asynchronous operation to populate the blob's properties and metadata.

public virtual AccountProperties EndGetAccountProperties(IAsyncResult asyncResult)

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

public virtual Stream EndOpenRead(IAsyncResult asyncResult)

Ends an asynchronous operation to open a stream for reading from the blob.

public virtual void EndReleaseLease(IAsyncResult asyncResult)

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

public virtual void EndRenewLease(IAsyncResult asyncResult)

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

public virtual void EndRotateEncryptionKey(IAsyncResult asyncResult)

Ends an asynchronous operation to rotate the encryption key on this blob.

public virtual void EndSetMetadata(IAsyncResult asyncResult)

Ends an asynchronous operation to update the blob's metadata.

public virtual void EndSetProperties(IAsyncResult asyncResult)

Ends an asynchronous operation to update the blob's properties.

public virtual CloudBlob EndSnapshot(IAsyncResult asyncResult)

Ends an asynchronous operation to create a snapshot of the blob.

public virtual string EndStartCopy(IAsyncResult asyncResult)

Ends an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual void EndUndelete(IAsyncResult asyncResult)

Ends an asynchronous operation to undelete the soft-deleted blob.

public virtual bool Exists(BlobRequestOptions options = null, OperationContext operationContext = null)

Checks existence of the blob.

public virtual Task<bool> ExistsAsync()

Initiates an asynchronous operation to check existence of the blob.

public virtual Task<bool> ExistsAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to check existence of the blob.

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

Initiates an asynchronous operation to check existence of the blob.

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

Initiates an asynchronous operation to check existence of the blob.

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

Initiates an asynchronous operation to check existence of the blob.

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

Populates a blob's properties and metadata.

public virtual Task FetchAttributesAsync()

Initiates an asynchronous operation to populate the blob's properties and metadata.

public virtual Task FetchAttributesAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to populate the blob's properties and metadata.

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

Initiates an asynchronous operation to populate the blob's properties and metadata.

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

Initiates an asynchronous operation to populate the blob's properties and metadata.

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

Get properties for the account this blob resides on.

public virtual Task<AccountProperties> GetAccountPropertiesAsync()

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

public virtual Task<AccountProperties> GetAccountPropertiesAsync(CancellationToken cancellationToken)

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

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

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

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

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

Returns a shared access signature for the blob.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, string groupPolicyIdentifier)

Returns a shared access signature for the blob.

Returns a shared access signature for the blob.

public string GetSharedAccessSignature(SharedAccessBlobPolicy policy, SharedAccessBlobHeaders headers, string groupPolicyIdentifier)

Returns a shared access signature for the blob.

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

Returns a shared access signature for the blob.

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 blob, with credentials solely based on the UserDelegationKey provided.

public virtual Stream OpenRead(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Opens a stream for reading from the blob.

public virtual Task<Stream> OpenReadAsync()

Initiates an asynchronous operation to open a stream for reading from the blob.

public virtual Task<Stream> OpenReadAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to open a stream for reading from the blob.

public virtual Task<Stream> OpenReadAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to open a stream for reading from the blob.

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

Initiates an asynchronous operation to open a stream for reading from the blob.

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

Releases the lease on this blob.

public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition)

Initiates an asynchronous operation to release the lease on this blob.

public virtual Task ReleaseLeaseAsync(AccessCondition accessCondition, CancellationToken cancellationToken)

Initiates an asynchronous operation to release the lease on this blob.

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

Initiates an asynchronous operation to release the lease on this blob.

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

Initiates an asynchronous operation to release the lease on this blob.

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

Renews a lease on this blob.

public virtual Task RenewLeaseAsync(AccessCondition accessCondition)

Initiates an asynchronous operation to renew a lease on this blob.

public virtual Task RenewLeaseAsync(AccessCondition accessCondition, CancellationToken cancellationToken)

Initiates an asynchronous operation to renew a lease on this blob.

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

Initiates an asynchronous operation to renew a lease on this blob.

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

Initiates an asynchronous operation to renew a lease on this blob.

public virtual void RotateEncryptionKey(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Rotates the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

public virtual Task RotateEncryptionKeyAsync()

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

public virtual Task RotateEncryptionKeyAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

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

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

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

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

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

Updates the blob's metadata.

public virtual Task SetMetadataAsync()

Initiates an asynchronous operation to update the blob's metadata.

public virtual Task SetMetadataAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to update the blob's metadata.

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

Initiates an asynchronous operation to update the blob's metadata.

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

Initiates an asynchronous operation to update the blob's metadata.

public virtual void SetProperties(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Updates the blob's properties.

public virtual Task SetPropertiesAsync()

Initiates an asynchronous operation to update the blob's properties.

public virtual Task SetPropertiesAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to update the blob's properties.

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

Initiates an asynchronous operation to update the blob's properties.

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

Initiates an asynchronous operation to update the blob's properties.

public virtual CloudBlob Snapshot(IDictionary<string, string> metadata = null, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Creates a snapshot of the blob.

public virtual Task<CloudBlob> SnapshotAsync()

Initiates an asynchronous operation to create a snapshot of the blob.

public virtual Task<CloudBlob> SnapshotAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to create a snapshot of the blob.

public virtual Task<CloudBlob> SnapshotAsync(IDictionary<string, string> metadata, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to create a snapshot of the blob.

public virtual Task<CloudBlob> SnapshotAsync(IDictionary<string, string> metadata, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to create a snapshot of the blob.

public virtual string StartCopy(Uri source, AccessCondition sourceAccessCondition = null, AccessCondition destAccessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Begins an operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source, CancellationToken cancellationToken)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source, PremiumPageBlobTier? premiumPageBlobTier, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual Task<string> StartCopyAsync(Uri source, StandardBlobTier? standardBlockBlobTier, RehydratePriority? rehydratePriority, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to start copying another blob's contents, properties, and metadata to this blob.

public virtual void Undelete(AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

UnDeletes the blob if it is soft-deleted.

public virtual Task UndeleteAsync()

Initiates an asynchronous operation to undelete the soft-deleted blob.

public virtual Task UndeleteAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to delete the blob.

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

Initiates an asynchronous operation to undelete the soft-deleted blob.

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

Initiates an asynchronous operation to undelete the soft-deleted blob.