A modern, self-hosted backup solution for secure, encrypted backups across local and cloud storage.
const azureblobSettings = [
{
label: 'Storage Account Name',
value: 'account',
fieldType: 'string',
authFieldType: 'client',
required: true,
default: '',
description: 'Azure Storage Account Name. Set this to the Azure Storage Account Name in use.',
command: '--azureblob-account',
},
{
label: 'Storage Account Key',
value: 'key',
fieldType: 'password',
authFieldType: 'client',
required: true,
default: '',
description: 'Storage Account Shared Key. Leave blank to use SAS URL or Emulator.',
command: '--azureblob-key',
},
{
label: 'Environment Auth',
value: 'env_auth',
fieldType: 'bool',
required: false,
default: false,
description:
'Read credentials from runtime (environment variables, CLI or MSI). See the authentication docs for full info.',
command: '--azureblob-env-auth',
},
{
label: 'SAS URL',
value: 'sas_url',
fieldType: 'string',
required: false,
default: '',
description:
'SAS URL for container level access only. Leave blank if using account/key or Emulator.',
command: '--azureblob-sas-url',
},
{
label: 'Tenant ID',
value: 'tenant',
fieldType: 'string',
required: false,
default: '',
description: "ID of the service principal's tenant, also called its directory ID.",
command: '--azureblob-tenant',
},
{
label: 'Client ID',
value: 'client_id',
fieldType: 'string',
required: false,
default: '',
description: 'The ID of the client in use.',
command: '--azureblob-client-id',
},
{
label: 'Client Secret',
value: 'client_secret',
fieldType: 'password',
required: false,
authFieldType: 'all',
default: '',
description: "One of the service principal's client secrets.",
command: '--azureblob-client-secret',
},
{
label: 'Client Certificate Path',
value: 'client_certificate_path',
fieldType: 'string',
required: false,
default: '',
description: 'Path to a PEM or PKCS12 certificate file including the private key.',
command: '--azureblob-client-certificate-path',
},
{
label: 'Client Certificate Password',
value: 'client_certificate_password',
fieldType: 'password',
required: false,
authFieldType: 'all',
default: '',
description: 'Password for the certificate file (optional).',
command: '--azureblob-client-certificate-password',
},
{
label: 'Send Certificate Chain',
value: 'client_send_certificate_chain',
fieldType: 'bool',
required: false,
default: false,
description:
'Send the certificate chain when using certificate auth. Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to true, authentication requests include the x5c header.',
command: '--azureblob-client-send-certificate-chain',
},
{
label: 'Username',
value: 'username',
fieldType: 'string',
required: false,
default: '',
description: 'User name (usually an email address).',
command: '--azureblob-username',
},
{
label: 'Password',
value: 'password',
fieldType: 'password',
required: false,
authFieldType: 'all',
default: '',
description: "The user's password.",
command: '--azureblob-password',
},
{
label: 'Service Principal File',
value: 'service_principal_file',
fieldType: 'string',
required: false,
default: '',
description:
'Path to file containing credentials for use with a service principal. Leave blank normally. Needed only if you want to use a service principal instead of interactive login.',
command: '--azureblob-service-principal-file',
},
{
label: 'Disable Instance Discovery',
value: 'disable_instance_discovery',
fieldType: 'bool',
required: false,
default: false,
description:
'Skip requesting Microsoft Entra instance metadata This should be set true only by applications authenticating in disconnected clouds, or private clouds such as Azure Stack.',
command: '--azureblob-disable-instance-discovery',
},
{
label: 'Use MSI',
value: 'use_msi',
fieldType: 'bool',
required: false,
default: false,
description:
'Use a managed service identity to authenticate (only works in Azure). When true, use a managed service identity to authenticate to Azure Storage instead of a SAS token or account key.',
command: '--azureblob-use-msi',
},
{
label: 'MSI Object ID',
value: 'msi_object_id',
fieldType: 'string',
required: false,
default: '',
description:
'Object ID of the user-assigned MSI to use, if any. Leave blank if MSI Client ID or MSI Resource ID is specified.',
command: '--azureblob-msi-object-id',
condition: [{ use_msi: true }],
},
{
label: 'MSI Client ID',
value: 'msi_client_id',
fieldType: 'string',
required: false,
default: '',
description:
'Client ID of the user-assigned MSI to use, if any. Leave blank if MSI Object ID or MSI Resource ID is specified.',
command: '--azureblob-msi-client-id',
condition: [{ use_msi: true }],
},
{
label: 'MSI Resource ID',
value: 'msi_mi_res_id',
fieldType: 'string',
required: false,
default: '',
description:
'Azure resource ID of the user-assigned MSI to use, if any. Leave blank if MSI Client ID or MSI Object ID is specified.',
command: '--azureblob-msi-mi-res-id',
condition: [{ use_msi: true }],
},
{
label: 'Use Emulator',
value: 'use_emulator',
fieldType: 'bool',
required: false,
default: false,
description:
"Uses local storage emulator if provided as 'true'. Leave blank if using real azure storage endpoint.",
command: '--azureblob-use-emulator',
},
{
label: 'Use Azure CLI',
value: 'use_az',
fieldType: 'bool',
required: false,
default: false,
description: 'Use the Azure CLI tool (az) as the sole means of authentication.',
command: '--azureblob-use-az',
},
{
label: 'Endpoint',
value: 'endpoint',
fieldType: 'string',
required: false,
default: '',
description: 'Endpoint for the service. Leave blank normally.',
command: '--azureblob-endpoint',
},
{
label: 'Upload Cutoff',
value: 'upload_cutoff',
fieldType: 'string',
required: false,
default: '',
description: 'Cutoff for switching to chunked upload (<= 256 MiB) (deprecated).',
command: '--azureblob-upload-cutoff',
},
{
label: 'Chunk Size',
value: 'chunk_size',
fieldType: 'sizesuffix',
required: false,
default: '4mi',
description:
'Upload chunk size. Chunks are stored in memory, and memory usage depends on the number of concurrent transfers.',
command: '--azureblob-chunk-size',
},
{
label: 'Upload Concurrency',
value: 'upload_concurrency',
fieldType: 'int',
required: false,
default: '16',
description:
'Concurrency for multipart uploads. This is the number of chunks of the same file that are uploaded concurrently.',
command: '--azureblob-upload-concurrency',
},
{
label: 'List Chunk',
value: 'list_chunk',
fieldType: 'int',
required: false,
default: '5000',
description:
'Number of blobs requested per listing page. Reduce this value if listing operations are timing out.',
command: '--azureblob-list-chunk',
},
{
label: 'Access Tier',
value: 'access_tier',
fieldType: 'select',
required: false,
default: '',
description:
'Access tier of blob: hot, cool, cold or archive. Archived blobs can be restored by setting access tier to hot, cool or cold. Leave blank if you intend to use default access tier, which is set at account level',
command: '--azureblob-access-tier',
options: [
{ label: 'Default (account-level)', value: '' },
{ label: 'Hot', value: 'hot' },
{ label: 'Cool', value: 'cool' },
{ label: 'Cold', value: 'cold' },
{ label: 'Archive', value: 'archive' },
],
},
{
label: 'Archive Tier Delete',
value: 'archive_tier_delete',
fieldType: 'bool',
required: false,
default: false,
description:
'Delete archive tier blobs before overwriting. Archive tier blobs cannot be updated directly, so this deletes them first before writing new data.',
command: '--azureblob-archive-tier-delete',
},
{
label: 'Disable Checksum',
value: 'disable_checksum',
fieldType: 'bool',
required: false,
default: false,
description:
"Don't store MD5 checksum with object metadata. Disabling checksums can speed up uploads for large files but reduces data integrity verification.",
command: '--azureblob-disable-checksum',
},
{
label: 'Memory Pool Flush Time',
value: 'memory_pool_flush_time',
fieldType: 'duration',
required: false,
default: '1m0s',
description: 'How often internal memory buffer pools will be flushed. (no longer used)',
command: '--azureblob-memory-pool-flush-time',
},
{
label: 'Memory Pool Use MMAP',
value: 'memory_pool_use_mmap',
fieldType: 'bool',
required: false,
default: false,
description: 'Whether to use mmap buffers in internal memory pool. (no longer used)',
command: '--azureblob-memory-pool-use-mmap',
},
{
label: 'Encoding',
value: 'encoding',
fieldType: 'encoding',
required: false,
default: 'slash,backslash,del,ctl,rightperiod,invalidutf8',
description: 'The encoding for the backend.',
command: '--azureblob-encoding',
},
{
label: 'Public Access',
value: 'public_access',
fieldType: 'select',
required: false,
default: '',
description: 'Public access level of a container: blob or container.',
command: '--azureblob-public-access',
options: [
{ label: 'No public access', value: '' },
{ label: 'Blob-level public read', value: 'blob' },
{ label: 'Full public read (container)', value: 'container' },
],
},
{
label: 'Directory Markers',
value: 'directory_markers',
fieldType: 'bool',
required: false,
default: false,
description:
'Upload an empty object with a trailing slash when a new directory is created Empty folders are unsupported for bucket based storages, this option creates an empty object ending with "/", to persist the folder.',
command: '--azureblob-directory-markers',
},
{
label: 'No Check Container',
value: 'no_check_container',
fieldType: 'bool',
required: false,
default: false,
description:
"If set, don't attempt to check the container exists or create it. Useful if you know the container already exists and want to reduce API calls.",
command: '--azureblob-no-check-container',
},
{
label: 'No Head Object',
value: 'no_head_object',
fieldType: 'bool',
required: false,
default: false,
description: 'If set, do not do HEAD before GET when getting objects.',
command: '--azureblob-no-head-object',
},
{
label: 'Delete Snapshots',
value: 'delete_snapshots',
fieldType: 'select',
required: false,
default: '',
description: 'Set to specify how to deal with snapshots on blob deletion.',
command: '--azureblob-delete-snapshots',
options: [
{ label: 'Fail if blob has snapshots', value: '' },
{ label: 'Delete blob and all snapshots', value: 'include' },
{ label: 'Delete only snapshots', value: 'only' },
],
},
{
label: 'Description',
value: 'description',
fieldType: 'string',
required: false,
default: '',
description: 'Description of the Storage.',
command: '--azureblob-description',
},
];
export default azureblobSettings;