Azure Blob

Description #

The Azure Blob Storage remote uses Azure Blob Storage to upload the outputs of the backup process to a storage container.

Configuration #

{
  "remotes": [
    {
      "name": "myRemote",
      "type": "AZURE_STORAGE_BLOB",
      "endpoint": "https://mybackupstorage.blob.core.windows.net/",
      "container": "backups",
      "overwrite": true,
      "blobPrefixPattern": "latest"
      // no credentials provided
    }
  ],
  "sources": [
    {
      "name": "source-with-inline-az-blob-remote",
      // ...
      "remotes": [
        {
          "name": "myRemote",
          "type": "AZURE_STORAGE_BLOB",
          "endpoint": "https://mybackupstorage.blob.core.windows.net/",
          "container": "backups",
          "credentials": "myAzureCreds"
        }
      ]
    },
    {
      "name": "source-with-global-az-blob-remote",
      // ...
      "remotes": [
        "myRemote"
      ]
    }
  ]
}

Available configuration options #

name #

required

The name of the source. This has to be a valid identifier.

type #

required
constant

A constant that tells the engine what kind of remote this object is. This must be set to "AZURE_STORAGE_BLOB".

endpoint #

required
template enabled

The storage account blob endpoint.

container #

required
template enabled

The container name where the backups should be placed.

overwrite #

default value

Whether to overwrite any existing blobs in the container when names clash. Defaults to false. If this is false and a clash occurs, the process will fail.

blobPrefixPattern #

default value

The prefix for all blobs created during the same backup session. Supports templating with context. Defaults to "<context.sourceName>/<context.nowYear>/<context.nowMonth>/<context.nowDay>".

disabled #

default value

Whether to ignore this source during the backup process. Defaults to false.

credentials #

Credentials to authenticate to the remote.

Valid credentials #

None #

When defining this remote, defining the none credential, or not providing any credentials will attempt to use the default azure credential strategy.

Azure CLI #

Azure CLI credentials can be provided.

Azure Service Account #

Azure Service Account credentials can be provided.

Context #

The field templating context extends the default context with additional values:

Variable	Description
`context.sourceName`	Name of current source

On this page