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/ にあります。

  • 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 で記述されており、その各種コマンドは管理ライブラリを使用して実装されています。)

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

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

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

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

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

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

記事「 例: Azure Storage を使用する」では、クライアント ライブラリを使用する基本的な図を示します。

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

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

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

次のステップ

任意の Python 用 Azure ライブラリを簡単に使用できるように、ローカル開発環境の一時的なセットアップを行うことを強くお勧めします。

ローカル開発環境を設定する>>>