DataLakeFileClient.OpenReadAsync Method

  • Reference

Definition

Namespace:
Azure.Storage.Files.DataLake
Assembly:
Azure.Storage.Files.DataLake.dll
Package:
Azure.Storage.Files.DataLake v12.17.1
Package:
Azure.Storage.Files.DataLake v12.18.0-beta.2
Source:
DataLakeFileClient.cs
Source:
DataLakeFileClient.cs

Opens a stream for reading from the file. The stream will only download the file as the stream is read from.

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

Parameters

options
DataLakeOpenReadOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

Task<Stream>

Returns a stream that will download the file as the stream is read from.

Applies to