SignalR Service 用の Azure Event Grid イベント スキーマ

この記事では、SignalR Service イベントのプロパティとスキーマについて説明します。  イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。 また、Azure SingnalR をイベント ソースとして使用するためのクイック スタートとチュートリアルの一覧も示されています。

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

SignalR Service から出力されるイベントの種類は次のとおりです。

イベントの種類 説明
Microsoft.SignalRService.ClientConnectionConnected クライアント接続が接続されたときに発生します。
Microsoft.SignalRService.ClientConnectionDisconnected クライアント接続が接続解除されたときに発生します。

イベントの例

次の例では、クライアント接続が接続された場合のイベントのスキーマを示します。

[{
  "topic": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource",
  "subject": "/hub/chat",
  "eventType": "Microsoft.SignalRService.ClientConnectionConnected",
  "eventTime": "2019-06-10T18:41:00.9584103Z",
  "id": "831e1650-001e-001b-66ab-eeb76e069631",
  "data": {
    "timestamp": "2019-06-10T18:41:00.9584103Z",
    "hubName": "chat",
    "connectionId": "crH0uxVSvP61p5wkFY1x1A",
    "userId": "user-eymwyo23"
  },
  "dataVersion": "1.0",
  "metadataVersion": "1"
}]

クライアント接続が接続解除された場合のイベントのスキーマも同様です。

[{
  "topic": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource",
  "subject": "/hub/chat",
  "eventType": "Microsoft.SignalRService.ClientConnectionDisconnected",
  "eventTime": "2019-06-10T18:41:00.9584103Z",
  "id": "831e1650-001e-001b-66ab-eeb76e069631",
  "data": {
    "timestamp": "2019-06-10T18:41:00.9584103Z",
    "hubName": "chat",
    "connectionId": "crH0uxVSvP61p5wkFY1x1A",
    "userId": "user-eymwyo23",
    "errorMessage": "Internal server error."
  },
  "dataVersion": "1.0",
  "metadataVersion": "1"
}]

イベントのプロパティ

イベントのトップレベルのデータを次に示します。

プロパティ Type 説明
topic string イベント ソースの完全なリソース パス。 このフィールドは書き込み可能ではありません。 この値は Event Grid によって指定されます。
subject string 発行元が定義したイベントの対象のパス。
eventType string このイベント ソース用に登録されたイベントの種類のいずれか。
eventTime string プロバイダーの UTC 時刻に基づくイベントの生成時刻。
id string イベントの一意識別子。
data object SignalR Service のイベント データ。
dataVersion string データ オブジェクトのスキーマ バージョン。 スキーマ バージョンは発行元によって定義されます。
metadataVersion string イベント メタデータのスキーマ バージョン。 最上位プロパティのスキーマは Event Grid によって定義されます。 この値は Event Grid によって指定されます。

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

プロパティ Type 説明
timestamp string プロバイダーの UTC 時刻に基づくイベントの生成時刻。
hubName string クライアント接続が属するハブ。
connectionId string クライアント接続の一意の識別子です。
userId string 要求で定義されているユーザーの識別子です。
errorMessage string 接続解除の原因となったエラーです。

チュートリアルと方法

タイトル 説明
Event Grid を使用して Azure SignalR Service のイベントに反応する Azure SignalR Service と Event Grid の統合の概要。
Azure SignalR Service のイベントを Event Grid に送信する方法 Event Grid を通して Azure SignalR Service のイベントをアプリケーションに送信する方法を示します。

次のステップ