Skip to content
main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

Azure SDK for Java

Packages Dependencies DepGraph Build Documentation SpotBugs CheckStyle

This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our public developer docs or our versioned developer docs.

Getting started

To get started with a specific service library, see the README.md file located in the library's project folder. You can find service libraries in the /sdk directory. For a list of all the services we support access our list of all existing libraries.

For tutorials, samples, quick starts and other documentation, visit Azure for Java Developers.

Prerequisites

Java 8 or later is required to use libraries under the com.azure package, for libraries under the com.microsoft.azure package Java 7 or later is required.

Available packages

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

Client: New Releases

New wave of packages that follow the Azure SDK Design Guidelines for Java and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features here. These libraries can be easily identified by folder, package, and namespaces names starting with azure-, e.g. azure-keyvault.

You can find the most up to date list of all of the new packages on our page. This list includes the most recent releases: both GA and preview.

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

Client: Previous Versions

Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide similar functionalities to the new libraries, as they allow you to use and consume existing resources and interact with them, for example: upload a blob. Previous library directories start with microsoft-azure-, e.g. microsoft-azure-keyvault. They might not implement the guidelines or have the same feature set as the new releases. They do however offer wider coverage of services.

Management: New Releases

A new set of management libraries that follow the Azure SDK Design Guidelines for Java are now Generally Available (GA) and ready for production uses. These new libraries provide a higher-level, object-oriented API for managing Azure resources, that is optimized for ease of use, succinctness and consistency. You can find the list of new packages on this page.

For general documentation on how to use the new libraries for Azure Resource Management, please visit here. We have also prepared plenty of code samples as well as migration guide in case you are upgrading from previous versions.

New Management libraries can be identified by namespaces that start with azure-resourcemanager, e.g. azure-resourcemanager-compute

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 versions of management libraries can be identified by namespaces that start with azure-mgmt-, e.g. azure-mgmt-compute

Need help?

Navigating the repository

Master branch

The master branch has the most recent code with new features and bug fixes. It does not represent latest released GA SDK. See above for latest GA release.

Release branches (Release tagging)

For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular preview or stable release version. Format of the release tags are <package-name>_<package-version>. For more information please see our branching strategy.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, view Microsoft's CLA.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

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.

Additional Helpful Links for Contributors

Many people all over the world have helped make this project better. You'll want to check out:

Community

Chat with other community members Join the chat at https://gitter.im/azure/azure-sdk-for-java

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.

License

Azure SDK for Java is licensed under the MIT license.

Impressions