BlobBaseClient.DownloadToAsync 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
| 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 |
| 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 |
| DownloadToAsync(String, CancellationToken) |
The DownloadToAsync(String, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to |
| DownloadToAsync(Stream, CancellationToken) |
The DownloadToAsync(Stream, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to |
| DownloadToAsync(String) |
The DownloadToAsync(String) downloads a blob using parallel requests,
and writes the content to |
| DownloadToAsync(Stream) |
The DownloadToAsync(Stream) downloads a blob using parallel requests,
and writes the content to |
DownloadToAsync(String, BlobDownloadToOptions, CancellationToken)
- Source:
- BlobBaseClient.cs
- 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.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member DownloadToAsync : string * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : string * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (path As String, options As BlobDownloadToOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadToAsync(Stream, BlobDownloadToOptions, CancellationToken)
- Source:
- BlobBaseClient.cs
- 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.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member DownloadToAsync : System.IO.Stream * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : System.IO.Stream * Azure.Storage.Blobs.Models.BlobDownloadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (destination As Stream, options As BlobDownloadToOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadToAsync(String, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadToAsync(String, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to path.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path, System.Threading.CancellationToken cancellationToken);abstract member DownloadToAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (path As String, cancellationToken As CancellationToken) As Task(Of 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
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
DownloadToAsync(Stream, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadToAsync(Stream, CancellationToken) operation
downloads a blob using parallel requests,
and writes the content to destination.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);abstract member DownloadToAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (destination As Stream, cancellationToken As CancellationToken) As Task(Of Response)Parameters
- 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
DownloadToAsync(String)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadToAsync(String) downloads a blob using parallel requests,
and writes the content to path.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path);abstract member DownloadToAsync : string -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : string -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (path As String) As Task(Of Response)Parameters
- 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
DownloadToAsync(Stream)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadToAsync(Stream) downloads a blob using parallel requests,
and writes the content to destination.
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination);abstract member DownloadToAsync : System.IO.Stream -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadToAsync : System.IO.Stream -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DownloadToAsync (destination As Stream) As Task(Of Response)Parameters
Returns
A Response describing the operation.
Remarks
A RequestFailedException will be thrown if a failure occurs.
