Documentation CLI 0.1.1 · development llms.txt

coldctl destination add azure

Configure an Azure Blob archive destination.

ImplementedLocal destination configuration

Syntax

USAGE

coldctl destination add azure [OPTIONS] --name <NAME> --account <ACCOUNT> --container <CONTAINER>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--name <NAME>`	Unique destination name.
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--account <ACCOUNT>`	Azure storage account name.
`--container <CONTAINER>`	Existing private Blob container.
`--prefix <PREFIX>`	[default: coldctl]
`--endpoint <ENDPOINT>`	Optional HTTPS storage endpoint, or explicit loopback emulator URL.
`--staging-path <STAGING_PATH>`	Durable local staging directory; only pending batches remain here
`--account-key-env <ACCOUNT_KEY_ENV>`	[default: AZURE_STORAGE_ACCOUNT_KEY]
`--allow-http`	Permit HTTP only for an explicitly configured loopback emulator
`--managed-identity`	Use automatically refreshed cloud identity credentials (standard endpoints only)
`--managed-identity-client-id <MANAGED_IDENTITY_CLIENT_ID>`	Optional user-assigned Azure identity client UUID
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl destination add azure --name archives --account customerstorage --container archives

CLI

coldctl destination add azure --name archives --account customerstorage --container archives --managed-identity

Operational notes

Use --managed-identity on an Azure VM, optionally with --managed-identity-client-id for a user-assigned identity. Tokens refresh automatically. Otherwise credentials use the account-key environment reference. Provision storage separately and test access before archival. HTTP is limited to loopback emulators with static credentials.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Configure customer-owned Azure Blob Storage or Azurite

Usage: coldctl destination add azure [OPTIONS] --name <NAME> --account <ACCOUNT> --container <CONTAINER>

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --name <NAME>
          
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --account <ACCOUNT>
          
      --container <CONTAINER>
          
      --prefix <PREFIX>
          [default: coldctl]
      --endpoint <ENDPOINT>
          
      --staging-path <STAGING_PATH>
          Durable local staging directory; only pending batches remain here
      --account-key-env <ACCOUNT_KEY_ENV>
          [default: AZURE_STORAGE_ACCOUNT_KEY]
      --allow-http
          Permit HTTP only for an explicitly configured loopback emulator
      --managed-identity
          Use automatically refreshed cloud identity credentials (standard endpoints only)
      --managed-identity-client-id <MANAGED_IDENTITY_CLIENT_ID>
          Optional user-assigned Azure identity client UUID
  -h, --help
          Print help