ShareFileClient.GetPropertiesAsync Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.20.1

Source:

ShareFileClient.cs

The GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.

For more information, see Get File Properties.

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

abstract member GetPropertiesAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileProperties>>
override this.GetPropertiesAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileProperties>>

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

Parameters

conditions

ShareFileRequestConditions

Optional ShareFileRequestConditions to add conditions on creating the file.

cancellationToken

CancellationToken

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

Returns

Task<Response<ShareFileProperties>>

A Response<T> describing the file's properties.

Remarks

A RequestFailedException will be thrown if a failure occurs.