distribution/docs/storage-drivers/azure.md

<!--GITHUB
page_title: Microsoft Azure storage driver
page_description: Explains how to use the Azure storage drivers
page_keywords: registry, service, driver, images, storage, azure
IGNORES-->

# Microsoft Azure storage driver

An implementation of the `storagedriver.StorageDriver` interface which uses [Microsoft Azure Blob Storage][azure-blob-storage] for object storage.

## Parameters

The following parameters must be used to authenticate and configure the storage driver (case-sensitive):

* `accountname`: Name of the Azure Storage Account.
* `accountkey`: Primary or Secondary Key for the Storage Account.
* `container`: Name of the root storage container in which all registry data will be stored. Must comply the storage container name [requirements][create-container-api].
* `realm`: (optional) Domain name suffix for the Storage Service API endpoint. Defaults to `core.windows.net`. For example realm for "Azure in China" would be `core.chinacloudapi.cn` and realm for "Azure Government" would be `core.usgovcloudapi.net`.

## Developing

To include this driver when building Docker Distribution, use the build tag
`include_azure`. Please see the [building documentation][building] for details.

[azure-blob-storage]: http://azure.microsoft.com/en-us/services/storage/
[create-container-api]: https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx
[building]: https://github.com/docker/distribution/blob/master/docs/building.md#optional-build-tags
Fixes Issue #471 with Publish - Add sed to Dockerfile; this sed exists on publish script; breaks headings/nav in files without metadata - Ensure sed runs over storage-driver/ subdir - Add metadata to all the files (including specs) that don't have it; this ensures they display correctly on publish - Implement the fix for the showing up in Github - Update template with GITHUB IGNORES Signed-off-by: Mary Anthony <mary@docker.com> 2015-04-29 19:20:09 +00:00			`<!--GITHUB`
			`page_title: Microsoft Azure storage driver`
			`page_description: Explains how to use the Azure storage drivers`
			`page_keywords: registry, service, driver, images, storage, azure`
			`IGNORES-->`
storagedriver/azure: Add README Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com> 2015-02-11 17:46:23 +00:00
Fixes Issue #471 with Publish - Add sed to Dockerfile; this sed exists on publish script; breaks headings/nav in files without metadata - Ensure sed runs over storage-driver/ subdir - Add metadata to all the files (including specs) that don't have it; this ensures they display correctly on publish - Implement the fix for the showing up in Github - Update template with GITHUB IGNORES Signed-off-by: Mary Anthony <mary@docker.com> 2015-04-29 19:20:09 +00:00			`# Microsoft Azure storage driver`
storagedriver/azure: Add README Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com> 2015-02-11 17:46:23 +00:00
			An implementation of the `storagedriver.StorageDriver` interface which uses [Microsoft Azure Blob Storage][azure-blob-storage] for object storage.

			`## Parameters`

			`The following parameters must be used to authenticate and configure the storage driver (case-sensitive):`

			* `accountname`: Name of the Azure Storage Account.
			* `accountkey`: Primary or Secondary Key for the Storage Account.
			* `container`: Name of the root storage container in which all registry data will be stored. Must comply the storage container name [requirements][create-container-api].
storage/driver/azure: Allow non-default realms This enables Azure storage driver to be used with non-default cloud endpoints like Azure China or Azure Government that does not use `.blob.core.windows.net` FQDN suffix. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com> 2015-03-24 01:20:06 +00:00			* `realm`: (optional) Domain name suffix for the Storage Service API endpoint. Defaults to `core.windows.net`. For example realm for "Azure in China" would be `core.chinacloudapi.cn` and realm for "Azure Government" would be `core.usgovcloudapi.net`.
storagedriver/azure: Add README Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com> 2015-02-11 17:46:23 +00:00
Disable building of azure storage driver by default Signed-off-by: Stephen J Day <stephen.day@docker.com> 2015-06-04 01:14:53 +00:00			`## Developing`

			`To include this driver when building Docker Distribution, use the build tag`
			`include_azure`. Please see the [building documentation][building] for details.
storagedriver/azure: Add README Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com> 2015-02-11 17:46:23 +00:00
			`[azure-blob-storage]: http://azure.microsoft.com/en-us/services/storage/`
Disable building of azure storage driver by default Signed-off-by: Stephen J Day <stephen.day@docker.com> 2015-06-04 01:14:53 +00:00			`[create-container-api]: https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx`
			`[building]: https://github.com/docker/distribution/blob/master/docs/building.md#optional-build-tags`