次の方法で共有


Azure MCP Server 用の Azure Event Hubs ツールの概要

Azure MCP サーバーを使用すると、自然言語プロンプトを使用して Azure Event Hubs リソースを管理できます。 特定のコマンド構文を覚える必要はありません。

Azure Event Hubs は、任意のソースから任意の宛先まで、待機時間が短い数百万のイベントを 1 秒あたりにストリーミングする、クラウド内のネイティブ データ ストリーミング サービスです。 Event Hubs は Apache Kafka と互換性があり、コードを変更せずに既存の Kafka ワークロードを実行できます。

ツール パラメーター: Azure MCP Server ツールは、タスクを完了するために必要なデータのパラメーターを定義します。 これらのパラメーターの一部は、各ツールに固有であり、以下に記載されています。 その他のパラメーターはグローバルであり、すべてのツールで共有されます。 詳細については、「 ツールパラメーター」を参照してください。

イベント ハブ: コンシューマー グループを削除する

指定したイベント ハブからコンシューマー グループを削除します。

プロンプトの例を次に示します。

  • 特定のコンシューマー グループを削除する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' からコンシューマー グループ 'analytics-group' を削除する"
  • コンシューマー グループを削除する: "リソース グループ 'my-resource-group' の名前空間 'prod-eventhubs' の Event Hub 'telemetry-events' からコンシューマー グループ 'monitoring-consumers' を削除する"
  • コンシューマー グループをクリーンアップする: "リソース グループ 'my-resource-group' の 'development-eventhubs' 名前空間の Event Hub 'user-events' からコンシューマー グループ 'test-group' を削除する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
イベント ハブ 必須 名前空間内のイベント ハブの名前。
コンシューマー グループ 必須 イベント ハブ内のコンシューマー グループの名前。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌

Event Hub: コンシューマー グループを取得する

Azure Event Hubs からコンシューマー グループを取得します。 このツールでは、次のことができます。

  • イベント ハブ内のすべてのコンシューマー グループを一覧表示する
  • 名前で 1 つのコンシューマー グループを取得する

イベント ハブと名前空間のパラメーターは、get と list の両方に必要です。 コンシューマー グループ パラメーターは、特定のコンシューマー グループを取得する場合にのみ必要です。

プロンプトの例を次に示します。

  • すべてのコンシューマー グループを一覧表示する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' 内のすべてのコンシューマー グループを一覧表示する"
  • 特定のコンシューマー グループを取得する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' からコンシューマー グループ 'analytics-group' の詳細を取得します"
  • コンシューマー グループの情報を表示する: "リソース グループ 'my-resource-group' の名前空間 'prod-eventhubs' の Event Hub 'telemetry-events' のコンシューマー グループ 'monitoring-consumers' を表示する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
イベント ハブ 必須 名前空間内のイベント ハブの名前。
コンシューマー グループ オプション イベント ハブ内のコンシューマー グループの名前。

ツール注釈ヒント:

破壊的: ❌ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ✅ |シークレット: ❌ |ローカル必須: ❌

イベント ハブ: コンシューマー グループを作成または更新する

指定したイベント ハブ内にコンシューマー グループを作成または更新します。 このツールは、新しいコンシューマー グループを作成するか、既存のコンシューマー グループを更新します。

プロンプトの例を次に示します。

  • 新しいコンシューマー グループの作成: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' に新しいコンシューマー グループ 'analytics-group' を作成する"
  • 既存のコンシューマー グループを更新する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' のコンシューマー グループ 'analytics-group' をユーザー メタデータ 'Update for Q4 analytics' で更新する"
  • コンシューマー グループを設定する: "リソース グループ 'my-resource-group' の名前空間 'prod-eventhubs' の Event Hub 'telemetry-events' でコンシューマー グループ 'monitoring-consumers' を設定する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
イベント ハブ 必須 名前空間内のイベント ハブの名前。
コンシューマー グループ 必須 イベント ハブ内のコンシューマー グループの名前。
ユーザー メタデータ オプション コンシューマー グループのユーザー メタデータ。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌

イベント ハブ: イベント ハブの削除

