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