mcpField
E
eventstream-cli

eventstream-cli

github.com/microsoftデータ・データベース1.3k97 回インストール3 週間前に更新
リポジトリ

eventstream-cli について

eventstream-cliは、Fabric Eventstreamのリアルタイム取り込みトポロジーを管理するコマンドラインスキルです。作成・変更と読み取り専用の確認に対応し、ソース、オペレーター、宛先、ルーティング、保持設定、スループット、稼働状態を扱います。

主な機能

  1. 01Eventstreamトポロジーの作成と更新
  2. 02ソース、オペレーター、宛先の管理
  3. 03ルーティングと保持設定の構成
  4. 04スループットとノードの状態確認
  5. 05Eventstreamの一時停止、再開、削除

活用シーン

  1. 01イベント取り込みトポロジーの構築
  2. 02ソースと宛先の追加や接続
  3. 03トポロジーの状態とスループットの確認
  4. 04保持設定と接続メタデータの確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/microsoft/skills-for-fabric --skill eventstream-cli

インストール後、Claude Code で/eventstream-cliを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

apm.yml
references/
authoring.md
consumption.md

詳細

テレメトリ — 必須。 すべての api.fabric.microsoft.com 呼び出しには x-ms-fabric-skill: eventstream-cli を付与する必要があります(az rest の場合は --headers "x-ms-fabric-skill=eventstream-cli")。 すべての LRO ポーリング、fabric_lro、リトライにも適用されます。スニペットでは省略されていますが、必ず追加してください。

重要な注意事項

  1. ワークスペース名から詳細(ID を含む)を確認するには、すべてのワークスペースを一覧表示してから、JMESPath フィルタリングを使用してください
  2. ワークスペース ID、アイテムの種類、アイテム名からアイテムの詳細(ID を含む)を確認するには、そのワークスペース内にある該当種類のアイテムをすべて一覧表示してから、JMESPath フィルタリングを使用してください
  3. スキルの使い分け:Eventstream アイテム自体(ソースからオペレーターを経て宛先に至るイベントの流れ)には eventstream-cli を使用してください。Eventhouse/KQL Database に到着したデータのクエリや整形には、対応する eventhouse-cli モードを使用してください。アラートには、対応する Activator の作成または利用スキルを使用してください。

Fabric Eventstream -- CLI スキル

このスキルは、ソース、オペレーター、宛先、ルーティング、保持、正常性など、Fabric Eventstream のリアルタイム取り込みトポロジを担当します。

これはモードディスパッチャーであり、手順は含まれていません。以下の表からリクエストに合ったモードを選択し、コマンドを1つでも実行する前に、ファイル読み取りツールで対応する references/<mode>.md ファイルを最初から最後まで読んでください。そのファイルにはエンドポイント、ペイロード形式、テンプレート、注意事項が記載されています。読まずに操作すると、誤ったペイロードや結果につながります。

モードの選択

モード次のようなリクエストの場合に使用リクエストの例最初に読むファイル
authoringEventstream トポロジを作成、更新、接続、一時停止、再開、削除するeventstream の作成、トポロジのデプロイ、ソースの追加、フィルターオペレーターの追加、宛先の接続、定義の更新references/authoring.md
consumptionEventstream、トポロジ、保持、スループット、ノードの正常性、Custom Endpoint の接続メタデータを一覧表示または確認するeventstream の一覧表示、トポロジの確認、eventstream の状態、保持、スループット、接続文字列references/consumption.md
モード境界ルール

consumption は Eventstream の定義とトポロジについて読み取り専用です。Eventstream の作成、更新、削除、一時停止、再開を求めるリクエストには authoring が必要です。その旨を伝え、references/authoring.md を読んでから進めてください。

作成・更新操作の前に、該当するソース、宛先、変換、保持、スループットの要件を確認してください。一般的なリクエストにこれらが指定されていない場合、トポロジを推測するのではなく、ワークスペースの状態を確認したり API を呼び出したりする前に、簡潔な確認質問を1つしてください。

リクエストが実際に複数のモードにまたがる場合は、1つずつ処理し、それぞれの作業を始める前に対応するリファレンスを読んでください。この表を読んでもモードが曖昧な場合は、推測せず、短い確認質問を1つしてください。

最後に行う書き込み — 省略してはならないステップ

