Share via


DataLakeFileClient.ReadToAsync Method

Definition

Overloads

ReadToAsync(Stream, DataLakeFileReadToOptions, CancellationToken)

The ReadToAsync(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided destination stream.

ReadToAsync(String, DataLakeFileReadToOptions, CancellationToken)

The ReadToAsync(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path.

ReadToAsync(Stream, DataLakeFileReadToOptions, CancellationToken)

Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The ReadToAsync(Stream, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided destination stream.

public virtual System.Threading.Tasks.Task<Azure.Response> ReadToAsync (System.IO.Stream destination, Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadToAsync : System.IO.Stream * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.ReadToAsync : System.IO.Stream * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function ReadToAsync (destination As Stream, Optional options As DataLakeFileReadToOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

destination
Stream

Stream to write read contents to.

options
DataLakeFileReadToOptions

Options for reading this blob.

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

ReadToAsync(String, DataLakeFileReadToOptions, CancellationToken)

Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The ReadToAsync(String, DataLakeFileReadToOptions, CancellationToken) operation downloads an entire file using parallel requests, and writes the content to the provided file path.

public virtual System.Threading.Tasks.Task<Azure.Response> ReadToAsync (string path, Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadToAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.ReadToAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeFileReadToOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function ReadToAsync (path As String, Optional options As DataLakeFileReadToOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

path
String

File path to write the read contents to.

options
DataLakeFileReadToOptions

Options for reading this blob.

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