Azure Blob Storage

Frends.AzureBlobStorage.DownloadBlob / 4.1.0

Summary

Copies a blob onto the agent's file system, deciding up front what should happen if a file of that name is already there.

Typical use — getting a file onto disk for a tool or Task that works with paths; use the read Task when the content is only needed in memory

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0
4.1.02026-08-21
Added
  • Added Options.CopyBlob, Options.BlobCopyDir, and Options.DeleteOriginal to support post-download blob copy and source cleanup in Azure Blob Storage.
4.0.02026-07-23
Changed
  • Breaking The Connection parameter tab now appears before Options in the task signature, matching the standard parameter order used across all Frends Azure Blob Storage tasks.
Fixed
  • Removed unsupported XML documentation tags to improve compatibility with the Frends task documentation system.

Upgrade instructions (3.x → 4.0)

  1. In any process using this task, re-map the Connection and Options parameter tabs — their order in the task configuration UI has swapped. No property values need to change; only the tab order is different.
3.0.02026-05-04
Changed
  • Breaking Replaced Source and Destination parameter tabs with unified Input and Options tabs.
  • Breaking Input.ActionOnExistingFile replaces Destination.FileExistsOperation; enum value Error renamed to Throw.
  • Breaking Input.TargetDirectory replaces Destination.Directory.
  • Breaking Options.Encoding replaces Source.Encoding; added UTF8WithBOM value; WINDOWS1252 renamed to Windows1252.
  • Breaking Options.OtherEncoding replaces Source.FileEncodingString; separate EnableBOM property removed (use UTF8WithBOM).
  • Breaking Result.FilePath replaces Result.FullPath; Result.FileName and Result.Directory removed.
Added
  • Added Result.Success (bool) and Result.Error properties.
  • Added Options.ThrowErrorOnFailure (default true) and Options.ErrorMessageOnFailure for non-throwing error handling.

Upgrade instructions (2.x → 3.0)

  1. Replace Source + Destination parameter tabs with Input + Options.
  2. Move Source.ContainerNameInput.ContainerName, Source.BlobNameInput.BlobName.
  3. Move Destination.DirectoryInput.TargetDirectory, Destination.TargetFileNameInput.TargetFileName.
  4. Move Destination.FileExistsOperationInput.ActionOnExistingFile; change FileExistsAction.ErrorFileExistsAction.Throw.
  5. Move Source.EncodingOptions.Encoding; change FileEncoding.WINDOWS1252FileEncoding.Windows1252; replace EnableBOM = true with FileEncoding.UTF8WithBOM.
  6. Move Source.FileEncodingStringOptions.OtherEncoding.
  7. Replace Result.FullPathResult.FilePath; remove usages of Result.FileName / Result.Directory.
  8. Optionally set Options.ThrowErrorOnFailure = false and check Result.Success / Result.Error instead of catching exceptions.
2.0.02026-04-26
Changed
  • Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.
1.7.02026-01-28
Added
  • Add options to support Arc Managed Identity authentication.
1.6.02026-01-27
Added
  • Added TargetFileName property to Destination for custom file naming when downloading blobs.
1.5.02026-01-15
Changed
  • Updated Azure packages to the latest versions:
  • Azure.Storage.Blobs 12.27.0
  • Azure.Identity 1.17.1
1.4.02025-02-17
Added
  • Added SAS Token authentication method.
1.3.02024-08-21
Changed
  • Updated Azure.Identity to version 1.12.0.
  • Removed dependencies Azure.Core and Azure.Storage.Common.
1.2.02024-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.12023-02-08
Fixed
  • Fixed issue with empty encoding parameter.
  • Memory leak fix by unloading assembly context after Task execution.
1.1.02022-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.22022-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.12022-02-28
Changed
  • Support for .NET Standard 2.0 removed.
1.0.02022-02-09
Added
  • Initial implementation of Frends.AzureBlobStorage.DownloadBlob.
An unhandled error has occurred. Reload 🗙