ReadBlob
Frends Task for encoding and reading a single blob from Azure Storage.
Task version: 3.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
ContainerName : String
Azure storage container's name.
Default: -
Example: Container1
BlobName : String
Name of the blob which content is read.
Default: -
Example: File.txt
AuthenticationMethod : ConnectionMethod
Defines which connection method should be used for connecting to Azure Blob Storage.
Possible values:
ConnectionString: Defines which connection method should be used for connecting to Azure Blob Storage.OAuth2: Defines which connection method should be used for connecting to Azure Blob Storage.SasToken: Defines which connection method should be used for connecting to Azure Blob Storage.ArcManagedIdentity: Defines which connection method should be used for connecting to Azure Blob Storage.ArcManagedIdentityCrossTenant: 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
Encoding : Encode
Encoding name in which blob content is read.
Possible values:
UTF8: Encoding name in which blob content is read.UTF32: Encoding name in which blob content is read.Unicode: Encoding name in which blob content is read.ASCII: Encoding name in which blob content is read.
Default: 0
Example: UTF8
ThrowErrorOnFailure : Boolean
Whether to throw an exception on task failure. When false, errors are returned in the result's Error property.
Default: True
Example: true
ErrorMessageOnFailure : String
Custom error message prefix used when an exception is thrown or returned. If empty, the original exception message is used.
Default: -
Example: ReadBlob failed
Task Result
Success : Boolean
Indicates whether the task completed successfully.
Example: true
Content : String
Encoded blob content.
Example: "line1\r\nline2\r\nline3"
Error : Error
Error details when Success is false. object { string Message, object AdditionalInfo }
Example: null
Task Changelog
Changelog for Task Frends.AzureBlobStorage.ReadBlob.
[3.0.0] - 2026-05-04
Changed
[Breaking] Renamed
Sourcetab toInputtab; move task parameter references fromSourcetoInputwhen upgrading.
Added
Added
Options.ThrowErrorOnFailure(default:true) — whenfalse, errors are returned in the result instead of thrown.Added
Options.ErrorMessageOnFailure— custom error message prefix for thrown exceptions or returned errors.Added
Result.Success(bool) —trueon success,falseon failure.Added
Result.Error(object{ string Message, object AdditionalInfo }) — populated on failure whenThrowErrorOnFailureisfalse.
Upgrade instructions
Replace any usage of the
Sourcetab/class withInput. The propertiesContainerNameandBlobNameremain unchanged.
[2.0.0] - 2026-04-26
Changed
Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.
[1.4.0] - 2026-01-23
Added
Add options to support Arc Managed Identity authentication.
[1.3.0] - 2026-01-15
Changed
Updated Azure packages to the latest versions:
Azure.Storage.Blobs 12.27.0
Azure.Identity 1.17.1
[1.2.0] - 2024-08-21
Updated
Updated Azure.Identity to version 1.12.0.
[1.1.1] - 2024-01-31
Updated
Azure.Identity to version 1.10.4
Azure.Storage.Blobs to version 12.19.1
[1.1.0] - 2022-12-16
Added
OAuth2 as a new additional authentication method.
Changed
Dependency update: Removed dependencies: System.ComponentModel.Annotations Azure.Core Azure.Storage.Common
Added dependencies: Azure.Identity 1.8.0
Update dependencies: Azure.Storage.Blobs 12.13.1 to 12.14.1
[1.0.0] - 2022-04-08
Added
Initial implementation
Last updated
Was this helpful?