Skip to main content

azdls

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

Quick start
use opendal::Operator;

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

let op = Operator::via_iter("azdls", [
// Root of this backend.
// ("root".to_string(), "...".to_string()),

// Filesystem name of this backend.
("filesystem".to_string(), "...".to_string()),

// Endpoint of this backend.
// ("endpoint".to_string(), "...".to_string()),

// Account name of this backend.
// ("account_name".to_string(), "...".to_string()),

// Account key of this backend.
// - required for shared_key authentication
// ("account_key".to_string(), "...".to_string()),

// client_secret
// The client secret of the service principal.
// - required for client_credentials authentication
// ("client_secret".to_string(), "...".to_string()),

// tenant_id
// The tenant id of the service principal.
// - required for client_credentials authentication
// ("tenant_id".to_string(), "...".to_string()),

// client_id
// The client id of the service principal.
// - required for client_credentials authentication
// ("client_id".to_string(), "...".to_string()),

// sas_token
// The shared access signature token.
// - required for sas authentication
// ("sas_token".to_string(), "...".to_string()),

// authority_host
// The authority host of the service principal.
// - required for client_credentials authentication
// - default value: `https://login.microsoftonline.com`
// ("authority_host".to_string(), "...".to_string()),

// Whether hierarchical namespace (HNS) is enabled for the storage account.
// When enabled, recursive deletion can use pagination to avoid timeouts on large directories.
// - default value: `false`
// ("enable_hns".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
rootstringnoRoot of this backend.
filesystemstringyesFilesystem name of this backend.
endpointstringnoEndpoint of this backend.
account_namestringnoAccount name of this backend.
account_keystringnoAccount key of this backend. - required for shared_key authentication
client_secretstringnoclient_secret The client secret of the service principal. - required for client_credentials authentication
tenant_idstringnotenant_id The tenant id of the service principal. - required for client_credentials authentication
client_idstringnoclient_id The client id of the service principal. - required for client_credentials authentication
sas_tokenstringnosas_token The shared access signature token. - required for sas authentication
authority_hoststringnoauthority_host The authority host of the service principal. - required for client_credentials authentication - default value: https://login.microsoftonline.com
enable_hnsboolnoWhether hierarchical namespace (HNS) is enabled for the storage account. When enabled, recursive deletion can use pagination to avoid timeouts on large directories. - default value: false