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 を使用することができます。 ただし、REST API は、必要に応じていつでも Python コードから直接使用できます。

  • Azure ライブラリのソース コードは、https://github.com/Azure/azure-sdk-for-python にあります。 オープンソース プロジェクトとして、皆さんの参加を歓迎します。

  • ライブラリは、IronPython や Jython などのインタープリターと共に使用できますが、それらに対するテストは行われていません。個別の問題や非互換性が発生する場合があります。

  • ライブラリ API リファレンス ドキュメントのソース リポジトリは、https://github.com/MicrosoftDocs/azure-docs-sdk-python/ にあります。

  • 現在、認証プロトコル、ログ記録、トレース、トランスポート プロトコル、バッファーされた応答、再試行などの一般的なクラウド パターンを共有するために、Python 用 Azure ライブラリを更新しています。

    • この共有機能は、azure-core ライブラリに含まれています。

    • Core ライブラリで現在動作しているライブラリは、Azure SDK for Python の最新リリース ページに記載されています。 これらのライブラリ (主にクライアント ライブラリ) は、"track 2" と呼ばれることがあります。

    • 管理ライブラリと、まだ更新されていないその他のものは、"track 1" と呼ばれることがあります。

  • ライブラリに適用されているガイドラインについて詳しくは、「Python ガイドライン: 概要」を参照してください。

管理ライブラリを使用して Azure リソースをプロビジョニングし、管理する

SDK の "管理" ("管理プレーン") ライブラリは、いずれも名前が azure-mgmt- で始まります。これは、Azure リソースの作成とプロビジョニング、その他管理を Python スクリプトから行うのに役立ちます。 すべての Azure サービスには、対応する管理ライブラリがあります。

管理ライブラリを使用すると、Azure portal または Azure CLI で行うのと同じタスクを実行する構成またはデプロイのスクリプトを作成することができます。 (既に述べたように、Azure CLI は Python で記述されており、その各種コマンドは管理ライブラリを使用して実装されています。)

次の例は、いくつかの主要な管理ライブラリを使用する方法を示しています。

各管理ライブラリでの操作の詳細については、SDK GitHub リポジトリ内のライブラリのプロジェクト フォルダーにある README.md または README.rst ファイルを参照してください。 また、その他のコード スニペットについては、リファレンス ドキュメントおよび Azure のサンプルで確認できます。

古い管理ライブラリからの移行

以前のバージョンの管理ライブラリからコードを移行する場合は、次の詳細を参照してください。

クライアント ライブラリを使用して Azure リソースに接続し、そのリソースを使用する

SDK の "クライアント" ("データ プレーン") ライブラリを使用すると、既にプロビジョニングされたサービスとやり取りする Python アプリケーション コードを記述するのに役立ちます。 クライアント ライブラリは、クライアント API をサポートするサービスに対してのみ存在します。

例:Azure Storage の使用に関する記事に、クライアント ライブラリの使用の基本的な説明が提供されています。

これらのライブラリを使用した例は、さまざまな Azure サービスでも提供されています。 その他のリンクについては、次のインデックス ページを参照してください。

各クライアント ライブラリでの操作の詳細については、SDK の GitHub リポジトリ内のライブラリのプロジェクト フォルダーにある README.md または README.rst ファイルを参照してください。 また、その他のコード スニペットについては、リファレンス ドキュメントおよび Azure のサンプルで確認できます。

SDK チームによるサポートと連絡先

次のステップ

任意の Python 用 Azure ライブラリを簡単に使用できるように、ローカル開発環境の 1 回限りの設定を行うことを強くお勧めします。