Toggle menu

FileToBlobStorage

Description

Uploads a file (provided as a Buffer or a base64-encoded string) as a blob in an Azure Blob Storage container. Optionally, authentication details can be provided to select the correct storage account identifier.

Parameters

NameTypeComments
containerNameStringThe name of the container that will contain the blob
blobNameStringThe name of the blob when it arrives in Blob Storage. If using pseudo-directories, the full path should defined here eg. "applications/1111-2222-3333-4444/attachments/images/my-image.jpg"
bufferBuffer | StringThe buffer or base64-encoded string to upload. If a string is provided, it will be converted to a buffer
metadataObject, optionalMetadata to associate with the blob in Azure Blob Storage
tagsObject, optionalTags to associate with the blob in Azure Blob Storage
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": "fileToBlobStorage",
    "params": {
        "containerName": "applications",
        "blobName": "1111-2222-3333-4444/attachments/images/my-image.jpg",
        "buffer": "base64string-thiswillbelarge",
        "metadata": { "fileUploaded": "2025-04-01T11:00:00.000Z" },
        "timeoutMs": 30000,
        "authDetails": {
            "identifier": "my-storage-account"
        }
    }
}

Last modified on 2 February 2026