External Storage - Microsoft Azure Storage

External Storage / Microsoft Azure Storage

On this page:

In order to use Microsoft Azure as your External Storage of choice, you must set the provider attribute to microsoft within the store hash and, at a minimum, provide your Azure Storage access key as well as Azure Storage account name and a destination container. The full list of store hash attibutes for Microsoft Azure storage can be found below.

store hash attributes for Microsoft Azure Storage:
AttributeTypeRequiredDescription
providerStringYesprovider must be set to microsoft.
accountStringYesYour Azure Storage Account name.
keyStringYesYour Azure Storage Access Key.
containerStringYesName of a destination container in your Microsoft Azure account.
pathStringNoDestination path in your Azure container (without leading slash). Defaults to root.
metadataHashNoCustom Azure Blob Metadata you would like to set on your object.
headersHashNoCustom HTTP headers you would like to set on your object.

The Optidash API allows you to set the following custom headers on your objects: Cache-Control, Content-Type, Content-Encoding, Content-Language and Content-Disposition

{
    "store": {
        "provider": "microsoft",
        "key": "azure-access-key",
        "account": "azure-account-name",
        "container": "images",
        "path": "assets/image.jpg",
        "metadata": {
            "key": "value"
        },
        "headers": {
            "Cache-Control": "max-age=2592000000"
        }
    }
}

An example cURL request of using Microsoft Azure Storage as the External Storage provider will look like the following:

curl https://api.optidash.ai/1.0/fetch -X POST -u your-api-key: \
-H "Content-Type: application/json" \
-d '{
    "url": "https://www.website.com/image.jpg",
    "resize": {
        "width": 100,
        "height": 75
    },
    "store": {
        "provider": "microsoft",
        "key": "azure-access-key",
        "account": "azure-account-name",
        "container": "images",
        "path": "assets/image.jpg"
    }
}'

When using Microsoft Azure as your External Storage, the url property within the JSON response will point to the object’s location within the Azure Container and you can safely use that URL in production, for example:

HTTP/1.1 200 OK

Date: 
Status: 200 OK
Content-Type: application/json

{
    "success": true,
    "code": 200,
    "id": "b33ab63b-ddc0-462d-a1cf-437240c868b8",
    "input": {
        "name": "image.jpg",
        ..
    },
    "output": {
        "url": "https://container-name.blob.core.windows.net/assets/image.jpg",
        ..
    }
}

Code Examples for Microsoft Azure External Storage

Below, you'll find examples of how to use Microsoft Azure Storage from the Optidash API:

  • PHP
  • Node
  • Ruby
  • Go
  • Python
  • Java
<?php

/**
* Instantiate new `$opti` by calling a constructor
*/

$opti = new Optidash\Optidash('your-api-key');


/**
* Provide a publicly available image URL with fetch(string) method,
* resize the image to 100 x 75 and store it in Microsoft Azure Storage
*/

$opti
    ->fetch('https://www.website.com/image.jpg')
    ->resize(array(
        'width' => 100,
        'height' => 75
    ))
    ->store(array(
        'provider' => 'microsoft',
        'key' => 'azure-access-key',
        'account' => 'azure-account-name',
        'container' => 'images',
        'path' => 'assets/image.jpg'
    ))
    ->toJSON(function ($error, $meta) {
        if (!empty($error)) {
            throw new Exception($error);
        }

        /**
        * You'll find the full JSON metadata array within the `$meta` variable.
        * Remember to always check if the `success` property is set to `true`.
        */

        if ($meta['success'] == true) {
            print ($meta['output']['url']);
        } else {
            print ($meta['message']);
        }
    });
/**
* Module dependencies
*/

const Optidash = require("optidash");


/**
* Instantiate new `opti` by calling a constructor
*/

const opti = new Optidash("your-api-key");


/**
* Provide a publicly available image URL with fetch(string) method,
* resize the image to 100 x 75 and store it in Microsoft Azure Storage
*/

opti
    .fetch("https://www.website.com/image.jpg")
    .resize({
        width: 100,
        height: 75
    })
    .store({
        provider: "microsoft",
        key: "azure-access-key",
        account: "azure-account-name",
        container: "images",
        path: "assets/image.jpg"
    })
    .toJSON((err, meta) => {
        if (err) {
            return console.log(err);
        }

        /**
        * You'll find the full JSON metadata hash within the `meta` variable.
        * Remember to always check if the `success` property is set to `true`.
        */

        if (meta.success) {
            console.log(meta.output.url);
        } else {
            console.log(meta.message);
        }
    });
