BlobBaseClient.DownloadAsync Method

Definition

Overloads

DownloadAsync()

The DownloadAsync() operation downloads a blob from the service, including its metadata and properties.

For more information, see .

DownloadAsync(CancellationToken)

The DownloadAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see .

DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

The DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see .

DownloadAsync()

The DownloadAsync() operation downloads a blob from the service, including its metadata and properties.

For more information, see .

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync ();
abstract member DownloadAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>
override this.DownloadAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>
Public Overridable Function DownloadAsync () As Task(Of Response(Of BlobDownloadInfo))

Returns

A Response<T> describing the downloaded blob. Content contains the blob's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadAsync(CancellationToken)

The DownloadAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see .

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync (System.Threading.CancellationToken cancellationToken);
abstract member DownloadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>
override this.DownloadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>

Parameters

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

A Response<T> describing the downloaded blob. Content contains the blob's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

The DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see .

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync (Azure.HttpRange range = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, bool rangeGetContentHash = false, System.Threading.CancellationToken cancellationToken = null);
abstract member DownloadAsync : Azure.HttpRange * Azure.Storage.Blobs.Models.BlobRequestConditions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>
override this.DownloadAsync : Azure.HttpRange * Azure.Storage.Blobs.Models.BlobRequestConditions * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>>

Parameters

range
HttpRange

If provided, only donwload the bytes of the blob in the specified range. If not provided, download the entire blob.

conditions
BlobRequestConditions

Optional BlobRequestConditions to add conditions on donwloading this blob.

rangeGetContentHash
Boolean

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a RequestFailedException is thrown.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

A Response<T> describing the downloaded blob. Content contains the blob's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to