DataLakeFileClient.ReadAsync Method

Definition

Overloads

ReadAsync()

The ReadAsync() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

ReadAsync(CancellationToken)

The ReadAsync(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

ReadAsync(DataLakeFileReadOptions, CancellationToken)

The Azure.Storage.Files.DataLake.DataLakeFileClient.ReadAsync(Azure.HttpRange,Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions,System.Boolean,System.Threading.CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

ReadAsync()

Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The ReadAsync() operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>> ReadAsync ();
abstract member ReadAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>
override this.ReadAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>
Public Overridable Function ReadAsync () As Task(Of Response(Of FileDownloadInfo))

Returns

A Response<T> describing the downloaded file. Content contains the file's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

ReadAsync(CancellationToken)

Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The ReadAsync(CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>> ReadAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>
override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>
Public Overridable Function ReadAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FileDownloadInfo))

Parameters

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the downloaded file. Content contains the file's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

ReadAsync(DataLakeFileReadOptions, CancellationToken)

Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

The Azure.Storage.Files.DataLake.DataLakeFileClient.ReadAsync(Azure.HttpRange,Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions,System.Boolean,System.Threading.CancellationToken) operation downloads a file from the service, including its metadata and properties.

For more information, see Get Blob.

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

Parameters

options
DataLakeFileReadOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the downloaded file. Content contains the file's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to