Toggle menu

ListContainers

Description

Connects to an Azure Blob Storage account and retrieves the list of all containers in the account. It is typically used to enumerate available storage containers for further operations such as listing blobs, uploading, or downloading files.

Parameters

NameTypeComments
prefixString, optionalPrefix to filter containers by name (default is empty string)
includeMetadataBoolean, optionalWhether to include container metadata in the response (default is false)
timeoutMsNumber, optionalTimeout in milliseconds before aborting the operation (default is 20000)
authDetailsObject, optionalThe authDetails set in the worker configuration to use. If not set the request will use the default authDetails
authDetails.identifierStringThe identifier for the authentication details (used to select the correct connection string)

Example

{
    "id": "123",
    "jsonrpc": "2.0",
    "method": "listContainers",
    "params": {
        "prefix": "applications/",
        "includeMetadata": true,
        "timeoutMs": 30000,
        "authDetails": {
            "identifier": "my-storage-account"
        }
    }
}

Last modified on 22 July 2025