Azure Event Hubs 名前空間からイベント ハブを削除します。 このアクションにより、イベント ハブ内のすべてのメッセージとコンシューマー グループが完全に削除されます。

プロンプトの例を次に示します。

  • 特定のイベント ハブを削除する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' からイベント ハブ 'orders-hub' を削除する"
  • イベント ハブの削除: "リソース グループ 'my-resource-group' の 'prod-eventhubs' 名前空間からイベント ハブ 'telemetry-events' を削除する"
  • イベント ハブのクリーンアップ: "リソース グループ 'my-resource-group' の名前空間 'dev-eventhubs' からイベント ハブ 'test-events' を削除する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
イベント ハブ 必須 名前空間内のイベント ハブの名前。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌

イベント ハブ: イベント ハブを取得する

Azure 名前空間からイベント ハブを取得します。 このツール:

  • 名前空間内のすべてのイベント ハブを一覧表示する
  • 名前で 1 つのイベント ハブを取得する

1 つのイベント ハブを取得するか、複数のイベント ハブを一覧表示すると、パーティション数、設定、メタデータなど、すべてのイベント ハブの詳細情報が返されます。

プロンプトの例を次に示します。

  • すべての Event Hubs を一覧表示する: "リソース グループ 'my-resource-group' の 'prod-eventhubs' 名前空間内のすべての Event Hubs を一覧表示する"
  • 特定のイベント ハブを取得する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の Event Hub 'orders-hub' の詳細を取得する"
  • イベント ハブの情報を表示する: "リソース グループ 'my-resource-group' の名前空間 'monitoring-hubs' からのイベント ハブ 'telemetry-events' を表示する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
イベント ハブ オプション 名前空間内のイベント ハブの名前。

ツール注釈ヒント:

破壊的: ❌ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ✅ |シークレット: ❌ |ローカル必須: ❌

イベント ハブ: イベント ハブを作成または更新する

Azure Event Hubs 名前空間内にイベント ハブを作成または更新します。 このコマンドは、次の操作を行います。

  • 新しいイベント ハブが存在しない場合は作成します
  • 既存のイベント ハブの構成を更新します

