次の方法で共有

API プラグインをローカルでデバッグする

API プラグインを使用すると、Microsoft 365 Copilotの宣言型エージェントが REST API を呼び出してデータを取得し、タスクを実行できます。 ただし、これらの API にアクセスするには、インターネット経由でアドレス指定可能なサーバーでホストMicrosoft 365 Copilot必要があります。 通常、デバッグ ツールはデバッグ セッションを localhost (127.0.0.1) でホストします。これは、デバッグ ツールを実行しているコンピューターからのみアクセスできます。 開発トンネルなどのリバース プロキシを使用すると、デバッグ セッションをインターネットに公開して、Microsoft 365 Copilotからの呼び出しのデバッグを有効にすることができます。

この記事では、 devtunnel ツールを使用して API のローカル デバッグを有効にする方法について説明します。

注:

デバッグ ツールでリバース プロキシ ソリューションが既に提供されている場合があります。 確認するには、開発者ツールのドキュメントを確認することをお勧めします。 たとえば、Microsoft 365 Agents Toolkit を使用して新しい API を作成した場合、ツールキットはリバース プロキシの構成を自動的に処理します。

前提条件

  • デバッグ セッションをホストするコンピューターにインストールされているdevtunnel CLI
  • デバッグ ツールで使用される HTTP ポート番号

永続的な開発トンネルを作成する

devtunnel CLI を使用すると、永続的な開発トンネル (ホストされた URL を変更せずに必要に応じて停止して開始できるトンネル) を作成できます。 永続的な URL でトンネルを使用すると、宣言型エージェント アプリ パッケージを新しい URL で更新する必要がないため、API プラグインのデバッグが簡略化されます。

  1. devtunnel CLI にまだログインしていない場合は、 devtunnel user login --help を使用して使用可能なオプションを確認します。 続行する前に、CLI にログインします。

  2. 匿名アクセスを許可するトンネルを作成します。 匿名アクセスは、Microsoft 365 Copilotがトンネルにアクセスできるようにするために必要であり、API で必要な認証とは無関係です。

    devtunnel create --allow-anonymous

    ヒント

    新しいトンネルを作成すると、既定のトンネルが新しく作成されたトンネルに切り替えられます。 これにより、後続のコマンドに tunnel-id 引数を省略できます。 複数のトンネルを作成する場合は、予期されるトンネルを使用していることを確認するために、 tunnel-id 引数を使用する必要がある場合があります。 詳細については、 devtunnel --help コマンドを使用するか、「 Dev tunnels コマンド ライン リファレンス」を参照してください。

  3. デバッグ ツールで使用される HTTP ポート番号を追加します。 <port>をポート番号に置き換え、デバッグ ツールがポートで HTTPS を使用している場合は --protocol パラメーターを https に設定し、HTTPS を使用していない場合はhttpします。

    devtunnel port create --port-number <port> --protocol https

  4. 開発トンネルを開始します。

    devtunnel host

  5. この開発トンネルを初めて実行する場合は、 ブラウザー経由で Connect というラベルの URL をコピーします。 ブラウザーでこの URL を開き、[ 続行 ] を選択してトンネルを有効にします。

    注:

    [続行] を選択すると、ブラウザーにエラーが表示されます。 これは想定されており、無視できます。

  6. URL を API ベース URL として保存します。

トンネルが有効になると、 Ctrl + C キーを押してトンネルを停止できます。トンネルは、 devtunnel host host-id コマンドを使用して再起動できます。

開発トンネルの使用

デバッグに開発トンネルを使用するには、 servers 配列で開発トンネルの URL を使用する OpenAPI 仕様のアプリ パッケージをサイドロードする必要があります。 詳細については、 OpenAPI リファレンスを参照してください。

servers:
  - url: <your-dev-tunnel-url>

Visual Studio Code で Agents Toolkit を使用して宣言型エージェントを管理している場合は、OPENAPI_SERVER_URL という名前の /env/.env.dev.user ファイルに環境変数を追加し、その環境変数を使用するように OpenAPI 仕様を更新できます。 [ライフサイクル] ウィンドウの [プロビジョニング] ステップを使用して、エージェントをサイドロードします。

OpenAPI 仕様で、次を追加します。

servers:
  - url: ${{OPENAPI_SERVER_URL}}

/env/.env.dev.user ファイルに次を追加します。

OPENAPI_SERVER_URL=<your-dev-tunnel-url>

Agents Toolkit を使用していない場合は、新しいアプリ パッケージ ZIP ファイルを生成し、 エージェントをアップロードできます。

  • Last updated on