CloudBlob.DownloadToFileAsync 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
| DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken) |
Downloads the contents of a blob to a file. |
| DownloadToFileAsync(String, FileMode) |
Initiates an asynchronous operation to download the contents of a blob to a file. |
| DownloadToFileAsync(String, FileMode, CancellationToken) |
Initiates an asynchronous operation to download the contents of a blob to a file. |
| DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation to download the contents of a blob to a file. |
| DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to download the contents of a blob to a file. |
DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)
Downloads the contents of a blob to a file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync(string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As TaskParameters
- path
- System.String
A string containing the file path providing the blob content.
- mode
- System.IO.FileMode
A System.IO.FileMode enumeration value that specifies how to open the file.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the blob.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- progressHandler
- System.IProgress<StorageProgress>
A System.IProgress`1 object to handle StorageProgress messages.
- cancellationToken
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
An System.Threading.Tasks.Task that represents an asynchronous action.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode)
Initiates an asynchronous operation to download the contents of a blob to a file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync(string path, System.IO.FileMode mode);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode) As TaskParameters
- path
- System.String
A string containing the path to the target file.
- mode
- System.IO.FileMode
A System.IO.FileMode enumeration value that determines how to open or create the file.
Returns
A System.Threading.Tasks.Task object that represents the asynchronous operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, CancellationToken)
Initiates an asynchronous operation to download the contents of a blob to a file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync(string path, System.IO.FileMode mode, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, cancellationToken As CancellationToken) As TaskParameters
- path
- System.String
A string containing the path to the target file.
- mode
- System.IO.FileMode
A System.IO.FileMode enumeration value that determines how to open or create the file.
- cancellationToken
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
A System.Threading.Tasks.Task object that represents the asynchronous operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to download the contents of a blob to a file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync(string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As TaskParameters
- path
- System.String
A string containing the path to the target file.
- mode
- System.IO.FileMode
A System.IO.FileMode enumeration value that determines how to open or create the file.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
A System.Threading.Tasks.Task object that represents the asynchronous operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to download the contents of a blob to a file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync(string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As TaskParameters
- path
- System.String
A string containing the path to the target file.
- mode
- System.IO.FileMode
A System.IO.FileMode enumeration value that determines how to open or create the file.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- cancellationToken
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
A System.Threading.Tasks.Task object that represents the asynchronous operation.
- Attributes