Share via


ShareFileClient.AbortCopyAsync Method

Definition

Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata.

For more information, see Abort Copy File.

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

Parameters

copyId
String

String identifier for the copy operation.

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

A Response on successfully aborting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to