Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

DataLakeFileSystemClient.GetPathsAsync Method

Definition

Namespace:
Azure.Storage.Files.DataLake
Assembly:
Azure.Storage.Files.DataLake.dll
Package:
Azure.Storage.Files.DataLake v12.27.0
Package:
Azure.Storage.Files.DataLake v12.27.0-beta.1
Source:
DataLakeFileSystemClient.cs
Source:
DataLakeFileSystemClient.cs

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.

The Azure.Storage.Files.DataLake.DataLakeFileSystemClient.GetPathsAsync(System.String,System.Boolean,System.Boolean,System.Threading.CancellationToken) operation returns an async sequence of paths in this file system. Enumerating the paths may make multiple requests to the service while fetching all the values.

For more information, see List Path(s).

public virtual Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem> GetPathsAsync(Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPathsAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>
override this.GetPathsAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>
Public Overridable Function GetPathsAsync (Optional options As DataLakeGetPathsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PathItem)

Parameters

options
DataLakeGetPathsOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

An AsyncPageable<T> describing the paths in the file system.

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to

Feedback

Was this page helpful?