BlobBaseClient.DownloadTo Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| DownloadTo(Stream) |
The DownloadTo(Stream) operation downloads a blob using parallel requests,
and writes the content to |
| DownloadTo(String) |
The DownloadTo(String) operation downloads a blob using parallel requests,
and writes the content to |
| DownloadTo(Stream, CancellationToken) |
The DownloadTo(Stream, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to |
| DownloadTo(String, CancellationToken) |
The DownloadTo(String, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to |
| DownloadTo(Stream, BlobDownloadToOptions, CancellationToken) |
The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)
operation downloads a blob using parallel requests,
and writes the content to |
| DownloadTo(String, BlobDownloadToOptions, CancellationToken) |
The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)
operation downloads a blob using parallel requests,
and writes the content to |
DownloadTo(Stream)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
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.ResponsePublic Overridable Function DownloadTo (destination As Stream) As ResponseParameters
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadTo(String)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
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.ResponsePublic Overridable Function DownloadTo (path As String) As ResponseParameters
- path
- String
A file path to write the downloaded content to.
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadTo(Stream, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
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.ResponsePublic Overridable Function DownloadTo (destination As Stream, cancellationToken As CancellationToken) As ResponseParameters
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadTo(String, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
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.ResponsePublic Overridable Function DownloadTo (path As String, cancellationToken As CancellationToken) As ResponseParameters
- 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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadTo(Stream, BlobDownloadToOptions, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,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.
public virtual Azure.Response DownloadTo (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member DownloadTo : System.IO.Stream * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : System.IO.Stream * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function DownloadTo (destination As Stream, options As BlobDownloadToOptions, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- 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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadTo(String, BlobDownloadToOptions, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,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.
public virtual Azure.Response DownloadTo (string path, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member DownloadTo : string * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> Azure.Response
override this.DownloadTo : string * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function DownloadTo (path As String, options As BlobDownloadToOptions, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- 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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
