For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Azure blob storage connector

The Azure Blob Storage connector is an outbound connector that allows you to interact with Azure Blob Storage resources from your BPMN processes.

The Azure Blob Storage connector currently supports uploading and downloading documents.

Prerequisites​

To begin using the Azure Blob Storage connector, ensure you have created the following resources:

Authentication​

Create a new connector secret​

Keep your secrets secure by avoiding direct inclusion in the BPMN xml file. Instead, create a secret:

  1. Follow our guide for creating secrets.
  2. Name your secrets (for example, AZURE_SAS_TOKEN) so you can reference them later in the connector configuration.

OAuth 2.0​

  1. In the Azure Portal, open Microsoft Entra ID and select + Add > App registration to create a new app registration.
    • Note the client ID and tenant ID from the app registration’s Overview tab.
  2. Go to Manage > Certificates & secrets, select + New client secret, and copy the Value (this is your client secret).
  3. In Blob Storage, open your container, select Access control (IAM) > Add > Add role assignment, and assign the app registration one of the following roles:
    • Storage Blob Data Contributor
    • Storage Blob Data Reader
  4. In the connector configuration, enter the following details:
    • Client ID – Client ID of the app registration
    • Tenant ID – Tenant ID of the app registration
    • Client Secret – Client secret value of the app registration
    • Account URL – URL of the storage account, for example:
      https://<storage_account_name>.blob.core.windows.net/
      Replace <storage_account_name> with your actual storage account name.

SAS token​

  1. In the Azure Portal, open your Storage account > Containers, and select your container.
  2. From the container’s toolbar, click Generate SAS.
  3. In the connector configuration, enter the SAS token and SAS URL.

Operation​

Select the desired operation from the Operation dropdown.

Upload document​

  1. Enter the Container name — it must match the container the SAS token was created for.
  2. (Optional) Enter the File name. If left blank, the filename from the document metadata will be used.
  3. Select a document source for the Document to upload: a Camunda document reference, inline content built from process data, or an external document URL.
note

Use inline content to build a file (for example, a .json file) directly from process variables without first storing it in the Camunda document store. See inline documents.

If an uploaded document already exists in the container with the same name, it will be overwritten. Depending on the settings made on the Azure Storage Account, the previous version of the document may still be accessible in the file version history.

Download document​

  1. Enter the Container name — it must match the container the SAS token was created for.
  2. Enter the File name to download.
  3. Select a return format for the downloaded content:
    • Document reference: a reference to a document created in the Camunda document store is returned in document.
    • As text: the content is decoded to a string (with an optional encoding, default UTF-8) and returned in content.
    • As JSON: the content is parsed as JSON and returned in content.
note

As text and As JSON return the content directly in a process variable and are subject to a size guard (approximately 1.5 MiB); use Document reference for large files. As JSON fails the job when the content is not valid JSON.