Azure SDK for Java
本仓库用于 Azure SDK for Java 的积极开发。对于 SDK 的使用者,我们建议访问我们的公共开发者文档或我们的版本化开发者文档。
入门指南
若要开始使用特定的服务库,请参阅位于该库项目文件夹中的 README.md 文件。您可以在 /sdk 目录中找到服务库。要查看我们支持的所有服务列表,请访问我们的所有现有库列表。
有关教程、示例、快速入门和其他文档,请访问 Azure for Java Developers。
先决条件
所有库均以 Java 8 为基线,并支持测试和向前兼容,直至最新的 Java 长期支持版本。
可用包
每个服务都可以拥有 'client' 和 'management' 库。'Client' 库用于消费服务,而 'management' 库用于配置和管理服务。
客户端库
我们的客户端库遵循 Azure SDK Design Guidelines for Java,并共享许多核心功能,例如 HTTP 重试、日志记录、传输协议、身份验证协议等,因此一旦您学会在一个客户端库中使用这些功能,您就知道如何在其他客户端库中使用它们。您可以在此处了解这些共享功能。
这些库可以通过以 azure- 开头的文件夹、包和命名空间名称轻松识别,例如 azure-keyvault。
注意:如果您需要确保代码可用于生产环境,请使用其中一个稳定的非测试版库。
管理库
与我们的客户端库类似,管理库遵循 Azure SDK 的 Java 设计指南。这些库提供了一个高级的、面向对象的 API,用于_管理_ Azure 资源,并针对易用性、简洁性和一致性进行了优化。您可以在**此页面](https://azure.github.io/azure-sdk/releases/latest/mgmt/java.html)上找到管理库的列表。
有关如何使用 Azure 资源管理的新库的一般文档,请访问此处。我们还准备了**大量代码示例](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/SAMPLE.md)**以及**迁移指南](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/MIGRATION_GUIDE.md)**,以防您正在从以前的版本升级。
管理库可以通过以 azure-resourcemanager 开头的命名空间来识别,例如 azure-resourcemanager-compute。
历史版本
请注意,来自 Microsoft 的最新库位于 com.azure Maven 组 ID 中,并且其包命名模式以 com.azure 开头。如果您正在使用位于 com.microsoft.azure Maven 组 ID 中的库,或者具有此包结构,请考虑迁移到最新的库。您可以在此处找到从这些历史版本到其等效版本的映射表。
Android 支持
Azure 的 Java SDK 不支持 Android。虽然我们尝试允许在 Android 上使用这些 SDK,但我们不测试或支持此场景。
需要帮助?
- 有关参考文档,请访问 Azure SDK for Java 文档。
- 有关教程、示例、快速入门和其他文档,请访问 Azure for Java Developers。
- 有关代码质量、测试覆盖率等的构建报告,请访问 Azure Java SDK。
- 通过 GitHub Issues 提交问题。
- 检查 previous questions 或在 StackOverflow 上使用
azure-java-sdk标签提出新问题。
导航仓库
主分支
主分支包含具有新功能和错误修复的最新代码。它不代表最新发布的稳定 SDK。
发布分支(发布标记)
对于每个发布的包,都会创建一个唯一的 git 标记,其中包含包的名称和版本,以标记生成该包的代码提交。该标记将用于通过热修复分支进行服务,以及调试特定 beta 或稳定发布版本的代码。
发布标记的格式为 <package-name>_<package-version>。有关更多信息,请参阅 our branching strategy。
贡献
有关为此仓库贡献的详细信息,请参阅 contributing guide。
贡献者的综合文档中心(构建、测试、版本控制、发布检查清单等)位于 docs/。
For AI Agents: 如果您是 AI 代理(例如 GitHub Copilot、MCP 服务器或 LLM 助手)正在处理此仓库,请参阅 AGENTS.md 以获取有关仓库结构、工作流程以及代理交互最佳实践的指导。
本项目欢迎贡献和建议。大多数贡献需要您同意一份贡献者许可协议(CLA),声明您有权并且确实授予我们使用您贡献的权利。有关详细信息,请查看 Microsoft's CLA。
当您提交拉取请求时,CLA-bot 将自动确定您是否需要提供 CLA,并相应地标记 PR(例如,标签、评论)。只需按照机器人提供的说明操作即可。您只需在所有使用我们 CLA 的仓库中执行一次此操作。
本项目已采纳 Microsoft Open Source Code of Conduct。有关更多信息,请参阅 Code of Conduct FAQ 或就任何额外问题或评论联系 opencode@microsoft.com。
Additional Helpful Links for Contributors
世界各地许多人帮助使本项目变得更好。 您可能希望查看:
- 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!
- 详细 Azure SDK for Java wiki 中的常见问题解答(FAQ)和概念主题。
Reporting security issues and security bugs
安全问题和漏洞应通过电子邮件私下报告给 Microsoft Security Response Center (MSRC) secure@microsoft.com。您应在 24 小时内收到回复。如果由于某种原因未收到,请通过电子邮件跟进,以确保我们收到了您的原始消息。更多信息,包括 MSRC PGP 密钥,可在 Security TechCenter 中找到。
License
Azure SDK for Java 采用 MIT 许可证。