次のプロパティを構成できます。

  • パーティション数 (並列処理用のパーティションの数)
  • メッセージの保持時間 (メッセージの保持期間 (時間単位)

パーティション数などの一部のプロパティは、作成後に変更できません。 これは、完了を待機する実行時間が長くなる可能性がある操作です。

プロンプトの例を次に示します。

  • 新しいイベント ハブの作成: "リソース グループ 'my-resource-group' の名前空間 'production-eventhubs' に新しいイベント ハブ 'orders-hub' を作成する"
  • 既存のイベント ハブを更新する: "リソース グループ 'my-resource-group' の名前空間 'monitoring-hubs' のイベント ハブ 'telemetry-events' を更新する"
  • 構成を使用して作成する: "4 つのパーティションと 24 時間のメッセージリテンション期間を持つリソース グループ 'my-resource-group' の名前空間 'analytics-hubs' にイベント ハブ 'user-activity' を作成する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。 リソース グループ パラメーターと共に使用する必要があります。
イベント ハブ 必須 名前空間内のイベント ハブの名前。
パーティション数 オプション イベント ハブのパーティションの数。 132の間 (または名前空間レベルに基づく以上) である必要があります。
メッセージのリテンション期間 (時間単位) オプション メッセージの保持時間 (時間単位)。 最小値は 1 時間です。最大値は名前空間レベルによって異なります。
地位 オプション イベント ハブの状態 ( ActiveDisabledなど)。 一部の操作では、状態が読み取り専用になる場合があります。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌

名前空間: 名前空間を削除する

Event Hubs 名前空間を削除します。 この操作は元に戻すことができません。名前空間内のすべてのイベント ハブ、コンシューマー グループ、および構成が完全に削除されます。

プロンプトの例を次に示します。

  • 特定の名前空間を削除する: "リソース グループ 'my-resource-group' のイベント ハブ名前空間 'eventhub-prod' を削除する"
  • 名前空間の削除: "リソース グループ 'my-resource-group' の Event Hubs 名前空間 'test-eventhubs' を削除する"
  • 名前空間をクリーンアップする: "リソース グループ 'my-resource-group' の名前空間 'dev-eventhubs' を完全に削除する"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌

名前空間: 名前空間を取得する

Azure から Event Hubs 名前空間を取得します。 動作は、指定するパラメーターによって異なります。 1 つの名前空間を取得すると、SKU、設定、メタデータなどの詳細情報が返されます。 名前空間を一覧表示すると、指定したスコープ内のすべての名前空間に対して同じ詳細情報が返されます。

プロンプトの例を次に示します。

  • すべての名前空間を一覧表示する: "サブスクリプション内のすべてのイベント ハブ名前空間を一覧表示する"
  • 特定の名前空間を取得する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' の詳細を取得する"
  • 名前空間情報を表示する: "リソース グループ 'my-resource-group' の詳細に名前空間 'monitoring-hubs' を表示する"
パラメーター 必須または省略可能 Description
リソース グループ オプション Azure リソース グループの名前。 省略すると、システムはサブスクリプション内のすべての名前空間を一覧表示します。 名前空間を指定しない場合、システムはリソース グループ内のすべての名前空間を一覧表示します。 特定の名前空間を取得するときに必要です。
名前空間 オプション 取得する Event Hubs 名前空間の名前。 指定すると、特定の名前空間の詳細情報が返されます (リソース グループが必要です)。 省略すると、名前空間の一覧が返されます。

ツール注釈ヒント:

破壊的: ❌ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ✅ |シークレット: ❌ |ローカル必須: ❌

名前空間: 名前空間を作成または更新する

指定したリソース グループ内に名前空間を作成または更新します。 このツールは、新しい名前空間を作成するか、既存の名前空間を更新します。 このツールは既存の構成を変更する可能性があり、破壊的と見なされます。 このツールには時間がかかる場合があります。

既存の名前空間を更新するときは、変更するプロパティのみを指定します。 指定されていないプロパティは、既存の値を保持します。 少なくとも 1 つの更新プロパティを指定する必要があります。

一般的な更新シナリオは次のとおりです。

  • SKU レベルまたは容量を変更してスケールアップまたはスケールダウンする
  • 自動インフレを有効または無効にし、最大スループット ユニットを設定する
  • Kafka サポートを有効または無効にする
  • リソース管理のタグを変更する
  • ゾーン冗長の有効化または無効化 (Premium SKU のみ)

プロンプトの例を次に示します。

  • 新しい名前空間を作成する: "米国東部のリソース グループ 'my-resource-group' に新しい Event Hubs 名前空間 'production-events' を作成する"
  • 名前空間の容量を更新する: "リソース グループ 'my-resource-group' の名前空間 'eventhub-prod' を更新して容量を 10 スループット ユニットに増やす"
  • Kafka のサポートを有効にする: "リソース グループ 'my-resource-group' で Event Hubs 名前空間 'monitoring-hubs' で Kafka を有効にする"
パラメーター 必須または省略可能 Description
リソース グループ 必須 Azure リソース グループの名前。 これは Azure リソースの論理コンテナーです。
名前空間 必須 Event Hubs 名前空間の名前。
場所 オプション 名前空間が配置されている Azure リージョン (たとえば、 eastuswestus2)。
SKU 名 オプション 名前空間の SKU 名。 有効な値: BasicStandardPremium
SKU レベル オプション 名前空間の SKU レベル。 有効な値: BasicStandardPremium
SKU 容量 オプション 名前空間の SKU 容量 (スループット ユニット)。 有効な範囲は SKU によって異なります。
自動インフレが有効になっているか オプション 名前空間の自動インフレを有効または無効にします。
最大スループット ユニット オプション 自動インフレが有効になっている場合の最大スループット ユニット。
Kafka が有効 オプション 名前空間の Kafka を有効または無効にします。
ゾーン冗長 オプション 名前空間のゾーン冗長を有効または無効にします。
タグ オプション JSON 形式の名前空間のタグ (たとえば、 {"key1":"value1","key2":"value2"})。

ツール注釈ヒント:

破壊的: ✅ |べき等: ✅ |オープンワールド: ❌ |読み取り専用: ❌ |シークレット: ❌ |ローカル必須: ❌