ListContainers
Frends Task to list all containers in the specified Azure Blob Storage account.
Task version: 2.1.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.AzureBlobStorage/tree/main/Frends.AzureBlobStorage.ListContainers
Task Parameters
States : ContainerStateFilter
Flags indicating which container states to include when listing (e.g. deleted or system containers).
Possible values:
None: No filtering; only normal containers are returned.System: Include system containers (e.g., $logs, $web).Deleted: Include soft-deleted containers.
Default: None
Example: ContainerStateFilter.Deleted
Prefix : String
Filter by container name prefix. Only containers starting with this value will be returned.
Default: -
Example: "test-"
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: ConnectionString
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
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates if the task completed successfully.
Example: true
Containers : List<ContainerInfo>
List of containers returned by the operation.
Example: [ { "Name": "test-container", "PublicAccess": "Private", "LastModified": "2025-01-15T10:23:45Z", "ETag": "0x8D12345ABCDEFF", "LeaseStatus": "Unlocked", "LeaseState": "Available" } ]
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Error.Message : String
Summary of the error.
Example: Failed to list containers.
Error.AdditionalInfo : Exception
Additional information about the error.
Example: object { Exception = new ArgumentException("Settings must be of the form 'name=value'.") }}
Task Changelog
Changelog for Task Frends.AzureBlobStorage.ListContainers.
[2.1.0] - 2026-07-17
Changed
Updated package copyright metadata to comply with Frends standards.
[2.0.0] - 2026-04-26
Changed
Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.
[1.2.0] - 2026-01-23
Added
Add options to support Arc Managed Identity authentication.
[1.1.0] - 2026-01-15
Changed
Updated Azure packages to the latest versions:
Azure.Storage.Blobs 12.27.0
Azure.Identity 1.17.1
[1.0.0] - 2025-10-13
Added
Initial implementation
Last updated
Was this helpful?