Azure Cosmos DB シェルの概要

Azure Cosmos DB シェルは、Azure Cosmos DB用のオープンソースのコマンド ライン インターフェイス (CLI) です。 bash のようなナビゲーションを使用してデータベースとコンテナーを探索し、クエリを実行し、データ操作を自動化します。 個別に使用するか、Visual Studio CodeのAzure Cosmos DB拡張機能から起動します。 オプションのローカル モデル コンテキスト プロトコル (MCP) サーバーは、互換性のある AI クライアントにシェル ツールを公開します。

主要な機能

  • 移動と確認。 connect、cd、ls、pwd、infoを使用してアカウントを探索します。
  • 診断と探索。 doctor、whoami、can-i、サンプリングされたschema探索を使用して、接続とアクセス許可を調査します。
  • クエリとポイント読み取り。 Azure Cosmos DBクエリを実行し、query --explainで観察されたインデックスの使用状況を調べるか、printを使用して ID とパーティション キーで項目を取得します。
  • 項目の操作。 明示的なデータベースターゲットとコンテナーターゲットを使用してドキュメントを作成、置換、修正、または削除します。
  • トランザクションと一括書き込み。 1 つのパーティションでのアトミック操作に batch を使用するか、ドライ ラン、コンカレンシー制御、再開可能なジャーナルを使用して、パーティション間の独立した操作に bulk を使用します。
  • インポートとエクスポート。 JSON ファイルまたは CSV ファイルをストリーミングし、オフラインでインポートを検証し、変換手順なしで JSON 配列をエクスポートします。
  • コンテナー管理。 インデックス作成、スループット、TTL、競合解決ポリシーを検査または変更します。
  • サーバー側プログラミングと変更フィード。 ストアド プロシージャ、ユーザー定義関数、トリガーを管理するか、watch を使用して変更を追跡します。
  • パイプラインとスクリプト。 組み込みの filterを使用して構造化 JSON を変換し、テーブルを書式設定し、変数、ループ、関数を使用してワークフローを自動化します。
  • ローカルAIとの統合。 オプションの MCP サーバーを有効にして、信頼されたクライアントがシェルの接続とアクセス許可を介してツールを使用できるようにします。
  • ターミナルのカスタマイズとトレース。 テーマを選択または編集し、OpenTelemetry トレースを有効にします。

システム要件

  • Windows、macOS、または Linux を使用し、プラットフォームに一致する x64 または ARM64 パッケージを選択します。
  • .NET グローバル ツールの場合は、.NET SDK 10.0 以降をインストールします。 自己完結型バイナリにはランタイムが含まれます。
  • エディター統合の場合は、サポートされているVisual Studio CodeバージョンとAzure Cosmos DB拡張機能をインストールします。
  • 操作に必要なアクセス許可を持つMicrosoft Entra ID、マネージド ID、またはアカウント キーを使用します。
  • マシンから目的のアカウントへのネットワーク アクセスを許可します。 シェルは、アカウント ファイアウォールやプライベート ネットワークの制限をバイパスしません。

インストール オプション

次の 3 つのインストール方法のいずれかを選択します。

  • Visual Studio Code拡張機能。 拡張機能をインストールし、Azure Cosmos DB Shell の起動を実行し、インストール フローに従います。 「Visual Studio Codeセットアップ」を参照してください。
  • .NET グローバル ツール ターミナル アクセス用の NuGet パッケージをインストールします。 インストール ガイドを参照してください。
  • 自己完結型バイナリ。 .NETをインストールせずに、プラットフォームのリリース アーカイブをダウンロードします。 インストール ガイドを参照してください。

簡単スタート

オペレーティングシステムのターミナルからシェルを起動する:

cosmosdbshell

次に、シェル内で次のコマンドを実行し、アカウント、テナント、データベース、コンテナーの値を独自の値に置き換えます。

connect https://<account-name>.documents.azure.com/ --tenant=<tenant-id>
info --format=json
ls
ls --database=MyDatabase
schema --database=MyDatabase --container=MyContainer --sample=20
query "SELECT TOP 5 c.id FROM c" --database=MyDatabase --container=MyContainer --max=5

データにアクセスする前に、アカウント ルート info 結果を確認します。 これらの読み取りでは RU が使用されます。 完全な最初のセッションとオプションのサンプル書き込みについては、「はじめに」を参照してください。

ユースケース例

  • 開発中にデータとスキーマを検査します。
  • 設定を変更する前に、ID、接続、およびアクセス許可の問題を診断します。
  • 書き込みを適用する前に、データ移行を計画して確認します。
  • 明示的なターゲットを使用してデータベース、コンテナー、およびポリシーを管理します。
  • 信頼できる AI アシスタントが、ローカル MCP を介して選択したデータベース ツールを使用できるようにします。

利用可能なディストリビューション

Distribution Location
.NET グローバル ツール NuGet.org の CosmosDBShell
Visual Studio Code 拡張機能 Visual Studio Marketplace
自己完結型バイナリとリリース ノート Azure/CosmosDBShell リリース

シェル内の version またはターミナルの cosmosdbshell --version を使用して、インストールされているバージョンを確認します。 バージョン固有の構文については、help <command> を実行します。

Documentation

サポートとフィードバック

AI ツール

これらのアクションを使用して、アシスタントでシェル機能を調べることができます。

ドキュメントのみの取得には、Microsoft Learn MCP サーバーを使用します。 コンパクト ガイド インデックスの場合は、 Shell ドキュメント インデックス (llms.txt) を使用します。 インデックスによってクローラーのアクセス許可が変更されたり、取得が保証されたりすることはありません。

シェル MCP には個別のセットアップが必要であり、構成されたアクセス許可でデータを読み取ったり変更したりできるため、承認する前にツールの呼び出しを確認してください。 資格情報や機密データを共有しないでください。

AI エージェントを接続する
認証されたデータベース操作用にシェル MCP を構成します。

Markdown として読み取る
アシスタントにコピーするためにテキストバージョンを開きます。

ChatGPT に質問する
シェルの機能と要件を確認する。

クロードに質問する
シェルの機能と要件を確認します。

ChatGPT と Claude は、パブリック記事の URL とスターター プロンプトのみを受け取ります。 ここで、サインインを求められる場合があります。 取得に失敗した場合は、Markdown テキストをコピーしてください。 これらのリンクでデータベース アクセスを構成することはできません。