BlobBaseClient.Download Method

Definition

Overloads

Download(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

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

For more information, see Get Blob.

Download()

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

For more information, see Get Blob.

Download(CancellationToken)

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

For more information, see Get Blob.

Download(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

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

For more information, see Get Blob.

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo> Download (Azure.HttpRange range = default, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, bool rangeGetContentHash = false, System.Threading.CancellationToken cancellationToken = default);
abstract member Download : Azure.HttpRange * Azure.Storage.Blobs.Models.BlobRequestConditions * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>
override this.Download : Azure.HttpRange * Azure.Storage.Blobs.Models.BlobRequestConditions * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>
Public Overridable Function Download (Optional range As HttpRange = Nothing, Optional conditions As BlobRequestConditions = Nothing, Optional rangeGetContentHash As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BlobDownloadInfo)

Parameters

range
HttpRange

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

conditions
BlobRequestConditions

Optional BlobRequestConditions to add conditions on downloading 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

Response<BlobDownloadInfo>

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

Download()

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

For more information, see Get Blob.

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

Returns

Response<BlobDownloadInfo>

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

Download(CancellationToken)

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

For more information, see Get Blob.

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo> Download (System.Threading.CancellationToken cancellationToken = default);
abstract member Download : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>
override this.Download : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>
Public Overridable Function Download (Optional cancellationToken As CancellationToken = Nothing) As Response(Of BlobDownloadInfo)

Parameters

cancellationToken
CancellationToken

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

Returns

Response<BlobDownloadInfo>

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