Event Grid ソースとしての Azure Event Grid 名前空間 (プレビュー)

  • [アーティクル]

この記事では、Azure Event Grid 名前空間のイベントのプロパティとスキーマについて説明します。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。

使用可能なイベントの種類

Azure Event Grid 名前空間 (プレビュー) は、次のイベントの種類を生成します。

イベントの種類 説明
Microsoft.EventGrid.MQTTClientSessionConnected MQTT クライアントのセッションが Event Grid に接続されたときに発行されます。
Microsoft.EventGrid.MQTTClientSessionDisconnected MQTT クライアントのセッションが Event Grid から切断されたときに発行されます。
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Event Grid 名前空間で MQTT クライアントが作成または更新されたときに発行されます。
Microsoft.EventGrid.MQTTClientDeleted MQTT クライアントが Event Grid 名前空間から削除されたときに発行されます。

イベントの例

このサンプル イベントは、MQTT クライアントのセッションが Event Grid に接続されたときに発生するイベントのスキーマを示しています。

[{
  "specversion": "1.0",
  "id": "5249c38a-a048-46dd-8f60-df34fcdab06c",
  "time": "2023-07-29T01:23:49.6454046Z",
  "type": "Microsoft.EventGrid.MQTTClientSessionConnected",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1/sessions/session1",
  "data": {
    "namespaceName": "myns",
    "clientAuthenticationName": "client1",
    "clientSessionName": "session1",
    "sequenceNumber": 1
  }
}]

このサンプル イベントは、MQTT クライアントのセッションが Event Grid から切断されたときに発生するイベントのスキーマを示しています。

[{
  "specversion": "1.0",
  "id": "e30e5174-787d-4e19-8812-580148bfcf7b",
  "time": "2023-07-29T01:27:40.2446871Z",
  "type": "Microsoft.EventGrid.MQTTClientSessionDisconnected",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1/sessions/session1",
  "data": {
    "namespaceName": "myns",
    "clientAuthenticationName": "client1",
    "clientSessionName": "session1",
    "sequenceNumber": 1,
    "disconnectionReason": "ClientInitiatedDisconnect"
  }
}]

このサンプル イベントは、Event Grid 名前空間で MQTT クライアントが作成または更新されたときに発生するイベントのスキーマを示しています。

[{
  "specversion": "1.0",
  "id": "383d1562-c95f-4095-936c-688e72c6b2bb",
  "time": "2023-07-29T01:14:35.8928724Z",
  "type": "Microsoft.EventGrid.MQTTClientCreatedOrUpdated",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1",
  "data": {
    "createdOn": "2023-07-29T01:14:34.2048108Z",
    "updatedOn": "2023-07-29T01:14:34.2048108Z",
    "namespaceName": "myns",
    "clientName": "client1",
    "clientAuthenticationName": "client1",
    "state": "Enabled",
    "attributes": {
      "attribute1": "value1"
    }
  }
}]

このサンプル イベントは、MQTT クライアントが Event Grid 名前空間から削除されたときに発生するイベントのスキーマを示しています。

[{
  "specversion": "1.0",
  "id": "2a93aaf9-66c2-4f8e-9ba3-8d899c10bf17",
  "time": "2023-07-29T01:30:52.5620566Z",
  "type": "Microsoft.EventGrid.MQTTClientDeleted",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1",
  "data": {
    "namespaceName": "myns",
    "clientName": "client1",
    "clientAuthenticationName": "client1"
  }
}]

イベントのプロパティ

すべてのイベントには、同じ最上位レベルのデータが格納されます。

プロパティ タイプ 説明
id string イベントの一意識別子。
source string イベント ソースの完全なリソース パス。 このフィールドは書き込み可能ではありません。 この値は Event Grid によって指定されます。
subject string 発行元が定義したイベントの対象のパス。
type string このイベント ソース用に登録されたイベントの種類のいずれか。
time string プロバイダーの UTC 時刻に基づくイベントの生成時刻。
data object Event Grid 名前空間のイベント データ。
specversion string CloudEvents スキーマ仕様バージョン。

データ オブジェクトには次のプロパティが含まれます。

プロパティ タイプ 説明
namespaceName string MQTT クライアントが接続または切断された Event Grid 名前空間の名前。
clientAuthenticationName string クライアントが認証のためにサービスに提示する MQTT クライアントの一意識別子。 この文字列は大文字と小文字が区別され、長さは最大 128 文字で、UTF-8 文字をサポートします。
clientSessionName string MQTT クライアントのセッションの一意識別子。 この文字列は大文字と小文字が区別され、長さは最大 128 文字で、UTF-8 文字をサポートします。
sequenceNumber long MQTT クライアント セッションの接続または切断イベントの順序を示すのに役立つ数値。 最新のイベントには、前のイベントよりも大きいシーケンス番号が与えられます。
disconnectionReason string MQTT クライアントのセッションが切断された理由。 値は、切断理由の表のいずれかの値である可能性があります。
createdOn string プロバイダーの UTC 時間に基づくクライアント リソースの作成時間。
updatedOn string プロバイダーの UTC 時間に基づくクライアント リソースの最終更新時間。 クライアント リソースが更新されなかった場合、この値は 'createdOn' プロパティの値と同じになります
clientName string プロバイダーの UTC 時間に基づくクライアント リソースの最終更新時間。 クライアント リソースが更新されなかった場合、この値は 'createdOn' プロパティの値と同じになります。
state string クライアントの構成状態。 値は Enabled または Disabled のいずれかです。
attributes string クライアント リソースに割り当てられるキーと値のペア属性の配列。

切断理由:

次の一覧では、disconnectionReason のさまざまな値とその説明について詳しく説明します。

切断理由: 説明
ClientAuthenticationError 認証上の理由でクライアントが切断されました (たとえば、証明書の有効期限が切れた、クライアントが無効になった、クライアント構成が変更されたなど)
ClientAuthorizationError 認可上の理由でクライアントが切断されました (たとえば、トピック空間、アクセス許可バインド、またはクライアント グループの構成が変更されたため)
ClientError クライアントが不正な要求を送信したか、サポートされていない機能のいずれかを使用したため、サービスによって接続が終了されました。
ClientInitiatedDisconnect クライアントが、MQTT の DISCONNECT パケットまたは WebSocket 経由の MQTT のクローズ フレームを介して正常な切断を開始しています。
ConnectionLost クライアントとサーバー間の接続が失われています。
IpForbidden クライアントの IP アドレスが、IP フィルターまたはプライベート リンクの構成によってブロックされています。
QuotaExceeded クライアントが 1 つ以上のスロットリング制限を超えたため、サービスによって接続が終了されました。
ServerError 予期しないサーバー エラーが原因で接続が終了しました
ServerInitiatedDisconnect 運用上の理由でサーバーが正常な切断を開始します
SessionOverflow クライアントの未確認 QoS1 メッセージのキューが制限に達したため、サーバーによって接続が終了されました
SessionTakenOver クライアントが同じ認証名で再接続したため、前の接続が終了しました。

次の手順