README.md
1# Azure Storage Blob SDK for Go
2[![GoDoc Widget]][GoDoc] [![Build Status][Travis Widget]][Travis]
3
4The Microsoft Azure Storage SDK for Go allows you to build applications that takes advantage of Azure's scalable cloud storage.
5
6This repository contains the open source Blob SDK for Go. The [File SDK][File SDK] and [Queue SDK][Queue SDK] are also available.
7
8## Features
9* Blob Storage
10 * Create/List/Delete Containers
11 * Create/Read/List/Update/Delete Block Blobs
12 * Create/Read/List/Update/Delete Page Blobs
13 * Create/Read/List/Update/Delete Append Blobs
14
15## Getting Started
16* If you don't already have it, install [the Go distribution](https://golang.org/dl/)
17* Get the SDK, with any method you prefer:
18 * Go Get: ```go get github.com/Azure/azure-storage-blob-go/azblob```
19 * Dep: add ```github.com/Azure/azure-storage-blob-go``` to Gopkg.toml:
20 ```
21 [[constraint]]
22 version = "0.3.0"
23 name = "github.com/Azure/azure-storage-blob-go"
24 ```
25 * Module: simply import the SDK and Go will download it for you
26* Use the SDK:
27```import "github.com/Azure/azure-storage-blob-go/azblob"```
28
29## Version Table
30* If you are looking to use a specific version of the Storage Service, please refer to the following table:
31
32| Service Version | Corresponding SDK Version | Import Path |
33|-----------------|---------------------------|----------------------------------------------------------|
34| 2016-05-31 | 0.2.0 | github.com/Azure/azure-storage-blob-go/2016-05-31/azblob |
35| 2017-07-29 | 0.2.0 | github.com/Azure/azure-storage-blob-go/2017-07-29/azblob |
36| 2018-03-28 | 0.3.0 - 0.5.0 | github.com/Azure/azure-storage-blob-go/azblob |
37| 2018-11-09 | 0.6.0 | github.com/Azure/azure-storage-blob-go/azblob |
38
39Note: the directory structure of the SDK has changed dramatically since 0.3.0. The different Service Versions are no longer sub-directories;
40the latest `azblob` is directly under the root directory. In the future, each new Service Version will be introduced with a new major semantic version.
41
42## SDK Architecture
43
44* The Azure Storage SDK for Go provides low-level and high-level APIs.
45 * ServiceURL, ContainerURL and BlobURL objects provide the low-level API functionality and map one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api)
46 * The high-level APIs provide convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests).
47
48## Code Samples
49* [Blob Storage Examples](https://godoc.org/github.com/Azure/azure-storage-blob-go/azblob#pkg-examples)
50
51## License
52This project is licensed under MIT.
53
54## Contributing
55This project welcomes contributions and suggestions. Most contributions require you to agree to a
56Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
57the rights to use your contribution. For details, visit https://cla.microsoft.com.
58
59When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
60a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
61provided by the bot. You will only need to do this once across all repos using our CLA.
62
63This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
64For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
65contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
66
67[GoDoc]: https://godoc.org/github.com/Azure/azure-storage-blob-go/azblob
68[GoDoc Widget]: https://godoc.org/github.com/Azure/azure-storage-blob-go/azblob?status.svg
69[Travis Widget]: https://travis-ci.org/Azure/azure-storage-blob-go.svg?branch=master
70[Travis]: https://travis-ci.org/Azure/azure-storage-blob-go
71[File SDK]: https://github.com/Azure/azure-storage-file-go
72[Queue SDK]: https://github.com/Azure/azure-storage-queue-go
73
