Toggle menu

GetBlobProperties

Description

Connects to an Azure Blob Storage account using a connection string and retrieves the properties and metadata of a specified blob within a container. It supports optional authentication details and a configurable timeout.

Parameters

NameTypeComments
containerNameStringThe name of the container containing the blob
blobNameStringThe name of the blob whose properties and metadata are to be retrieved
timeoutMsNumber, optional

Timeout 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": "getBlobProperties",
    "params": {
        "containerName": "applications",
        "blobName": "1111-2222-3333-4444/attachments/images/my-image.jpg"
        "timeoutMs": 30000,
        "authDetails": {
            "identifier": "my-storage-account"
        }
    }
}

Last modified on 22 July 2025