共用方式為

SignalR Service 的 Azure 事件方格事件結構描述

  • 發行項

本文提供 Azure SignalR Service 事件的屬性和結構描述。 如需事件結構描述的簡介，請參閱 Azure Event Grid 事件結構描述。 其也會提供快速入門和教學課程的清單，以使用 Azure SignalR 作為事件來源。

可用的事件類型

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"
}]

事件屬性

事件具有下列的最高層級資料：

屬性 類型​ 描述
topic string 事件來源的完整資源路徑。 此欄位無法寫入。 事件方格提供此值。
subject string 發行者定義事件主旨的路徑。
eventType string 此事件來源已註冊的事件類型之一。
eventTime string 事件產生的時間，以提供者的 UTC 時間為準。
id string 事件的唯一識別碼。
data object SignalR Service 事件資料。
dataVersion string 資料物件的結構描述版本。 發行者會定義結構描述版本。
metadataVersion string 事件中繼資料的結構描述版本。 「事件方格」會定義最上層屬性的結構描述。 事件方格提供此值。

資料物件具有下列屬性：

屬性 類型​ 描述
timestamp string 事件產生的時間，以提供者的 UTC 時間為準。
hubName string 用戶端連線所屬的中樞。
connectionId string 用戶端連線的唯一識別碼。
userId string 宣告中定義的使用者識別碼。
errorMessage string 導致連線中斷連線的錯誤。

教學課程和操作說明

標題 描述
使用事件方格來回應 Azure SignalR Service 事件 整合 Azure SignalR Service 與事件方格的概觀。
如何將 Azure SignalR Service 事件傳送至事件方格 示範如何透過事件方格將 Azure SignalR Service 事件傳送至應用程式。

下一步