用于Python的开源Azure库简化了Python应用程序代码中的预配、管理和使用Azure资源。
真正想要了解的详细信息
使用 Azure 库从你在本地或云端运行的 Python 代码中与 Azure 服务通信。 是否可以在特定服务范围内运行Python代码取决于该服务本身当前是否支持Python。
有关受支持的Python版本,请参阅Azure SDK Python版本支持策略。 如果使用 PyPy,请使用与受支持的Python版本兼容的版本。
Python的Azure SDK仅由与特定Azure服务相关的 180 多个单独Python库组成。 SDK 中没有其他工具。
在本地运行代码时,通过 Azure 进行身份验证依赖于环境变量,具体如 如何使用 Azure SDK for Python 对 Python 应用进行 Azure 服务身份验证 中所述。
若要使用 pip 安装库包,请使用
pip install <library_name>包索引中的库名称。 要在 conda 环境中安装库包,请使用conda install <package_name>中来自 anaconda.org 上的 Microsoft 通道的名称。有关详细信息,请参阅安装 Azure 库包。有不同的管理和客户端库(有时称为“管理平面”和“数据平面”库)。 每个集都用于不同的目的,由不同类型的代码使用。 有关详细信息,请参阅本文后面的以下部分:
可以在 Azure for Python Reference 上找到库的文档,该文档按照 Azure 服务组织,或者在 Python API 浏览器 中按包名称组织。
若要自行尝试库,请先 设置本地开发环境。 然后可以尝试以下任何独立示例(按任意顺序):Example:创建资源组, Example:创建和使用 Azure 存储、Example:创建和部署 Web 应用、Example:创建和查询 MySQL 数据库 和 Example:创建虚拟机。
有关演示视频,请参阅 引入 Azure SDK for Python(PyCon 2021)和 使用Azure SDK与 Azure 资源交互(PyCon 2020)。
非必要但仍然有趣的细节
由于 Azure CLI是用 Python 编写的并使用管理库的,因此可以使用Azure CLI命令执行任何作,也可以通过Python脚本执行任何作。 CLI 命令提供了许多有用的功能,例如一起执行多个任务、自动处理异步作、格式化输出(如连接字符串等)。 因此,使用 CLI(或其等效的Azure PowerShell)自动创建和管理脚本比编写等效Python代码更方便,除非你想要对过程拥有更确切的控制度。
Python库是构建在基础的Azure REST API之上的,因此可以通过熟悉的Python习惯用法来使用这些API。 但是,如果需要,始终可以直接从Python代码使用 REST API。
可以在 https://github.com/Azure/azure-sdk-for-python 上找到Azure库的源代码。 作为开源项目,欢迎贡献!
虽然你可以在 IronPython、Jython 等 Microsoft 未测试过的解释器中使用这些库,但可能会遇到个别问题和不兼容的情况。
库 API 参考文档的源存储库位于https://github.com/MicrosoftDocs/azure-docs-sdk-python/。
Azure Python 库遵循常见的云端设计模式,例如身份验证协议、日志记录、跟踪、传输协议、缓冲响应和重试。 这些库遵循当前的Azure SDK准则。
有关Microsoft对库应用的指南的详细信息,请参阅Python 指南:简介。
使用管理库创建和管理Azure资源
SDK 的 management(或“管理平面”)库的名称全部以 azure-mgmt- 开头,可帮助你从Python脚本创建、配置和其他管理Azure资源。 所有Azure服务都有相应的管理库。 有关详细信息,请参阅 Azure 控制平面和数据平面。
通过使用管理库,可以编写配置和部署脚本来执行通过 Azure 门户或 Azure CLI 执行的任务。 (如前所述,Azure CLI以Python编写,并使用管理库实现其各种命令。
以下示例演示如何使用某些主要管理库:
有关使用每个管理库的详细信息,请参阅 README.md 或 README.rst 文件,该文件位于 SDK GitHub 存储库。 还可以在 reference 文档和 Azure Samples中找到更多代码片段。
从旧版管理库迁移
如果要从旧版管理库迁移代码,请参阅以下详细信息:
- 如果使用该
ServicePrincipalCredentials类,请参阅 使用令牌凭据进行身份验证。 - 异步 API 的名称已更改,请参阅库使用模式 - 异步操作中所述。 较新的库中的异步 API 名称以
begin_开头。 在大多数情况下,API 签名保持不变。
通过客户端库连接到和使用Azure资源
SDK 的 client(或“数据平面”)库可帮助你编写Python应用程序代码以与已预配的服务进行交互。 客户端库仅适用于支持客户端 API 的服务。
本文Example:使用 Azure 存储 提供了使用客户端库的基本插图。
不同的Azure服务还提供使用这些库的示例。 有关其他链接,请参阅以下索引页:
有关使用每个客户端库的详细信息,请参阅 README.md 或 README.rst 文件位于 SDK 的 GitHub 存储库中的库项目文件夹中。 还可以在 reference 文档和 Azure Samples中找到更多代码片段。
获取帮助并与 SDK 团队联系
- 请访问 Azure 库以获取Python文档
- 在 Stack Overflow 上向社区发布问题
- 在 GitHub 上针对 SDK 提交问题
- 在 Twitter 上提及@AzureSDK
- 完成关于 Azure SDK for Python 的简短调查问卷
后续步骤
设置本地开发环境,以便您可以轻松使用任何适用于Python的Azure库。