##
# Require dependencies

require "optidash"


##
# Instantiate new `opti` by calling a constructor

opti = Optidash.new("your-api-key")


##
# Provide a publicly available image URL with fetch(string) method,
# resize the image to 100 x 75 and store it in Microsoft Azure Storage

err, meta = opti
    .fetch("https://www.website.com/image.jpg")
    .resize(
        width: 100,
        height: 75
    )
    .store(
        provider: "microsoft",
        key: "azure-access-key",
        account: "azure-account-name",
        container: "images",
        path: "assets/image.jpg"
    )
    .to_json

abort(err) if err


##
# You'll find the full JSON metadata hash within the `meta` variable.
# Remember to always check if the `success` property is set to `true`.

if meta["success"]
    puts meta["output"]["url"]
else
    puts meta["message"]
end
package main

import (
    "fmt"
    "github.com/optidash/optidash-go"
)

func main() {

    /**
    * Instantiate new `opti` by calling a constructor
    */

    opti, err := optidash.NewClient("your-api-key")

    if err != nil {
        panic(err)
    }


    /**
    * Provide a publicly available image URL with Fetch(string) method,
    * resize the image to 100 x 75 and store it in Microsoft Azure Storage
    */

    meta, err := opti.
        Fetch("https://www.website.com/image.jpg").
        Resize(optidash.P{
            "width": 100,
            "height": 75
        }).
        Store(optidash.P{
            "provider": "microsoft",
            "key": "azure-access-key",
            "account": "azure-account-name",
            "container": "images",
            "path": "assets/image.jpg"
        }).
        ToJSON()

    if err != nil {
        panic(err)
    }


    /**
    * You'll find the full JSON metadata hash within the `meta` variable.
    * Remember to always check if the `success` property is set to `true`.
    */

    if meta["success"].(map[string]interface{})["success"].(bool) {
        fmt.Println(meta["output"].(map[string]interface{})["url"])
    } else {
        fmt.Println(meta["message"])
    }
}
##
# Import dependencies

from optidash import optidash


##
# Instantiate new `opti` by calling a constructor

opti = optidash('your-api-key')


##
# Provide a publicly available image URL with fetch(string) method,
# resize the image to 100 x 75 and store it in Microsoft Azure Storage

err, meta = (
    opti
        .fetch('https://www.website.com/image.jpg')
        .resize({
            'width': 100,
            'height': 75
        })
        .store({
            'provider': 'microsoft',
            'key': 'azure-access-key',
            'account': 'azure-account-name',
            'container': 'images',
            'path': 'assets/image.jpg'
        })
        .toJSON()
)

if err is not None:
    raise StandardError(err)


##
# You'll find the full JSON metadata hash within the `meta` variable.
# Remember to always check if the `success` property is set to `true`.

if meta['success'] is True:
    print (meta['output']['url'])
else:
    print (meta['message'])
package com.optidash.examples;

/**
* Import dependencies
*/

import static com.optidash.OperationConfiguration.settings;
import com.optidash.Optidash;
import com.optidash.Fetch;
import com.optidash.Response;

public class StorageAzure {
    public static void main(String[] args) {

        /**
        * Instantiate new `opti` by calling a constructor
        */

        Optidash opti = new Optidash("your-api-key");


        /**
        * Provide a publicly available image URL with fetch(string) method,
        * resize the image to 100 x 75 and store it in Microsoft Azure Storage
        */

        final Response response = opti.fetch("https://www.website.com/image.jpg");

        fetch.resize(
            settings()
                .set("width", 100)
                .set("height", 75)
        );

        fetch.store(
            settings()
                .set("provider", "microsoft")
                .set("key", "azure-access-key")
                .set("account", "azure-account-name")
                .set("container", "images")
                .set("path", "assets/image.jpg")
        );

        final Response response = fetch.toJson();

        /**
        * You'll find the full JSON metadata hash within the `Response#getMetadata()` variable.
        * Remember to always check if the `Response#successful` property is set to `true`.
        */

        if (response.isSuccessful()) {
            System.out.println(response.getMetadata().getOutput().get("url"));
        } else {
            System.out.println(response.getMessage());
        }
    }
}
Grace Przemek Magda Damian
Have questions? Let's talk!We usually respond in just under an hour

Thanks for reaching out!

We've received your message
and will get to it as quickly as possible.

Whoops, looks like something went wrong.

We encountered an unexpected error and cannot complete your request. Please try reloading the page.