ShareFileClient.CreateSymbolicLink Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.23.0-beta.1

Source:: ShareFileClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public virtual Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo> CreateSymbolicLink(string linkText, Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateSymbolicLink : string * Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo>
override this.CreateSymbolicLink : string * Azure.Storage.Files.Shares.Models.ShareFileCreateSymbolicLinkOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.Shares.Models.ShareFileInfo>

Public Overridable Function CreateSymbolicLink (linkText As String, Optional options As ShareFileCreateSymbolicLinkOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<ShareFileInfo>

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