BlobContainerClientExtensions.StartDownloadToDirectoryAsync Method

Definition

Namespace:

Azure.Storage.Blobs

Assembly:

Azure.Storage.DataMovement.Blobs.dll

Package:

Azure.Storage.DataMovement.Blobs v12.0.0-beta.4

Overloads

StartDownloadToDirectoryAsync(BlobContainerClient, String, BlobContainerClientTransferOptions)	Downloads the contents of a blob container.
StartDownloadToDirectoryAsync(BlobContainerClient, String, String)	Downloads the contents of a blob container.

StartDownloadToDirectoryAsync(BlobContainerClient, String, BlobContainerClientTransferOptions)

Source:

BlobContainerClientExtensions.cs

Downloads the contents of a blob container.

public static System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer> StartDownloadToDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions options);

static member StartDownloadToDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions -> System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer>

<Extension()>
Public Function StartDownloadToDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, options As BlobContainerClientTransferOptions) As Task(Of DataTransfer)

Parameters

client

BlobContainerClient

The BlobContainerClient used for service operations.

localDirectoryPath

String

The full path to the local directory where files will be dowloaded.

options

BlobContainerClientTransferOptions

Options which control the container download.

Returns

Task<DataTransfer>

StartDownloadToDirectoryAsync(BlobContainerClient, String, String)

Source:

BlobContainerClientExtensions.cs

Downloads the contents of a blob container.

public static System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer> StartDownloadToDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, string blobDirectoryPrefix = default);

static member StartDownloadToDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * string -> System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer>

<Extension()>
Public Function StartDownloadToDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, Optional blobDirectoryPrefix As String = Nothing) As Task(Of DataTransfer)

Parameters

client

BlobContainerClient

The BlobContainerClient used for service operations.

localDirectoryPath

String

The full path to the local directory where files will be dowloaded.

blobDirectoryPrefix

String

Optionally restricts the downloaded content to blobs with the specified directory prefix.

Returns

Task<DataTransfer>