TransferManager.DownloadAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream, options As DownloadOptions, context As SingleTransferContext, cancellationToken As CancellationToken) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String, options As DownloadOptions, context As SingleTransferContext) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream, options As DownloadOptions, context As SingleTransferContext) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destStream As Stream) As TaskParameters
Returns
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream, options As DownloadOptions, context As SingleTransferContext) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceFile As CloudFile, destPath As String) As TaskParameters
- destPath
- String
Path to the destination file.
Returns
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String) As TaskParameters
- destPath
- String
Path to the destination file.
Returns
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destStream As Stream) As TaskParameters
Returns
A Task object that represents the asynchronous operation.
Applies to
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.TaskPublic Shared Function DownloadAsync (sourceBlob As CloudBlob, destPath As String, options As DownloadOptions, context As SingleTransferContext) As TaskParameters
- 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
A Task object that represents the asynchronous operation.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for