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

ListBlobsInContainer

List blobs and directories from the Azure Blob Storage container.

Task version: 2.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ContainerName : String

The name of the blob container in the storage account.

Default: - Example: ExampleContainer

Name
Description

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

Name
Description

ListingStructure : ListingStructure

List blobs in a flat listing structure or hierarchically.

Hierarchical listing returns container's blobs and subdirectories names such as file.txt or directoryname/.

Flat listing does the same as hierarchical listing but also returns blobs in those subdirectories such as directoryname/file.txt.

Possible values:

  • Flat: List blobs in a flat listing structure or hierarchically.

Hierarchical listing returns container's blobs and subdirectories names such as file.txt or directoryname/.

Flat listing does the same as hierarchical listing but also returns blobs in those subdirectories such as directoryname/file.txt.

  • Hierarchical: List blobs in a flat listing structure or hierarchically.

Hierarchical listing returns container's blobs and subdirectories names such as file.txt or directoryname/.

Flat listing does the same as hierarchical listing but also returns blobs in those subdirectories such as directoryname/file.txt.

Default: 0 Example: ListingStructure.Flat

Prefix : String

Specify a prefix to return blobs whose names begin with that character or string.

Default: - Example: test

Task Result

Name
Description

BlobList : List<BlobData>

List of blobs. Example: [ { Type = Block, Name = file.txt, URL = https://storageaccount.blob.core.windows.net/containername/file.txt, ETag = 0x8D6FACDEB709651, CreatedOn = 2023-12-11T09:00:00.743185+02:00, LastModified = 2023-12-11T09:00:00.743185+02:00 } ]

Task Changelog

Changelog for Task Frends.AzureBlobStorage.ListBlobsInContainer.

[2.0.0] - 2026-04-26

Changed

  • Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.

[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.

Changed

  • Fixed outdated environment variable names in tests and workflows.

[1.1.2] - 2024-01-17

Updated

  • Azure.Identity from 1.8.1 to 1.10.2

  • Azure.Storage.Blobs from 12.11.0 to 12.13.0

Fixed

  • Documentation fixes.

  • Changed the Task to throw ArgumentException instead of generic Exception.

[1.1.1] - 2023-12-11

Added

  • Result.CreatedOn.

  • Result.LastModified.

[1.1.0] - 2023-02-01

Added

  • OAuth2 authentication method.

Changed

  • Rename: Result.URI to Result.URL.

Fixed

  • Memory leak fix by unloading assembly context after Task execution.

  • Result.URL returns complete URL to each blob.

[1.0.0] - 2022-04-14

Added

  • Initial implementation

Last updated

Was this helpful?