Python 用のオープン ソースの Azure ライブラリにより、Python アプリケーション コードからの Azure リソースのプロビジョニング、管理、および使用が簡略化されます。
本当に知りたい詳細
Azure ライブラリは、ローカルまたはクラウドで実行する Python コード から Azure サービスと通信する方法です。 (特定のサービスのスコープ内で Python コードを実行できるかどうかは、そのサービス自体が現在 Python をサポートしているかどうかによって異なります)。
ライブラリは Python 3.8 以降をサポートしています。 サポートされているバージョンの Python の詳細については、 Azure SDK Python バージョンのサポート ポリシーに関するページを参照してください。 PyPy を使用している場合は、少なくとも使用するバージョンが、前に説明した Python バージョンをサポートしていることを確認してください。
Azure SDK for Python は、特定の Azure サービスに関連する 180 を超える個々の Python ライブラリのみで構成されています。 SDK には他のツールはありません。
コードをローカルで実行する場合、Azure での認証は、「Azure SDK for Python を使用して Azure サービスに対して Python アプリを認証する方法」の説明に従って環境変数に依存します。
pip を使用してライブラリ パッケージをインストールするには、
pip install <library_name>
のライブラリ名を使用してを使用します。 conda 環境にライブラリ パッケージをインストールするには、anaconda.orgconda install <package_name>
の名前を使用してを使用します。詳細については、「Azure ライブラリ パッケージのインストール」を参照してください。個別の 管理 ライブラリと クライアント ライブラリがあります ("管理プレーン" ライブラリと "データ プレーン" ライブラリとも呼ばれます)。 各セットは異なる目的を果たし、さまざまな種類のコードで使用されます。 詳細については、この記事で後述する以下のセクションを参照してください。
ライブラリのドキュメントは、Azure サービス別に整理された Azure for Python リファレンス、またはパッケージ名別に整理された Python API ブラウザーに記載されています。
自分でライブラリを試すには、まず ローカル開発環境を設定することをお勧めします。 その後、(任意の順序で) 次のスタンドアロンの例のいずれかを試すことができます。 例: リソース グループの作成、 例: Azure Storage の作成と使用、 例: Web アプリの作成とデプロイ、 例: MySQL データベースの作成とクエリ、 例: 仮想マシンの作成。
デモ ビデオについては、 Azure SDK for Python (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 を直接使用できます。
Azure ライブラリのソース コードは、 https://github.com/Azure/azure-sdk-for-pythonにあります。 オープンソースプロジェクトとして、貢献は歓迎されています!
テスト対象ではない 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 ライブラリを確認するには、「 Azure SDK Deprecated Releases for Python」を参照してください。
ライブラリに適用されるガイドラインの詳細については、 Python ガイドライン: 概要を参照してください。
管理ライブラリを使用して Azure リソースを作成および管理する
SDK の 管理 ("管理プレーン") ライブラリ。名前はすべて azure-mgmt-
で始まり、Python スクリプトから Azure リソースを作成、構成、管理するのに役立ちます。 すべての Azure サービスには、対応する管理ライブラリがあります。 詳細については、「Azure コントロール プレーンとデータ プレーン」を参照してください。
管理ライブラリを使用すると、構成スクリプトとデプロイ スクリプトを記述して、Azure portal または Azure CLIで実行できるのと同じタスクを実行できます。 (前述のように、Azure CLI は Python で記述され、管理ライブラリを使用してさまざまなコマンドを実装します)。
次の例は、プライマリ管理ライブラリの一部を使用する方法を示しています。
- リソース グループを作成します
- サブスクリプション内のリソース グループを一覧表示する
- Azure Storage アカウントと BLOB ストレージ コンテナーを作成する
- Web アプリを作成して App Service にデプロイする
- Azure MySQL データベースを作成してクエリを実行する
- 仮想マシン を作成する
各管理ライブラリの操作の詳細については、SDK GitHub リポジトリのライブラリのプロジェクト フォルダーにある README.md または README.rst ファイルを参照してください。 その他のコード スニペットについては、リファレンス ドキュメントの と Azure サンプルを参照してください。
古い管理ライブラリからの移行
古いバージョンの管理ライブラリからコードを移行する場合は、次の詳細を参照してください。
-
ServicePrincipalCredentials
クラスを使用する場合は、「トークン資格情報を使用した認証」を参照してください。 - 非同期 API の名前は、 ライブラリの使用パターン (非同期操作) に関する説明に従って変更されています。 新しいライブラリの非同期 API の名前は、
begin_
で始まります。 ほとんどの場合、API 署名は変わりません。
クライアント ライブラリで Azure リソースに接続して使用する
SDK の クライアント (または "データ プレーン") ライブラリは、既にプロビジョニングされているサービスと対話するための Python アプリケーション コードを記述するのに役立ちます。 クライアント ライブラリは、クライアント API をサポートするサービスにのみ存在します。
記事 「例: Azure Storage を使用する」では、クライアント ライブラリを使用する基本的な図を示します。
さまざまな Azure サービスでも、これらのライブラリを使用した例が提供されます。 その他のリンクについては、次のインデックス ページを参照してください。
各クライアント ライブラリの操作の詳細については、SDK の GitHub リポジトリにあるライブラリのプロジェクト フォルダーにある README.md または README.rst ファイルを参照してください。 その他のコード スニペットについては、リファレンス ドキュメントの と Azure サンプルを参照してください。
ヘルプを取得して SDK チームと連絡を取る
- Python 用 Azure ライブラリのドキュメントにアクセスする
- Stack Overflow でコミュニティに質問を投稿する
- GitHub で SDK に対する問題を開く
- Twitter で@AzureSDK をメンションする
- Azure SDK for Python に関する短いアンケートを完了する
次のステップ
Python 用の Azure ライブラリを簡単に使用できるように、ローカル開発環境の 1 回限りのセットアップを行うことを強くお勧めします。