TransferManager.StartTransferAsync Method

Definition

Namespace:

Azure.Storage.DataMovement

Assembly:

Azure.Storage.DataMovement.dll

Package:

Azure.Storage.DataMovement v12.1.0

Source:

TransferManager.cs

Starts a transfer from the given source resource to the given destination resource. Ensure StorageResource instances are built with appropriate permissions.

public virtual System.Threading.Tasks.Task<Azure.Storage.DataMovement.TransferOperation> StartTransferAsync(Azure.Storage.DataMovement.StorageResource sourceResource, Azure.Storage.DataMovement.StorageResource destinationResource, Azure.Storage.DataMovement.TransferOptions transferOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StartTransferAsync : Azure.Storage.DataMovement.StorageResource * Azure.Storage.DataMovement.StorageResource * Azure.Storage.DataMovement.TransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Storage.DataMovement.TransferOperation>
override this.StartTransferAsync : Azure.Storage.DataMovement.StorageResource * Azure.Storage.DataMovement.StorageResource * Azure.Storage.DataMovement.TransferOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Storage.DataMovement.TransferOperation>

Public Overridable Function StartTransferAsync (sourceResource As StorageResource, destinationResource As StorageResource, Optional transferOptions As TransferOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TransferOperation)

Parameters

sourceResource

StorageResource

A StorageResource representing the source.

destinationResource

StorageResource

A StorageResource representing the destination.

transferOptions

TransferOptions

Options specific to this transfer.

cancellationToken

CancellationToken

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

Returns

Task<TransferOperation>

Returns a TransferOperation for tracking this transfer.