使用適用於 Python 的 Azure 連結庫 (SDK)
適用於 Python 的開放原始碼 Azure 連結庫可簡化來自 Python 應用程式程式代碼的佈建、管理和使用 Azure 資源。
您真正想要知道的詳細數據
Azure 連結庫會說明如何從您在本機或雲端執行的 Python 程式代碼與 Azure 服務通訊。 (您是否可以在特定服務的範圍內執行 Python 程式代碼,取決於該服務本身目前是否支援 Python。
連結庫支援 Python 3.8 或更新版本。 如需支援 Python 版本的詳細資訊,請參閱 Azure SDK Python 版本支持原則。 如果您使用 PyPy,請確定您使用的版本至少支援先前所述的 Python 版本。
適用於 Python 的 Azure SDK 只由 180 多個與特定 Azure 服務相關的個別 Python 連結庫所組成。 “SDK” 中沒有其他工具。
當您在本機執行程式代碼時,向 Azure 進行驗證會依賴環境變數,如如何使用 Azure SDK for Python 向 Azure 服務驗證 Python 應用程式中所述。
若要使用 pip 安裝連結庫套件,請使用
pip install <library_name>
套件索引中的連結庫名稱。 若要在 conda 環境中安裝連結庫套件,請在conda install <package_name>
anaconda.org 上使用來自 Microsoft 通道的名稱。如需詳細資訊,請參閱安裝 Azure 連結庫套件。有不同的管理和客戶端連結庫(有時稱為「管理平面」和「數據平面」連結庫)。 每個集合都有不同的用途,而且由不同類型的程式代碼使用。 如需詳細資訊,請參閱本文稍後的下列各節:
連結庫的檔位於 Azure for Python 參考上 ,此參考是由 Azure 服務組織,或 以套件名稱組織的 Python API 瀏覽器。
若要自行嘗試連結庫,建議您 先設定本機開發環境。 然後,您可以嘗試下列任何獨立範例(依任何順序):範例:建立資源群組、範例:建立和使用 Azure 儲存體、範例:建立及部署 Web 應用程式、範例:建立和查詢 MySQL 資料庫,以及範例:建立虛擬機。
如需示範影片,請參閱 介紹適用於 Python 的 Azure SDK(PyCon 2021)和使用 Azure SDK 與 Azure 資源 互動(PyCon 2020)。
非必要但仍然有趣的詳細數據
由於 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/。
從 2019 年開始,我們已更新 Azure Python 連結庫,以共用常見的雲端模式,例如驗證通訊協議、記錄、追蹤、傳輸通訊協定、緩衝回應和重試。 更新的連結庫會遵循 目前的 Azure SDK 指導方針。
在 2023 年 3 月 31 日,我們淘汰了不符合目前 Azure SDK 指導方針的 Azure SDK 連結庫支援。 雖然較舊的連結庫仍可超過 2023 年 3 月 31 日使用,但將不再收到 Microsoft 的官方支援和更新。 如需詳細資訊,請參閱更新 Azure SDK 連結庫的注意事項。
若要避免遺失 Azure SDK 的安全性和效能更新,請在 2023 年 3 月 31 日前升級至 最新的 Azure SDK 連結庫 。
若要檢查哪些 Python 連結庫受到影響,請參閱 適用於 Python 的 Azure SDK 已淘汰版本。
如需我們套用至連結庫指導方針的詳細資訊,請參閱 Python 指導方針:簡介。
使用管理連結庫建立和管理 Azure 資源
SDK 的管理(或「管理平面」)連結庫,其名稱全部以 開頭azure-mgmt-
,可協助您從 Python 腳本建立、設定及管理 Azure 資源。 所有 Azure 服務都有對應的管理連結庫。 如需詳細資訊,請參閱 Azure 控制平面和數據平面。
透過管理連結庫,您可以撰寫組態和部署腳本,以執行您可以透過 Azure 入口網站 或 Azure CLI 執行的相同工作。 (如先前所述,Azure CLI 是以 Python 撰寫,並使用管理連結庫來實作其各種命令。
下列範例說明如何使用一些主要管理連結庫:
- 建立資源群組
- 列出訂用帳戶中的資源群組
- 建立 Azure 儲存體 帳戶和 Blob 記憶體容器
- 建立 Web 應用程式並將其部署至 App Service
- 建立及查詢 Azure MySQL 資料庫
- 建立虛擬機器
如需使用每個管理連結庫的詳細資訊,請參閱 SDK GitHub 存放庫中連結庫項目資料夾中的 README.md 或 README.rst 檔案。 您也可以在參考檔和Azure 範例中找到更多代碼段。
從舊版管理連結庫移轉
如果您要從舊版管理連結庫移轉程式代碼,請參閱下列詳細資料:
- 如果您使用 類別
ServicePrincipalCredentials
,請參閱 使用令牌認證進行驗證。 - 異步 API 的名稱已變更,如連結庫使用模式 - 異步操作中所述。 較新連結庫中異步 API 的名稱以 開頭
begin_
。 在大部分情況下,API 簽章會維持不變。
連線 與客戶端連結庫搭配使用 Azure 資源
SDK 的 用戶端 (或「數據平面」)連結庫可協助您撰寫 Python 應用程式程式代碼,以與已布建的服務互動。 用戶端連結庫僅適用於支援用戶端 API 的服務。
本文範例:使用 Azure 儲存體,提供使用用戶端連結庫的基本圖例。
不同的 Azure 服務也提供使用這些連結庫的範例。 如需其他連結,請參閱下列索引頁面:
如需使用每個用戶端連結庫的詳細資訊,請參閱 SDK GitHub 存放庫中連結庫項目資料夾中的 README.md 或 README.rst 檔案。 您也可以在參考檔和Azure 範例中找到更多代碼段。
取得協助並與 SDK 小組連線
- 瀏覽適用於 Python 的 Azure 連結 庫檔
- 將問題張貼至 Stack Overflow 上的 社群
- 在 GitHub 上 針對 SDK 開啟問題
- 在 Twitter 上提及@AzureSDK
- 完成 Azure SDK for Python 的簡短問卷
後續步驟
強烈建議您執行本機開發環境的一次性設定,以便輕鬆地使用任何適用於 Python 的 Azure 連結庫。