Python を使用して Azure Cosmos DB for NoSQL の使用を開始する
適用対象: 
NoSQL
この記事では、Python SDK を使用して Azure Cosmos DB for NoSQL に接続する方法を示します。 接続すると、データベース、コンテナー、および項目に対する操作を実行できます。
パッケージ (PyPi) | サンプル | API リファレンス | ライブラリ ソース コード | フィードバックを送る
前提条件
- アクティブなサブスクリプションが含まれる Azure アカウント。 無料でアカウントを作成できます。
- Azure Cosmos DB for NoSQL アカウント。 NoSQL 用 API アカウントを作成します。
- Python 3.7 以降
- Azure コマンド ライン インターフェイス (CLI) または Azure PowerShell
プロジェクトの設定
Python コードを実行できる環境を作成します。
仮想環境では、システムの残りの部分に影響を与えることなく、分離された環境に Python パッケージをインストールできます。
仮想環境に Azure Cosmos DB for NoSQL Python SDK をインストールします。
pip install azure-cosmos
Python アプリケーションを作成する
ご使用の環境で、新しい app.py ファイルを作成し、それに次のコードを追加します。
import json
import os
import sys
import uuid
from azure.core.exceptions import AzureError
from azure.cosmos import CosmosClient, PartitionKey
上記のコードにより、記事の残りの部分で使用するモジュールがインポートされます。
Azure Cosmos DB for NoSQL に接続する
Azure Cosmos DB の NoSQL 用 API に接続するには、CosmosClient クラスのインスタンスを作成します。 このクラスは、データベースに対するすべての操作を実行するための開始点です。
Microsoft Entra を使用して NoSQL 用 API アカウントに接続するには、セキュリティ プリンシパルを使用します。 プリンシパルの正確な種類は、アプリケーション コードをホストする場所によって異なります。 次の表は、クイック リファレンス ガイドとして機能します。
| アプリケーションの実行場所 | セキュリティ プリンシパル |
|---|---|
| ローカル コンピューター (開発とテスト) | ユーザー ID またはサービス プリンシパル |
| Azure | マネージド ID |
| Azure の外部にあるサーバーまたはクライアント | サービス プリンシパル |
Azure.Identity のインポート
azure-identity パッケージには、すべての Azure SDK ライブラリ間で共有されるコア認証機能が含まれています。
azure-identity パッケージをご使用の環境にインポートします。
pip install azure-identity
既定の資格情報の実装を使用して CosmosClient を作成する
ローカル コンピューター上でテストする場合、またはマネージド ID を直接サポートする Azure サービス上でアプリケーションを実行する場合は、DefaultAzureCredential インスタンスを作成して OAuth トークンを取得します。
ご使用の "app.py" で次のようにします。
アカウントに接続するためのエンドポイントを取得し、それを環境変数
COSMOS_ENDPOINTとして設定します。DefaultAzureCredential をインポートし、そのインスタンスを作成します。
ENDPOINT と credential をパラメーターとして指定して、CosmosClient クラスの新しいインスタンスを作成します。
from azure.identity import DefaultAzureCredential
ENDPOINT = os.environ["COSMOS_ENDPOINT"]
credential = DefaultAzureCredential()
client = CosmosClient(ENDPOINT, credential)
重要
DefaultAzureCredential を有効にするための正しいロールを追加する方法の詳細については、「Microsoft Entra ID を使用して Azure Cosmos DB アカウントのロールベースのアクセス制御を構成する」を参照してください。 特に、ロールの作成とそれらのプリンシパル ID への割り当てに関するセクションを参照してください。
アプリケーションをビルドする
アプリケーションをビルドすると、コードは主に 4 種類のリソースと対話します。
NoSQL 用 API アカウント。これは、Azure Cosmos DB データに対する一意で最上位の名前空間です。
アカウント内のコンテナーを整理するデータベース。
データベース内の個々の項目のセットを含むコンテナー。
コンテナー内の JSON ドキュメントを表す項目。
次の図に、これらのリソースの関係を示します。
上部に Azure Cosmos DB アカウントを示す階層図。 アカウントには 2 つの子データベース ノードがあります。 一方のデータベース ノードには、2 つの子コンテナー ノードが含まれています。 もう一方のデータベース ノードには、1 つの子コンテナー ノードが含まれています。 その 1 つのコンテナー ノードには、3 つの子項目ノードがあります。
各種類のリソースは、1 つまたは複数の関連付けられた Python クラスによって表されます。 同期プログラミングの最も一般的なクラスの一覧を次に示します。 (azure.cosmos.aio 名前空間の下には、非同期プログラミング用の同様のクラスがあります)。
| クラス | 説明 |
|---|---|
CosmosClient |
このクラスは、Azure Cosmos DB サービスのクライアント側の論理表現を提供します。 このクライアント オブジェクトは、サービスに対する要求の構成と実行に使用されます。 |
DatabaseProxy |
サービスに存在する (または、まだ存在しない) 場合があるデータベースへのインターフェイス。 このクラスは、直接インスタンス化しないでください。 代わりに、CosmosClient get_database_client メソッドを使用する必要があります。 |
ContainerProxy |
特定の Cosmos DB コンテナーと対話するためのインターフェイス。 このクラスは、直接インスタンス化しないでください。 代わりに、DatabaseProxy get_container_client メソッドを使用して既存のコンテナーを取得するか、create_container メソッドを使用して新しいコンテナーを作成します。 |
次のガイドでは、これらの各クラスを使ってアプリケーションをビルドする方法を示します。
| ガイド | 説明 |
|---|---|
| データベースの作成 | データベースを作成する |
| コンテナーの作成 | コンテナーを作成する |
| 項目の例 | 特定の項目のポイント読み取り |