For the complete documentation index, see llms.txt. This page is also available as Markdown.

DownloadFiles

Downloads files from Azure Data Lake.

Task version: 1.2.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ConnectionMethod : ConnectionMethod

Which connection method should be used for connecting to Azure Data Lake.

Possible values:

  • ConnectionString: Which connection method should be used for connecting to Azure Data Lake.

  • OAuth2: Which connection method should be used for connecting to Azure Data Lake.

Default: 1 Example: ConnectionMethod.ConnectionString

🗝ConnectionString : String

Connection string to Azure Data Lake.

Default: - Example: DefaultEndpointsProtocol=https;AccountName=accountname;AccountKey=Pdlrxyz==;EndpointSuffix=core.windows.net

StorageAccountName : String

Name of the Azure Data Lake account.

Default: - Example: storageexample

ApplicationID : String

Application (Client) ID of Azure AD Application.

Default: - Example: Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f

TenantID : String

Tenant ID of Azure Tenant.

Default: - Example: Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f

🗝ClientSecret : String

Client Secret of Azure AD Application.

Default: - Example: Password!

ContainerName : String

Name of the Azure Data Lake container where the data will be uploaded.

Naming: lowercase

Valid chars: alphanumeric and dash, but cannot start or end with dash.

Default: test-container Example: test-container

FilePattern : String

Path of file(s) you want to download from DataLake

This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions

Default: .txt Example: .txt

Name
Description

Directory : String

Destination directory.

Default: - Example: c:\temp

Overwrite : Boolean

How the existing file will be handled.

Default: False Example: true

Name
Description

ThrowErrorOnFailure : Boolean

True: Throw an exception.

False: Return Result with IsSucces=false and ErrorMessage with description of exception.

Default: True Example: true

Task Result

Name
Description

IsSuccess : Boolean

Operation complete. Operation is seens as completed if all desired files was downloaded. Example: true

DownladedFiles : Dictionary<String, String>

This object contains the source file URL as a key and the path of the downloaded file as a value. If overwrite is disabled, error message will be placed as a value Example: { {https://storage.blob.core.windows.net/container/examplefile.txt, c:\temp\examplefile.txt }, { https://storage.blob.core.windows.net/container/examplefile2.txt, File examplefile2 already exists. } }

ErrorMessage : String

This object contains the error message if task fails. Example: Container ex does not exist

Task Changelog

Changelog for Task Frends.AzureDataLake.DownloadFiles.

[1.2.0] - 2026-01-15

Changed

  • Updated Azure packages to latest versions:

  • Azure.Storage.Files.DataLake 12.25.0

  • Azure.Identity 1.17.1

[1.1.0] - 2024-08-23

Changed

  • Updated the Azure.Identity package to version 1.12.0.

[1.0.0] - 2024-05-17

Added

  • Initial implementation of Frends.AzureDataLake.DownloadFiles.

Last updated

Was this helpful?