# DownloadBlob Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: Source" %} | Name | Description | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ContainerName : `String` |

Name of the Azure Blob Storage container where the file is downloaded from.


Default: -
Example: ExampleContainer

| | BlobName : `String` |

Name of the blob to download.


Default: -
Example: sample.txt

| | Encoding : `FileEncoding` |

Set desired content-encoding.

Defaults to UTF8 BOM.

Possible values:

Set desired content-encoding.

Defaults to UTF8 BOM.

Set desired content-encoding.

Defaults to UTF8 BOM.

Set desired content-encoding.

Defaults to UTF8 BOM.

Set desired content-encoding.

Defaults to UTF8 BOM.

Set desired content-encoding.

Defaults to UTF8 BOM.


Default: 0
Example: utf8

| | EnableBOM : `Boolean` |

Enables BOM for UTF-8.


Default: True
Example: -

| | FileEncodingString : `String` |

Content encoding as string. A partial list of possible encodings: .


Default: -
Example: windows-1252

| | {% endtab %} | | {% tab title="Parameter: Destination" %} | Name | Description | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Directory : `String` |

Destination directory.


Default: -
Example: c:\temp

| | FileExistsOperation : `FileExistsAction` |

Error: Throws exception if destination file exists.

Rename: Adds '(1)' at the end of file name. Incerements the number if (1) already exists.

Overwrite: Overwrites existing file.

Possible values:

Error: Throws exception if destination file exists.

Rename: Adds '(1)' at the end of file name. Incerements the number if (1) already exists.

Overwrite: Overwrites existing file.

Error: Throws exception if destination file exists.

Rename: Adds '(1)' at the end of file name. Incerements the number if (1) already exists.

Overwrite: Overwrites existing file.

Error: Throws exception if destination file exists.

Rename: Adds '(1)' at the end of file name. Incerements the number if (1) already exists.

Overwrite: Overwrites existing file.


Default: 0
Example: Error

| | TargetFileName : `String` |

Optional custom filename for the downloaded blob. If not specified, the original blob name will be used.


Default: -
Example: customname.txt

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | AuthenticationMethod : `ConnectionMethod` |

Defines which connection method should be used for connecting to Azure Blob Storage.

Possible values:

Defines which connection method should be used for connecting to Azure Blob Storage.

Defines which connection method should be used for connecting to Azure Blob Storage.

Defines which connection method should be used for connecting to Azure Blob Storage.

Defines which connection method should be used for connecting to Azure Blob Storage.

Defines which connection method should be used for connecting to Azure Blob Storage.


Default: 1
Example: ConnectionMethod.ConnectionString

| | 🗝ConnectionString : `String` |

Connection string to Azure storage.


Default: -
Example: DefaultEndpointsProtocol=https;AccountName=account-name;AccountKey=abc==;EndpointSuffix=core.windows.net

| | ApplicationId : `String` |

Application (Client) ID of Azure AD Application.


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

| | TenantId : `String` |

Tenant ID of Azure Tenant.


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

| | 🗝ClientSecret : `String` |

Client Secret of Azure AD Application.


Default: -
Example: Password!

| | 🗝SasToken : `String` |

A shared access signature to use when connecting to an Azure storage container.

Grants restricted access rights to Azure Storage resources when combined with URI.


Default: -
Example: sv=2021-04-10\&se=2022-04-10T10%3A431Z\&sr=c\&sp=l\&sig=ZJg983RovE%23ZXI

| | StorageAccountName : `String` |

Name of the Azure storage account.


Default: -
Example: TestStorage

| | Scopes : `String[]` |

Scopes used when authenticating with Arc Managed Identity Cross Tenant.


Default: -
Example: \[api://AzureADTokenExchange/.default]

| | TargetTenantId : `String` |

Target Tenant ID of Azure Tenant.


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

| | TargetClientId : `String` |

Target Client ID of Azure Tenant.


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

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | -------------------- | ------------------------------------------------------------------------------------ | | FileName : `String` |

Name of the downloaded file.
Example: sample.txt

| | Directory : `String` |

Directory where the file was downloaded.
Example: c:\temp

| | FullPath : `String` |

Full path to the downloaded file.
Example: c:\temp\sample.txt

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.0.0] - 2026-04-26 #### Changed * Standardized parameter names and validation across all Azure Blob Storage tasks for consistency. ### \[1.7.0] - 2026-01-28 #### Added * Add options to support Arc Managed Identity authentication. ### \[1.6.0] - 2026-01-27 #### Added * Added TargetFileName property to Destination for custom file naming when downloading blobs. ### \[1.5.0] - 2026-01-15 #### Changed * Updated Azure packages to the latest versions: * Azure.Storage.Blobs 12.27.0 * Azure.Identity 1.17.1 ### \[1.4.0] - 2025-02-17 #### Added * Added SAS Token authentication method. ### \[1.3.0] - 2024-08-21 #### Changed * Updated Azure.Identity to version 1.12.0. * Removed dependencies Azure.Core and Azure.Storage.Common. ### \[1.2.0] - 2024-01-31 #### Updated * Azure.Identity to version 1.10.4 * Azure.Storage.Blobs to version 12.19.1 * Azure.Storage.Common to version 12.18.1 * Azure.Core to version 1.36.0 * MimeMapping to version 1.0.1.50 #### Fixed * \[Breaking] Fixed Source parameters to be similar to the UploadFiles Task. ### \[1.1.1] - 2023-02-08 #### Fixed * Fixed issue with empty encoding parameter. * Memory leak fix by unloading assembly context after Task execution. ### \[1.1.0] - 2022-12-01 #### Added * OAuth autentication method #### Changed * Security updated for dependency: * Azure.Storage.Blobs 12.13.1 to 12.14.1 * Azure.Storage.Common 12.12.0 to 12.13.0 * Azure.Core 1.25.0 to 1.26.0 ### \[1.0.2] - 2022-09-02 #### Changed * Security updated for dependency: * Azure.Storage.Blobs 12.10.0 to 12.13.1 * Also updated dependencies: * Azure.Storage.Common 12.9.0 to 12.12.0 * Azure.Core 1.20.0 to 1.25.0 * System.ComponentModel.Annotations 4.7.0 to 5.0.0 ### \[1.0.1] - 2022-02-28 #### Changed * Support for .NET Standard 2.0 removed. ### \[1.0.0] - 2022-02-09 #### Added * Initial implementation of Frends.AzureBlobStorage.DownloadBlob. {% endtab %} {% endtabs %}