DataLakeFileSystemClient.GetPropertiesAsync 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:: 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 GetPropertiesAsync(DataLakeRequestConditions, CancellationToken) operation returns all user-defined metadata and system properties for the specified file system. The data returned does not include the file system's list of paths.

For more information, see Get Container Properties.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileSystemProperties>> GetPropertiesAsync (Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPropertiesAsync : Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileSystemProperties>>
override this.GetPropertiesAsync : Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileSystemProperties>>

Public Overridable Function GetPropertiesAsync (Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FileSystemProperties))

Parameters

conditions: DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on getting the file system's properties.

cancellationToken: CancellationToken

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

Returns

Task<Response<FileSystemProperties>>

A Response<T> describing the file system and its properties.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to