Share via


ShareFileClient.CreateSymbolicLinkAsync Method

Definition

NFS only. Creates a symoblic link to the file specified by path.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo>> CreateSymbolicLinkAsync(string linkText, Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateSymbolicLinkAsync : string * Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo>>
override this.CreateSymbolicLinkAsync : string * Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo>>
Public Overridable Function CreateSymbolicLinkAsync (linkText As String, Optional options As ShareFileCreateSymbolicLinkOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ShareFileInfo))

Parameters

linkText
String

The absolution or relative path to the file to be linked to.

options
ShareFileCreateSymbolicLinkOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

A Response<T> describing the state of the file.

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