DataTransfer.PauseAsync(CancellationToken) Method

Definition

Namespace:

Azure.Storage.DataMovement

Assembly:

Azure.Storage.DataMovement.dll

Package:

Azure.Storage.DataMovement v12.0.0-beta.4

Source:

DataTransfer.cs

Attempts to pause the current Data Transfer.

public virtual System.Threading.Tasks.Task PauseAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member PauseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PauseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function PauseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken

CancellationToken

Returns

Task

Will return false if the data transfer has already been completed.

Will return true if the pause has taken place.