Repository files navigation

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

To get started with a specific service library, see theREADME.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 ourlist of all existing libraries.

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

All libraries baseline on Java 8, with testing and forward support up until the latest Java long-term support release.

Each service can have both 'client' and 'management' libraries. 'Client' libraries are used to consume the service, whereas 'management' libraries are used to configure and manage the service.

Our client libraries follow theAzure 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 featureshere.These libraries can be easily identified by folder, package, and namespaces names starting withazure-, e.g.azure-keyvault.

You can find themost up-to-date list of new packages on our page. This list includes the most recent releases: both stable and beta.

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

Similar to our client libraries, the management libraries follow theAzure SDK Design Guidelines for Java. These libraries provide a high-level, object-oriented API formanaging Azure resources, that are optimized for ease of use, succinctness, and consistency. You can find the list of management librarieson this page.

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

The management libraries can be identified by namespaces that start withazure-resourcemanager, e.g.azure-resourcemanager-compute.

Note that the latest libraries from Microsoft are in thecom.azure Maven group ID, and have the package naming pattern of beginning withcom.azure. If you're using libraries that are incom.microsoft.azure Maven group ID, or have this as the package structure, please consider migrating to the latest libraries. You can find a mapping table from these historical releases to their equivalenthere.

The Azure SDKs for Java do not provide support for Android. While we attempt to allow the SDKs to be used on Android, we do not test or support this scenario.

• For reference documentation visit theAzure SDK for Java documentation.
• For tutorials, samples, quick starts and other documentation, visitAzure for Java Developers.
• For build reports on code quality, test coverage, etc., visitAzure Java SDK.
• File an issue viaGitHub Issues.
• Checkprevious questions or ask new ones on StackOverflow usingazure-java-sdk tag.

The main branch has the most recent code with new features and bug fixes. It doesnot represent latest releasedstable SDK.

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 beta or stable release version.Format of the release tags are<package-name>_<package-version>. For more information please seeour branching strategy.

For details on contributing to this repository, see thecontributing 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, viewMicrosoft'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 theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments.

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 detailedAzure SDK for Java wiki.

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 theSecurity TechCenter.

Azure SDK for Java is licensed under theMIT license.