Azure SDK for Java
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.
Important
The Azure SDK team is pleased to make available the January 2020 client library General Availability (GA) release. We strongly recommend using the GA libraries in all production environments as these libraries are well tested and officially supported by Microsoft. More details, including installation instructions can be found here here.
Getting started
To get started with a specific library, see the README.md file located in the library's project folder. You can find service libraries in the /sdk directory.
For tutorials, samples, quick starts and other documentation, visit Azure for Java Developers.
Prerequisites
Java 8 or later is required to use the January 2020 client libraries, otherwise Java 7 or later is required.
Latest Release
Each service might have a number of libraries available from each of the following categories:
Client: GA January 2020 Releases
New wave of packages that were released in January 2020 client library as General Availability (GA) and several others that were released in beta. These libraries 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 sdk/ folder, package, and namespaces names starting with azure-, e.g. azure-keyvault.
The libraries released in the GA January 2020 release is listed below.
Client: Earlier GA Releases
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 preview libraries, as they allow you to use and consume existing resources and interact with them, for example: upload a blob. Stable 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 GA releases. They do however offer wider coverage of services.
Management
Libraries which enable you to provision specific resources. They are responsible for directly mirroring and consuming Azure service's REST endpoints. Management library directories contain -mgmt-, e.g. azure-mgmt-keyvault.
Need help?
- For reference documentation visit the Azure SDK for Java documentation.
- For tutorials, samples, quick starts and other documentation, visit Azure for Java Developers.
- For build reports on code quality, test coverage, etc, visit Azure Java SDK.
- File an issue via Github Issues.
- Check previous questions or ask new ones on StackOverflow using
azure-java-sdktag.
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, visit
https://cla.microsoft.com.
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:
- What are some good first issues for new contributors to the repo?
- How to build and test your change
- How you can make a change happen!
- Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed Azure SDK for Java wiki.
Community
- Chat with other community members
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.
