Skip to main content

azblob

11 configuration options · available in Rust, Python, Node.js, Java

Quick start
use opendal::Operator;

let op = Operator::via_iter("azblob", [
    ("container".to_string(), "...".to_string()),
])?;
All configuration options (copy & trim)
Full reference
use opendal::Operator;

let op = Operator::via_iter("azblob", [
    // The root of Azblob service backend.
    //
    // All operations will happen under this root.
    // ("root".to_string(), "...".to_string()),

    // The container name of Azblob service backend.
    ("container".to_string(), "...".to_string()),

    // The endpoint of Azblob service backend.
    //
    // Endpoint must be full uri, e.g.
    //
    // - Azblob: `https://accountname.blob.core.windows.net`
    // - Azurite: `http://127.0.0.1:10000/devstoreaccount1`
    // ("endpoint".to_string(), "...".to_string()),

    // The account name of Azblob service backend.
    // ("account_name".to_string(), "...".to_string()),

    // The account key of Azblob service backend.
    // ("account_key".to_string(), "...".to_string()),

    // The encryption key of Azblob service backend.
    // ("encryption_key".to_string(), "...".to_string()),

    // The encryption key sha256 of Azblob service backend.
    // ("encryption_key_sha256".to_string(), "...".to_string()),

    // The encryption algorithm of Azblob service backend.
    // ("encryption_algorithm".to_string(), "...".to_string()),

    // The sas token of Azblob service backend.
    // ("sas_token".to_string(), "...".to_string()),

    // Skip signature will skip loading credentials and signing requests.
    // ("skip_signature".to_string(), "true".to_string()),

])?;

Every option is passed as a string key; OpenDAL parses it into the right type. Some services may require building the binding with the matching services-* feature enabled.

Configuration reference

General11
KeyTypeRequiredDescription
rootstringnoThe root of Azblob service backend. All operations will happen under this root.
containerstringyesThe container name of Azblob service backend.
endpointstringnoThe endpoint of Azblob service backend. Endpoint must be full uri, e.g. - Azblob: https://accountname.blob.core.windows.net - Azurite: http://127.0.0.1:10000/devstoreaccount1
account_namestringnoThe account name of Azblob service backend.
account_keystringnoThe account key of Azblob service backend.
encryption_keystringnoThe encryption key of Azblob service backend.
encryption_key_sha256stringnoThe encryption key sha256 of Azblob service backend.
encryption_algorithmstringnoThe encryption algorithm of Azblob service backend.
sas_tokenstringnoThe sas token of Azblob service backend.
batch_max_operationsdeprecatedintegernoDeprecated: Azblob delete batch capability is enabled by default with Azure Blob's 256-operation batch limit.
Deprecated since 0.57.0: Azblob delete batch capability is enabled by default with Azure Blob's 256-operation batch limit. Use CapabilityOverrideLayer to override delete_max_size for specific endpoints.
skip_signatureboolnoSkip signature will skip loading credentials and signing requests.