BlobBaseClient.DownloadToAsync Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Overloads

DownloadToAsync(String, BlobDownloadToOptions, CancellationToken)	The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.
DownloadToAsync(Stream, BlobDownloadToOptions, CancellationToken)	The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.
DownloadToAsync(String, CancellationToken)	The DownloadToAsync(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.
DownloadToAsync(Stream, CancellationToken)	The DownloadToAsync(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.
DownloadToAsync(String)	The DownloadToAsync(String) downloads a blob using parallel requests, and writes the content to path.
DownloadToAsync(Stream)	The DownloadToAsync(Stream) downloads a blob using parallel requests, and writes the content to destination.

DownloadToAsync(String, BlobDownloadToOptions, CancellationToken)

Source:

BlobBaseClient.cs

The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(string path, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);

Parameters

path

String

File path to write download content to.

options

BlobDownloadToOptions

Parameters for download.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(Stream, BlobDownloadToOptions, CancellationToken)

Source:

BlobBaseClient.cs

The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);

Parameters

destination

Stream

Stream to write download content to.

options

BlobDownloadToOptions

Parameters for download.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(String, CancellationToken)

Source:

BlobBaseClient.cs

The DownloadToAsync(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(string path, System.Threading.CancellationToken cancellationToken);

Parameters

path

String

A file path to write the downloaded content to.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(Stream, CancellationToken)

Source:

BlobBaseClient.cs

The DownloadToAsync(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);

Parameters

destination

Stream

A Stream to write the downloaded content to.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(String)

Source:

BlobBaseClient.cs

The DownloadToAsync(String) downloads a blob using parallel requests, and writes the content to path.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(string path);

Parameters

path

String

A file path to write the downloaded content to.

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

DownloadToAsync(Stream)

Source:

BlobBaseClient.cs

The DownloadToAsync(Stream) downloads a blob using parallel requests, and writes the content to destination.

C#

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync(System.IO.Stream destination);

Parameters

destination

Stream

A Stream to write the downloaded content to.

Returns

Task<Response>

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.