Azure storage profile

Overview

storage-azure declares an Azure account and exactly one credential shape for backup and replication attachments.

Example configuration

account_name: exampleaccount                # Required: replace with your account.
account_key: "${env:AZURE_STORAGE_KEY}"      # Example: select account-key auth.
sas_token: null                             # Default: no SAS credential.
service_principal: null                     # Default: no application credential.
timeout: null                               # Default: object_store client timeout.

# Choose exactly one credential variant.
# For SAS auth, set account_key to null and sas_token to "${env:AZURE_STORAGE_SAS}".
# For application auth, keep both scalar credentials null and replace
# service_principal: null with:
# service_principal:
#   tenant_id: "${env:AZURE_TENANT_ID}"          # Required.
#   client_id: "${env:AZURE_CLIENT_ID}"          # Required.
#   client_secret: "${env:AZURE_CLIENT_SECRET}"  # Required.

Use and behavior

Install with pond mknod storage-azure /etc/azure --config-path azure.yaml. Reference it as storage: /etc/azure in a declarative attachment using an az://CONTAINER/PREFIX URL.

Choose exactly one of account_key, sas_token, or service_principal. Credential fields must be environment references. Real account, container, and cloud authorization are prerequisites.

Full configuration

Settings

FieldAccepted typeRequiredDefaultDescription
account_keystring | nullnonot specifiedShared account key. Must be an ${env:...} reference (Decision A1).
account_namestringyesnot specifiedStorage account name, e.g. casparwater. Required: an Azure profile without an account names nothing. Not a credential (see module docs).
sas_tokenstring | nullnonot specifiedShared access signature token. Must be an ${env:...} reference.
service_principalService Principal | nullnonot specifiedAzure AD application credentials. Each field must be an ${env:...} reference.
timeoutstring | nullnonot specifiedPer-request HTTP timeout accepted by object_store (for example 2m). Azure multipart uploads can otherwise exceed the 30-second default on a constrained uplink when several parts are in flight.

Service Principal

An Azure AD service principal: the credential shape used when a pond authenticates as an application rather than with a shared secret.

FieldAccepted typeRequiredDefaultDescription
client_idstringyesnot specifiedApplication (client) id. Must be an ${env:...} reference.
client_secretstringyesnot specifiedClient secret. Must be an ${env:...} reference.
tenant_idstringyesnot specifiedDirectory (tenant) id. Must be an ${env:...} reference.