BlobBaseClient.DownloadTo Method

Definition

Overloads

DownloadTo(Stream)

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

DownloadTo(String)

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

DownloadTo(Stream, CancellationToken)

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

DownloadTo(String, CancellationToken)

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

DownloadTo(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken)

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

DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken)

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

DownloadTo(Stream)

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

public virtual Azure.Response DownloadTo (System.IO.Stream destination);
abstract member DownloadTo : System.IO.Stream -> Azure.Response
override this.DownloadTo : System.IO.Stream -> Azure.Response
Public Overridable Function DownloadTo (destination As Stream) As Response

Parameters

destination
Stream

A Stream to write the downloaded content to.

Returns

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

DownloadTo(String)

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

public virtual Azure.Response DownloadTo (string path);
abstract member DownloadTo : string -> Azure.Response
override this.DownloadTo : string -> Azure.Response
Public Overridable Function DownloadTo (path As String) As Response

Parameters

path
String

A file path to write the downloaded content to.

Returns

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

DownloadTo(Stream, CancellationToken)

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

public virtual Azure.Response DownloadTo (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);
abstract member DownloadTo : System.IO.Stream * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : System.IO.Stream * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DownloadTo (destination As Stream, cancellationToken As CancellationToken) As Response

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

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

DownloadTo(String, CancellationToken)

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

public virtual Azure.Response DownloadTo (string path, System.Threading.CancellationToken cancellationToken);
abstract member DownloadTo : string * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DownloadTo (path As String, cancellationToken As CancellationToken) As Response

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

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

DownloadTo(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken)

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

public virtual Azure.Response DownloadTo (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, Azure.Storage.StorageTransferOptions transferOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DownloadTo : System.IO.Stream * Azure.Storage.Blobs.Models.BlobRequestConditions * Azure.Storage.StorageTransferOptions * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : System.IO.Stream * Azure.Storage.Blobs.Models.BlobRequestConditions * Azure.Storage.StorageTransferOptions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DownloadTo (destination As Stream, Optional conditions As BlobRequestConditions = Nothing, Optional transferOptions As StorageTransferOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

destination
Stream

A Stream to write the downloaded content to.

conditions
BlobRequestConditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

transferOptions
StorageTransferOptions

Optional StorageTransferOptions to configure parallel transfer behavior.

cancellationToken
CancellationToken

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

Returns

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken)

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

public virtual Azure.Response DownloadTo (string path, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, Azure.Storage.StorageTransferOptions transferOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DownloadTo : string * Azure.Storage.Blobs.Models.BlobRequestConditions * Azure.Storage.StorageTransferOptions * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : string * Azure.Storage.Blobs.Models.BlobRequestConditions * Azure.Storage.StorageTransferOptions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DownloadTo (path As String, Optional conditions As BlobRequestConditions = Nothing, Optional transferOptions As StorageTransferOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

path
String

A file path to write the downloaded content to.

conditions
BlobRequestConditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

transferOptions
StorageTransferOptions

Optional StorageTransferOptions to configure parallel transfer behavior.

cancellationToken
CancellationToken

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

Returns

Response

A Response describing the operation.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to