TransferManager.DownloadAsync Method

Definition

Namespace:

Microsoft.Azure.Storage.DataMovement

Assembly:

Microsoft.Azure.Storage.DataMovement.dll

Package:

Microsoft.Azure.Storage.DataMovement v2.0.4

Overloads

DownloadAsync(CloudFile, String, DownloadOptions, SingleTransferContext, CancellationToken)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudFile, Stream, DownloadOptions, SingleTransferContext, CancellationToken)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudBlob, String, DownloadOptions, SingleTransferContext, CancellationToken)	Download an Azure blob from Azure Blob Storage.
DownloadAsync(CloudBlob, Stream, DownloadOptions, SingleTransferContext, CancellationToken)	Download an Azure blob from Azure Blob Storage.
DownloadAsync(CloudFile, String, DownloadOptions, SingleTransferContext)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudFile, Stream, DownloadOptions, SingleTransferContext)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudFile, Stream)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudBlob, Stream, DownloadOptions, SingleTransferContext)	Download an Azure blob from Azure Blob Storage.
DownloadAsync(CloudFile, String)	Download an Azure file from Azure File Storage.
DownloadAsync(CloudBlob, String)	Download an Azure blob from Azure Blob Storage.
DownloadAsync(CloudBlob, Stream)	Download an Azure blob from Azure Blob Storage.
DownloadAsync(CloudBlob, String, DownloadOptions, SingleTransferContext)	Download an Azure blob from Azure Blob Storage.

DownloadAsync(CloudFile, String, DownloadOptions, SingleTransferContext, CancellationToken)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, string destPath, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context, System.Threading.CancellationToken cancellationToken);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * string * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destPath

String

Path to the destination file.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

cancellationToken

CancellationToken

A CancellationToken object to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudFile, Stream, DownloadOptions, SingleTransferContext, CancellationToken)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, System.IO.Stream destStream, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context, System.Threading.CancellationToken cancellationToken);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * System.IO.Stream * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destStream

Stream

A Stream object representing the destination stream.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

cancellationToken

CancellationToken

A CancellationToken object to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, String, DownloadOptions, SingleTransferContext, CancellationToken)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, string destPath, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context, System.Threading.CancellationToken cancellationToken);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * string * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destPath

String

Path to the destination file.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

cancellationToken

CancellationToken

A CancellationToken object to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, Stream, DownloadOptions, SingleTransferContext, CancellationToken)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, System.IO.Stream destStream, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context, System.Threading.CancellationToken cancellationToken);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * System.IO.Stream * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destStream

Stream

A Stream object representing the destination stream.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

cancellationToken

CancellationToken

A CancellationToken object to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudFile, String, DownloadOptions, SingleTransferContext)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, string destPath, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * string * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String, options As DownloadOptions, context As SingleTransferContext) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destPath

String

Path to the destination file.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudFile, Stream, DownloadOptions, SingleTransferContext)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, System.IO.Stream destStream, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * System.IO.Stream * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream, options As DownloadOptions, context As SingleTransferContext) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destStream

Stream

A Stream object representing the destination stream.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudFile, Stream)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, System.IO.Stream destStream);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * System.IO.Stream -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destStream

Stream

A Stream object representing the destination stream.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, Stream, DownloadOptions, SingleTransferContext)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, System.IO.Stream destStream, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * System.IO.Stream * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream, options As DownloadOptions, context As SingleTransferContext) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destStream

Stream

A Stream object representing the destination stream.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudFile, String)

Download an Azure file from Azure File Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.File.CloudFile sourceFile, string destPath);

static member DownloadAsync : Microsoft.Azure.Storage.File.CloudFile * string -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String) As Task

Parameters

sourceFile

CloudFile

The CloudFile that is the source Azure file.

destPath

String

Path to the destination file.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, String)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, string destPath);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * string -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destPath

String

Path to the destination file.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, Stream)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, System.IO.Stream destStream);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * System.IO.Stream -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destStream

Stream

A Stream object representing the destination stream.

Returns

Task

A Task object that represents the asynchronous operation.

DownloadAsync(CloudBlob, String, DownloadOptions, SingleTransferContext)

Download an Azure blob from Azure Blob Storage.

public static System.Threading.Tasks.Task DownloadAsync (Microsoft.Azure.Storage.Blob.CloudBlob sourceBlob, string destPath, Microsoft.Azure.Storage.DataMovement.DownloadOptions options, Microsoft.Azure.Storage.DataMovement.SingleTransferContext context);

static member DownloadAsync : Microsoft.Azure.Storage.Blob.CloudBlob * string * Microsoft.Azure.Storage.DataMovement.DownloadOptions * Microsoft.Azure.Storage.DataMovement.SingleTransferContext -> System.Threading.Tasks.Task

Public Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String, options As DownloadOptions, context As SingleTransferContext) As Task

Parameters

sourceBlob

CloudBlob

The CloudBlob that is the source Azure blob.

destPath

String

Path to the destination file.

options

DownloadOptions

A DownloadOptions object that specifies additional options for the operation.

context

SingleTransferContext

A SingleTransferContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.