Esquema de eventos da Grade de Eventos para Serviço do SignalR

  • Artigo

Este artigo fornece as propriedades e o esquema dos eventos do Serviço do SignalR. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure. Ele também fornece uma lista de guias de início rápido e de tutoriais para usar o Azure SignalR como uma origem do evento.

Tipos de evento disponíveis

O Serviço do SignalR emite os tipos de evento a seguir:

Tipo de evento Descrição
Microsoft.SignalRService.ClientConnectionConnected Gerado quando uma conexão de cliente é realizada.
Microsoft.SignalRService.ClientConnectionDisconnected Gerado quando uma conexão de cliente é desconectada.

Exemplo de evento

O exemplo a seguir mostra o esquema de um evento conectado a uma conexão de cliente:

[{
  "source": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource",
  "subject": "/hub/chat",
  "type": "Microsoft.SignalRService.ClientConnectionConnected",
  "time": "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"
  },
  "specversion": "1.0"
}]

O esquema para um evento desconectado da conexão de cliente é semelhante:

[{
  "source": "/subscriptions/{subscription-id}/resourceGroups/signalr-rg/providers/Microsoft.SignalRService/SignalR/signalr-resource",
  "subject": "/hub/chat",
  "type": "Microsoft.SignalRService.ClientConnectionDisconnected",
  "time": "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."
  },
  "specversion": "1.0"
}]

Propriedades do evento

Um evento tem os seguintes dados de nível superior:

Propriedade Type Descrição
source string Caminho de recurso completo para a origem do evento. Este campo não é gravável. A Grade de Eventos fornece esse valor.
subject string Caminho definido pelo publicador para o assunto do evento.
type string Um dos tipos de evento registrados para a origem do evento.
time string A hora em que o evento é gerado com base na hora UTC do provedor.
id string Identificador exclusivo do evento.
data objeto Dados de evento do Serviço do SignalR.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Propriedade Type Descrição
timestamp string A hora em que o evento é gerado com base na hora UTC do provedor.
hubName string Hub ao qual a conexão do cliente pertence.
connectionId string O identificador exclusivo para a conexão do cliente.
userId string O identificador de usuário definido na declaração.
errorMessage string O erro que faz com que a conexão seja desconectada.

Tutoriais e instruções

Título Descrição
Reagir a eventos do Serviço do Azure SignalR usando a Grade de Eventos Visão geral da integração do Serviço do Azure SignalR com a grade de eventos.
Como enviar eventos do Serviço do Azure SignalR para a Grade de Eventos Mostra como enviar eventos do Serviço do Azure SignalR para um aplicativo por meio da Grade de Eventos.

Próximas etapas