BlobTransferClient.DownloadBlob Method (Uri, String, FileEncryption, UInt64, CloudBlobClient, CancellationToken, RetryPolicy)
Downloads the specified blob to the specified location.
Namespace: Microsoft.WindowsAzure.MediaServices.Client
Assembly: Microsoft.WindowsAzure.MediaServices.Client (in Microsoft.WindowsAzure.MediaServices.Client.dll)
Syntax
'Declaration
Public Function DownloadBlob ( _
uri As Uri, _
localFile As String, _
fileEncryption As FileEncryption, _
initializationVector As ULong, _
client As CloudBlobClient, _
cancellationToken As CancellationToken, _
retryPolicy As RetryPolicy _
) As Task
'Usage
Dim instance As BlobTransferClient
Dim uri As Uri
Dim localFile As String
Dim fileEncryption As FileEncryption
Dim initializationVector As ULong
Dim client As CloudBlobClient
Dim cancellationToken As CancellationToken
Dim retryPolicy As RetryPolicy
Dim returnValue As Task
returnValue = instance.DownloadBlob(uri, _
localFile, fileEncryption, initializationVector, _
client, cancellationToken, retryPolicy)
public Task DownloadBlob(
Uri uri,
string localFile,
FileEncryption fileEncryption,
ulong initializationVector,
CloudBlobClient client,
CancellationToken cancellationToken,
RetryPolicy retryPolicy
)
public:
Task^ DownloadBlob(
Uri^ uri,
String^ localFile,
FileEncryption^ fileEncryption,
unsigned long long initializationVector,
CloudBlobClient^ client,
CancellationToken cancellationToken,
RetryPolicy^ retryPolicy
)
member DownloadBlob :
uri:Uri *
localFile:string *
fileEncryption:FileEncryption *
initializationVector:uint64 *
client:CloudBlobClient *
cancellationToken:CancellationToken *
retryPolicy:RetryPolicy -> Task
public function DownloadBlob(
uri : Uri,
localFile : String,
fileEncryption : FileEncryption,
initializationVector : ulong,
client : CloudBlobClient,
cancellationToken : CancellationToken,
retryPolicy : RetryPolicy
) : Task
Parameters
- uri
Type: System.Uri
The blob URL from which file a needs should be downloaded. If blob has private read permissions then an appropriate SAS URL need to be passed.
- localFile
Type: System.String
The full path where file will be saved.
- fileEncryption
Type: Microsoft.WindowsAzure.MediaServices.Client.FileEncryption
The file encryption if file has been encrypted. Pass null if no encryption has been used.
- initializationVector
Type: System.UInt64
The initialization vector if encryption has been used.
- client
Type: CloudBlobClient
The Azure client to access a blob.
- cancellationToken
Type: System.Threading.CancellationToken
The cancellation token to cancel the download operation.
- retryPolicy
Type: RetryPolicy
The RetryPolicy delegate returns a ShouldRetry delegate, which can be used to implement a custom retry policy. RetryPolicies class can be used to get default policies.
Return Value
Type: System.Threading.Tasks.Task
A task that downloads the specified blob.