Description
Lists all blobs/files within a given container in the Azure Blob Storage account. It supports filtering by prefix (which can also be used to target a specific directory), and can include metadata, snapshots, versions, deleted blobs, tags, and control whether to return only files in a directory specified by prefix (not recursively). Optionally, authentication details can be provided to select the correct storage account identifier.
Parameters
| Name | Type | Comments | |
|---|---|---|---|
| containerName | String | The name of the container to list blobs from | |
| prefix | String, optional | The prefix to filter blobs by (eg. a directory path) | |
| includeMetadata | Boolean, optional | Whether to include metadata in the response | |
| includeSnapshots | Boolean, optional | Whether to include snapshots in the response | |
| includeVersions | Boolean, optional | Whether to include versions in the response | |
| includeDeleted | Boolean, optional | Whether to include deleted blobs | |
| includeTags | Boolean, optional | Whether to include tags in the response | |
| getFilesInDirectoryOnly | Boolean, optional | If true, only returns files directly in the specified directory as defined in the prefix parameter (non-recursive, uses Azure's delimiter/pseudo-directory feature) N.B. The prefix must have a trailing forward-slash e.g. "applications/" | |
| timeoutMs | Number, optional | Timeout in milliseconds before aborting the operation (default is 20000) | |
| authDetails | Object, optional | The authDetails set in the worker configuration to use. If not set the request will use the default authDetails | |
| authDetails.identifier | String | The identifier for the authentication details (used to select the correct connection string) | |
Example
{
"id": "123",
"jsonrpc": "2.0",
"method": "listBlobs",
"params": {
"containerName": "applications",
"prefix": "1111-2222-3333-4444/attachments/images/",
"includeMetadata": true,
"includeSnapshots": false,
"includeVersions": false,
"includeDeleted": false,
"includeTags": true,
"getFilesInDirectoryOnly": true,
"timeoutMs": 30000,
"authDetails": {
"identifier": "my-storage-account"
}
}
}
