Skip to main content

Config for azure-storage

Jobs that use the azure-storage adaptor may require authentication. A "credential" for the azure-storage adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "accountName": "examplestorageaccount01",
  "accountKey": "zzUx5rA4BZkjPet8ztLTEll7azF65Sez7WxGKsJv5B+rp/dby8ARgYpEVe93xFCQDqGBi3FUlxjP+ASt4uepZg==",
  "containerName": "mycontainername"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "accountName": {
          "title": "Account Name",
          "type": "string",
          "description": "Azure Storage Account Name",
          "examples": [
              "examplestorageaccount01"
          ]
      },
      "accountKey": {
          "title": "Account Key",
          "type": "string",
          "description": "Azure Account Key",
          "writeOnly": true,
          "examples": [
              "zzUx5rA4BZkjPet8ztLTEll7azF65Sez7WxGKsJv5B+rp/dby8ARgYpEVe93xFCQDqGBi3FUlxjP+ASt4uepZg=="
          ]
      },
      "containerName": {
          "title": "Container Name",
          "type": "string",
          "description": "Name of Azure Blob Storage Container",
          "writeOnly": true,
          "examples": [
              "mycontainername"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "accountName",
      "accountKey"
  ]
}