DataLakeServiceClient.GetFileSystems 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:: DataLakeServiceClient.cs

Source:: DataLakeServiceClient.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 GetFileSystems(FileSystemTraits, FileSystemStates, String, CancellationToken) operation returns an async sequence of file systems in the storage account. Enumerating the file systems may make multiple requests to the service while fetching all the values. File systems are ordered lexicographically by name.

For more information, see List Containers.

public virtual Azure.Pageable<Azure.Storage.Files.DataLake.Models.FileSystemItem> GetFileSystems (Azure.Storage.Files.DataLake.Models.FileSystemTraits traits = Azure.Storage.Files.DataLake.Models.FileSystemTraits.None, Azure.Storage.Files.DataLake.Models.FileSystemStates states = Azure.Storage.Files.DataLake.Models.FileSystemStates.None, string prefix = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetFileSystems : Azure.Storage.Files.DataLake.Models.FileSystemTraits * Azure.Storage.Files.DataLake.Models.FileSystemStates * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.FileSystemItem>
override this.GetFileSystems : Azure.Storage.Files.DataLake.Models.FileSystemTraits * Azure.Storage.Files.DataLake.Models.FileSystemStates * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.FileSystemItem>

Public Overridable Function GetFileSystems (Optional traits As FileSystemTraits = Azure.Storage.Files.DataLake.Models.FileSystemTraits.None, Optional states As FileSystemStates = Azure.Storage.Files.DataLake.Models.FileSystemStates.None, Optional prefix As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of FileSystemItem)

Parameters

traits: FileSystemTraits

Specifies trait options for shaping the file systems.

states: FileSystemStates

Specifies state options for shaping the file systems.

prefix: String

Specifies a string that filters the results to return only file systems whose name begins with the specified prefix.

cancellationToken: CancellationToken

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

Returns

Pageable<FileSystemItem>

An IEnumerable<T> of Response<T> describing the file systems in the storage account.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to