リファレンスを読み、トポロジを計画しただけでは、タスクは完了していません。変更を行うモードはそれぞれ、最後に状態を変更する呼び出しを1回実行します。これを実行していない場合、何も永続化されていません。成功したと報告せず、その旨を明示してください。

モード最後に行う書き込み
authoring作成には POST /v1/workspaces/{ws}/items または /eventstreams、トポロジ変更の永続化には POST .../updateDefinition、ライフサイクル制御には本文なしの POST .../pause または必須の JSON startType 本文を指定した POST .../resume、アイテムの削除には DELETE .../eventstreams/{id} を使用します。eventstream.json の作成や Base64 エンコードは書き込みではありません。
consumptionなし — このモードは読み取り専用です

作成・更新タスクの完了を報告する前に、最後の呼び出しが成功したことを確認してください。また、リファレンスに検証手順が記載されている場合は、定義または実行時のトポロジを読み戻してください。

共通の必須事項(すべてのモード)

まずワークスペースと Eventstream を特定してください。すべてのモードで必要です。

タスク参照先備考
Fabric でワークスペースとアイテムを探すCOMMON-CLI.md必須 — ワークスペースまたはアイテムの ID を特定する前にお読みください
Fabric のトポロジと主要な概念COMMON-CORE.mdアイテムの種類、ワークスペース、容量
環境 URLCOMMON-CORE.mdソブリンクラウド/非パブリッククラウドのホスト
認証とトークンの取得COMMON-CORE.mdオーディエンスが異なると 401 になります。認証の問題が発生した場合はお読みください
認証の手順COMMON-CLI.mdaz login のフローとトークンの取得
コア制御プレーン REST APICOMMON-CORE.mdページネーション、LRO のポーリング、レート制限
注意点とトラブルシューティングCOMMON-CLI.mdaz rest のオーディエンス、シェルのエスケープ、トークンの有効期限

ルール

必須
  • 何かを行う前に、上の表からモードを 1 つだけ選択してください。
  • そのモードの最初のコマンドを実行する前に、最初のツール呼び出しとして references/<mode>.md を最初から最後まで読んでください。
  • ワークスペースと Eventstream の ID は、一覧表示して絞り込むことで特定してください。GUID を推測してはいけません。
  • 依頼が境界を越えてモードを切り替える場合は、切り替えることを明示してください。
  • 参照資料は手順として扱い、成果物として扱ってはいけません。読んだ後、記載されたコマンドを実際のワークスペースに対して実行し、実際の結果を報告してください。
  • オーサリングノード名は英数字の PascalCase にしてください。ただし、プラットフォームが生成する DefaultStream 名は例外です。
  • Custom Endpoint の資格情報を取得する前に、ユーザーから明示的な確認を得てください。また、ユーザーが安全なコンテキストで明示的に要求しない限り、生のキーや接続文字列を表示してはいけません。
推奨
  • 依頼を満たす最も限定的なモードを選んでください。
  • モードの参照資料は 1 つだけ読んでください。依頼が本当に複数のモードにまたがる場合に限り、2 つ目を読み、その前にその旨を伝えてください。
  • ヘルス状態や接続の確認にはランタイムトポロジを使用し、オーサリング時のグラフ構造や変更にはデコード済みの定義を使用してください。
避けること
  • このディスパッチャーだけに基づいて作業すること。ここでは意図的に運用上の詳細を省略しています。
  • 参照資料の内容を要約するだけで、手順を実行せずに回答すること。
  • 読み取り専用の利用モードで何かを変更すること。
  • Eventstream API を使って取り込み済みイベントデータをクエリすること。読み取り専用の KQL データには、利用モードの eventhouse-cli を使用してください。
  • このスキルが担当する作業に別のスキルを読み込むこと(CRITICAL NOTES 3 を参照)。

例

ユーザーの依頼モード読む参照資料
「SampleData ソースと Lakehouse 宛先を持つ Eventstream を作成してください。」authoringreferences/authoring.md
「Eventstream に温度が 30 を超える場合のフィルターを追加してください。」authoringreferences/authoring.md
「SensorIngestion のすべてのソース、オペレーター、宛先を表示してください。」consumptionreferences/consumption.md
「この Eventstream の保持期間とスループット設定を教えてください。」consumptionreferences/consumption.md

コメント