Azure Blob Storage

First time creating a connector? Read this first.

Ingest your files into Unstructured from Azure Blob Storage.

Requirements

You will need: The following video shows how to fulfill the minimum set of Azure Storage account requirements:

If you are generating an SAS token as shown in the preceding video, be sure to set the following permissions:

Read and List for reading from the container only.
Write and List for writing to the container only.
Read, Write, and List for both reading from and writing to the container.

Here are some more details about these requirements:

An Azure account. To create one, learn how.
An Azure Storage account, and a container within that account. Create a storage account. Create a container.
The Azure Storage remote URL, using the format az://<container-name>/<path/to/file/or/folder/in/container/as/needed> For example, if your container is named my-container, and there is a folder in the container named my-folder, the Azure Storage remote URL would be az://my-container/my-folder/.
An SAS token (recommended), access key, or connection string for the Azure Storage account. Create an SAS token (recommended). Get an access key. Get a connection string. Create an SAS token (recommended):
Get an access key or connection string:

Examples

To create an Azure Blob Storage source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="azure",
                config={
                    "remote_url": "az://<container-name>/<path/to/file/or/folder>",
                    "recursive": <True|False>,

                    # For anonymous authentication, omit the following auth keys.
                    
                    # For SAS token authentication:
                    # "account_name": "<account-name>",
                    # "sas_token": "<sas-token>",

                    # For account key authentication:
                    # "account_name": "<account-name>",
                    # "account_key": "<account-key>",

                    # For connection string authentication:
                    # "connection_string": "<connection-string>"
                }
            )
        )
    )

    print(response.source_connector_information)

curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/sources" \
--header 'accept: application/json' \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'content-type: application/json' \
--data \
'{
    "name": "<name>",
    "type": "azure",
    "config": {
        "remote_url": "az://<container-name>/<path/to/file/or/folder>",
        "recursive": <true|false>,
    
        # For anonymous authentication, do not set any of the 
        # following fields.

        # For SAS token authentication:
        "account_name": "<account-name>",
        "sas_token": "<sas-token>"

        # For account key authentication:
        "account_name": "<account-name>",
        "account_key": "<account-key>"

        # For connection string authentication:
        "connection_string": "<connection-string>"
    }
}'

Configuration settings

Replace the preceding placeholders as follows:

string

required

A unique name for this connector.

string

required

The Azure Storage remote URL, with the format az://<container-name>/<path/to/file/or/folder/in/container/as/needed>. For example, if your container is named my-container, and there is a folder in the container named my-folder, the Azure Storage remote URL would be az://my-container/my-folder/.

string

The Azure Storage account name. Required for SAS token authentication and account key authentication.

string

required

For SAS token authentication, the SAS token for the Azure Storage account.

string

required

For account key authentication, the key for the Azure Storage account.

string

required

For connection string authentication, the connection string for the Azure Storage account.

boolean

default:"false"

Source connector only. Set to true to recursively access files from subfolders within the container.

Unstructured API

Workflow Operations

API Reference

Legacy APIs

Troubleshooting

Requirements

Examples

Configuration settings

​Requirements

​Examples

​Configuration settings

Requirements

Examples

Configuration settings