Language

ShareFileClient.GetFileLinksAsync Method

Definition

Returns the hard links of the file, along with the properties of the file.

This operation is only supported when the client addresses the file by its file ID. Use GetFileClientByFileId(String) to create such a client.

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

Parameters

conditions
ShareFileRequestConditions

Optional ShareFileRequestConditions to add conditions on getting the file links.

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the hard links of the file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to