使用用于 Python 的 Azure 库 (SDK)

用于 Python 的开放源代码 Azure 库简化了通过 Python 应用程序代码预配、管理和使用 Azure 资源的过程。

你真正想要了解的详细信息

不重要但仍很有趣的详细信息

  • 由于 Azure CLI 是使用管理库通过 Python 编写的,因此,使用 Azure CLI 命令可执行的任何操作也可以通过 Python 脚本来执行。 也就是说,CLI 命令提供了许多有用的功能,如同时执行多项任务,自动处理异步操作、格式化输出(如连接字符串)等。 因此,使用 CLI(或其等效的 Azure PowerShell)进行自动预配和管理脚本比编写等效的 Python 代码要方便得多,除非你希望对过程进行更为严格的控制。

  • 用于 Python 的 Azure 库是基于底层 Azure REST API 构建的,使你可以通过熟悉的 Python 范式使用这些 API。 不过,在需要时,始终可以直接通过 Python 代码使用 REST API。

  • 可在 https://github.com/Azure/azure-sdk-for-python 上找到这些 Azure 库的源代码。 作为一个开源项目,你的贡献会受到欢迎!

  • 尽管可将这些库与我们未针对其进测试的解释器(例如 IronPython 和 Jython)配合使用,但可能会遇到孤立的问题和不兼容问题。

  • 库 API 参考文档的源存储库位于 https://github.com/MicrosoftDocs/azure-docs-sdk-python/ 上。

  • 我们目前正在更新用于 Python 的 Azure 库,以共享常见的云模式,如身份验证协议、日志记录、跟踪、传输协议、缓冲的响应和重试。

    • 该共享功能包含在 azure-core 库中。

    • Azure SDK for Python 最新版本上列出了当前与 Core 库兼容的库。 这些库(主要是客户机库)有时称为“跟踪 2”。

    • 管理库和任何其他尚未更新的库有时称为“跟踪 1”。

  • 若要详细了解我们应用于这些库的指导原则,请参阅 Python Guidelines:Introduction(Python 指南:简介)。

使用管理库预配和管理 Azure 资源

SDK 的管理(或“管理平面”)库(其名称都以 azure-mgmt- 开头)可帮助你通过 Python 脚本创建、预配和管理 Azure 资源。 所有 Azure 服务都有相应的管理库。

借助管理库,可以编写配置和部署脚本,以执行可通过 Azure 门户Azure CLI 执行的相同任务。 (如前文所述,Azure CLI 是用 Python 编写的,并使用管理库来实现其各种命令。)

以下示例说明了如何使用一些主管理库:

若要详细了解如何使用每个管理库,请参阅 README.mdREADME.rst 文件(位于 SDK GitHub 存储库的库项目文件夹中)。 也可在参考文档Azure 示例中找到更多代码片段。

从较旧的管理库进行迁移

如果要从较旧版本的管理库迁移代码,请参阅以下详细信息:

通过客户端库连接并使用 Azure 资源

SDK 的客户端(或“数据平面”)库可帮助你编写 Python 应用程序代码,以与已预配的服务进行交互。 只有那些支持客户端 API 的服务才存在客户端库。

示例:使用 Azure 存储一文提供了使用客户端库的基本说明。

不同的 Azure 服务还提供了使用这些库的示例。 有关其他链接,请参阅以下索引页:

若要详细了解如何使用每个客户端库,请参阅 README.mdREADME.rst 文件(位于 SDK 的 GitHub 存储库的库项目文件夹中)。 也可在参考文档Azure 示例中找到更多代码片段。

获取帮助并与 SDK 团队联系

后续步骤

我们强烈建议执行本地开发环境的一次性设置,以便你可以轻松使用任何用于 Python 的 Azure 库。