azure

Documentation

Overview

The `azure` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Azure's Blobstore Service.

PLUGIN FEATURES

This plugin implements functionality suitable for use with the following SHIELD Job components:

Target: no
Store:  yes

PLUGIN CONFIGURATION

The endpoint configuration passed to this plugin is used to determine how to connect to Azure Blobstore, and where to place/retrieve the data once connected. your endpoint JSON should look something like this:

{
    "storage_account":       "your-access-key-id",
    "storage_account_key":   "your-secret-access-key",
    "storage_container":     "storage-container-name",
}

STORE DETAILS

When storing data, this plugin connects to the Azure Blobstore, and uploads the data into the specified container, using a filename with the following format: into the specified storage container, using a path/filename with the following format:

<YYYY>-<MM>-<DD>-<HH-mm-SS>-<UUID>

Upon successful storage, the plugin then returns this filename to SHIELD to use as the `store_key` when the data needs to be retrieved, or purged.

If the storage container does not exist, it will be auto-created for you.

RETRIEVE DETAILS

When retrieving data, this plugin connects to the Azure Blobstore, and retrieves the data located in the specified storage container, identified by the `store_key` provided by SHIELD.

PURGE DETAILS

When purging data, this plugin connects to the Azure Blobstore, and deletes the data located in the specified storage container, identified by the `store_key` provided by SHIELD.

DEPENDENCIES

None.