DataLakeFileClient.Read 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
| Read() |
The Read() operation downloads a file from the service, including its metadata and properties. For more information, see Get Blob. |
| Read(CancellationToken) |
The Read(CancellationToken) operation downloads a file from the service, including its metadata and properties. For more information, see Get Blob. |
| Read(DataLakeFileReadOptions, CancellationToken) |
The Azure.Storage.Files.DataLake.DataLakeFileClient.Read(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. |
Read()
- Source:
- DataLakeFileClient.cs
- Source:
- DataLakeFileClient.cs
public virtual Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo> Read ();abstract member Read : unit -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>
override this.Read : unit -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>Public Overridable Function Read () As Response(Of FileDownloadInfo)Returns
A Response<T> describing the downloaded file. Content contains the blob's data.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
Read(CancellationToken)
- Source:
- DataLakeFileClient.cs
- Source:
- DataLakeFileClient.cs
The Read(CancellationToken) operation downloads a file from the service, including its metadata and properties.
For more information, see Get Blob.
public virtual Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo> Read (System.Threading.CancellationToken cancellationToken = default);abstract member Read : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>
override this.Read : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>Public Overridable Function Read (Optional cancellationToken As CancellationToken = Nothing) As 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 blob's data.
Remarks
A RequestFailedException will be thrown if a failure occurs.
Applies to
Read(DataLakeFileReadOptions, CancellationToken)
- Source:
- DataLakeFileClient.cs
- Source:
- DataLakeFileClient.cs
The Azure.Storage.Files.DataLake.DataLakeFileClient.Read(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 Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo> Read (Azure.Storage.Files.DataLake.Models.DataLakeFileReadOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member Read : Azure.Storage.Files.DataLake.Models.DataLakeFileReadOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>
override this.Read : Azure.Storage.Files.DataLake.Models.DataLakeFileReadOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>Public Overridable Function Read (Optional options As DataLakeFileReadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for