Share via

TransferManager.GetTransfersAsync Method

  • Reference

Definition

Namespace:
Azure.Storage.DataMovement
Assembly:
Azure.Storage.DataMovement.dll
Package:
Azure.Storage.DataMovement v12.0.0-beta.6
Package:
Azure.Storage.DataMovement v12.0.0

Overloads

GetTransfersAsync(DataTransferStatus[])

Gets the current transfers stored in the TransferManager.
GetTransfersAsync(ICollection<TransferStatus>, CancellationToken)

Gets the current transfers stored in the TransferManager.

GetTransfersAsync(DataTransferStatus[])

Source:
TransferManager.cs

Gets the current transfers stored in the TransferManager.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.DataTransfer> GetTransfersAsync (params Azure.Storage.DataMovement.DataTransferStatus[] filterByStatus);
abstract member GetTransfersAsync : Azure.Storage.DataMovement.DataTransferStatus[] -> System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.DataTransfer>
override this.GetTransfersAsync : Azure.Storage.DataMovement.DataTransferStatus[] -> System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.DataTransfer>
Public Overridable Function GetTransfersAsync (ParamArray filterByStatus As DataTransferStatus()) As IAsyncEnumerable(Of DataTransfer)

Parameters

filterByStatus
DataTransferStatus[]

If specified, the returned list of transfers will have only have the transfers of which match the status specified.

If not specified or specified to None, all transfers will be returned regardless of status.

Returns

IAsyncEnumerable<DataTransfer>

Applies to

GetTransfersAsync(ICollection<TransferStatus>, CancellationToken)

Source:
TransferManager.cs

Gets the current transfers stored in the TransferManager.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.TransferOperation> GetTransfersAsync (System.Collections.Generic.ICollection<Azure.Storage.DataMovement.TransferStatus> filterByStatus = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetTransfersAsync : System.Collections.Generic.ICollection<Azure.Storage.DataMovement.TransferStatus> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.TransferOperation>
override this.GetTransfersAsync : System.Collections.Generic.ICollection<Azure.Storage.DataMovement.TransferStatus> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.TransferOperation>
Public Overridable Function GetTransfersAsync (Optional filterByStatus As ICollection(Of TransferStatus) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TransferOperation)

Parameters

filterByStatus
ICollection<TransferStatus>

If specified, the returned list of transfers will have only have the transfers of which match the status specified.

If not specified or specified to None, all transfers will be returned regardless of status.

cancellationToken
CancellationToken

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

Returns

IAsyncEnumerable<TransferOperation>

Applies to