ShareDirectoryClientExtensions.StartDownloadToDirectoryAsync Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.DataMovement.Files.Shares.dll

Package:

Azure.Storage.DataMovement.Files.Shares v12.0.0-beta.1

Source:

ShareDirectoryClientExtensions.cs

Downloads the contents of a share directory.

public static System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer> StartDownloadToDirectoryAsync (this Azure.Storage.Files.Shares.ShareDirectoryClient client, string localDirectoryPath, Azure.Storage.DataMovement.Files.Shares.ShareDirectoryClientTransferOptions options = default);

static member StartDownloadToDirectoryAsync : Azure.Storage.Files.Shares.ShareDirectoryClient * string * Azure.Storage.DataMovement.Files.Shares.ShareDirectoryClientTransferOptions -> System.Threading.Tasks.Task<Azure.Storage.DataMovement.DataTransfer>

<Extension()>
Public Function StartDownloadToDirectoryAsync (client As ShareDirectoryClient, localDirectoryPath As String, Optional options As ShareDirectoryClientTransferOptions = Nothing) As Task(Of DataTransfer)

Parameters

client

ShareDirectoryClient

The ShareDirectoryClient used for service operations.

localDirectoryPath

String

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

options

ShareDirectoryClientTransferOptions

Options which control the container download.

Returns

Task<DataTransfer>