Share via


ShareFileClient.GetSymbolicLink(CancellationToken) Method

Definition

Reads the value of the symbolic link. Only applicable if this ShareFileClient is pointed at an NFS symbolic link.

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

Parameters

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the symbolic link.

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to