Share via


ShareDirectoryClient.GetPropertiesAsync(CancellationToken) Method

Definition

The GetPropertiesAsync(CancellationToken) operation returns all user-defined metadata and system properties for the specified directory. The data returned does not include the directory's list of subdirectories or files.

For more information, see Get Directory Properties.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryProperties>> GetPropertiesAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member GetPropertiesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryProperties>>
override this.GetPropertiesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareDirectoryProperties>>
Public Overridable Function GetPropertiesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ShareDirectoryProperties))

Parameters

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the directory and its properties.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to