sdk

README

Azure SDK for Go

This repository is for active development of the Azure SDK for Go. For consumers of the SDK you can follow the links below to visit the documentation you are interested in

• Overview of Azure SDK for Go
• SDK Reference
• Code Samples for Azure Go SDK
• Azure REST API Docs
• General Azure Docs
• Share your feedback to our Azure SDK

Getting Started

To get started with a library, see the README.md file located in the library's project folder. You can find these library folders grouped by service in the /sdk directory.

NOTE: Go 1.18 or later is required.

Packages available

Each service might have a number of libraries available from each of the following categories:

• Client - New Releases
• Client - Previous Versions
• Management - New Releases
• Management - Previous Versions

Client: New Releases

We have a new wave of packages that are being announced as stable and several that are currently released in beta. These libraries allow you to use, consume, and interact with existing resources, for example, uploading a blob. These libraries share a number of core functionalities including retries, logging, transport protocols, authentication protocols, etc. that can be found in the azcore library. You can learn more about these libraries by reading about the Azure SDK Go guidelines.

You can find the most up-to-date list of new packages on our latest page. These new libraries can be identified by locating them under the sdk directory in the repository.

NOTE: If you need to ensure your code is ready for production use one of the stable, non-beta libraries.

Client: Previous Versions

The last stable versions of packages that have been provided for usage with Azure are production-ready. These libraries might not implement the Azure Go SDK guidelines or have the same feature set as the New releases, however they do offer a wider coverage of services.

Previous Go SDK packages are located under /services folder, and you can see the full list on this page.

Management: New Releases

A new set of management libraries that follow the Azure SDK Design Guidelines for Go are available at sdk/resourcemanagement. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more.

To get started, please follow the quickstart guide here. To see the benefits of migrating and how to migrate to the new libraries, please visit the migration guide.

You can find the most up to date list of all of the new packages on our page

NOTE: If you need to ensure your code is ready for production use one of the stable, non-beta libraries. Also, if you are experiencing authentication issues with the management libraries after upgrading certain packages, it's possible that you upgraded to the new versions of SDK without changing the authentication code. Please refer to the migration guide for proper instructions.

• Quickstart tutorial for new releases. Documentation is also available at each readme file of the individual module (Example: Readme for Compute Module)

Management: Previous Versions

For a complete list of management libraries which enable you to provision and manage Azure resources, please check here. They might not have the same feature set as the new releases but they do offer wider coverage of services.

Previous packages are located under /services folder, and you can see the full list on this page.

• Quickstart tutorial for previous versions

Other Azure Go Packages

Azure provides several other packages for using services from Go, listed below. These packages do NOT follow the New Release guidelines.

Service	Import Path/Repo
Storage - Blobs	github.com/Azure/azure-storage-blob-go
Storage - Files	github.com/Azure/azure-storage-file-go
Storage - Queues	github.com/Azure/azure-storage-queue-go
Event Hubs	github.com/Azure/azure-event-hubs-go
Application Insights	github.com/Microsoft/ApplicationInsights-go

Samples

More code samples for using the management library for Go SDK can be found in the following locations

• Go SDK Code Samples Repo(New version)
• Go SDK Code Samples Repo
• Example files under each package. For example, examples for Network packages can be found here

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Need help?

• File an issue via Github Issues
• Check previous questions or ask new ones on StackOverflow using azure and go tags.

Community

• Chat with us in the #Azure SDK channel on the Gophers Slack. Sign up here first if necessary.

Contribute

See CONTRIBUTING.md.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Documentation

Overview

Package sdk provides Go packages for managing and using Azure services.

GitHub repo: https://github.com/Azure/azure-sdk-for-go

Official documentation: https://docs.microsoft.com/azure/go

API reference: https://godoc.org/github.com/Azure/azure-sdk-for-go

Samples: https://github.com/Azure-Samples/azure-sdk-for-go-samples