Partilhar via

Namespace da Grade de Eventos do Azure (Visualização) como uma fonte de Grade de Eventos

  • Artigo

Este artigo fornece as propriedades e o esquema para eventos de namespace da Grade de Eventos do Azure. Para obter uma introdução aos esquemas de eventos, consulte Esquema de eventos da Grade de Eventos do Azure.

Tipos de eventos disponíveis

O namespace da Grade de Eventos do Azure (Visualização) emite os seguintes tipos de evento:

Tipo de evento Description
Microsoft.EventGrid.MQTTClientSessionConnected Publicado quando a sessão de um cliente MQTT é conectada à Grade de Eventos.
Microsoft.EventGrid.MQTTClientSessionDisconnected Publicado quando a sessão de um cliente MQTT é desconectada da Grade de Eventos.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Publicado quando um cliente MQTT é criado ou atualizado no namespace Event Grid.
Microsoft.EventGrid.MQTTClientDeleted Publicado quando um cliente MQTT é excluído do namespace Event Grid.

Exemplo de evento

Este evento de exemplo mostra o esquema de um evento gerado quando a sessão de um cliente MQTT é conectada a uma grade de eventos:

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

Este evento de exemplo mostra o esquema de um evento gerado quando a sessão de um cliente MQTT é desconectada à Grade de Eventos:

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

Este evento de exemplo mostra o esquema de um evento gerado quando um cliente MQTT é criado ou atualizado no namespace da grade de eventos:

[{
  "specversion": "1.0",
  "id": "383d1562-c95f-4095-936c-688e72c6b2bb",
  "time": "2023-07-29T01:14:35.8928724Z",
  "type": "Microsoft.EventGrid.MQTTClientCreatedOrUpdated",
  "source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/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"
    }
  }
}]

Este evento de exemplo mostra o esquema de um evento gerado quando um cliente MQTT é excluído do namespace Event Grid:

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

Propriedades do evento

Todos os eventos contêm os mesmos dados de nível superior:

Propriedade Type Description
id string Identificador exclusivo do evento.
source string Caminho completo do recurso para a origem do evento. Este campo não pode ser gravado. O Event Grid fornece este valor.
subject string Caminho definido pelo publicador para o assunto do evento.
type string Um dos tipos de eventos registados para esta origem de evento.
time string A hora em que o evento é gerado com base na hora UTC do provedor.
data objeto Dados de eventos do namespace Event Grid.
specversion string Versão da especificação do esquema CloudEvents.

O objeto de dados contém as seguintes propriedades:

Propriedade Type Description
namespaceName string Nome do namespace Event Grid onde o cliente MQTT foi conectado ou desconectado.
clientAuthenticationName string Identificador exclusivo para o cliente MQTT que o cliente apresenta ao serviço para autenticação. Esta cadeia de caracteres que diferencia maiúsculas de minúsculas pode ter até 128 caracteres e suporta caracteres UTF-8.
clientSessionName string Identificador exclusivo para a sessão do cliente MQTT. Esta cadeia de caracteres que diferencia maiúsculas de minúsculas pode ter até 128 caracteres e suporta caracteres UTF-8.
sequenceNumber long Um número que ajuda a indicar a ordem dos eventos de sessão do cliente MQTT conectados ou desconectados. O evento mais recente terá um número de sequência superior ao evento anterior.
disconnectionReason string Motivo da desconexão da sessão do cliente MQTT. O valor pode ser um dos valores na tabela de motivos de desconexão.
createdOn string A hora em que o recurso do cliente é criado com base na hora UTC do provedor.
updatedOn string A hora em que o recurso do cliente é atualizado pela última vez com base na hora UTC do provedor. Se o recurso do cliente nunca foi atualizado, esse valor é idêntico ao valor da propriedade 'createdOn'
clientName string A hora em que o recurso do cliente é atualizado pela última vez com base na hora UTC do provedor. Se o recurso do cliente nunca foi atualizado, esse valor é idêntico ao valor da propriedade 'createdOn'.
state string O estado configurado do cliente. O valor pode ser Ativado ou Desativado.
attributes string A matriz de atributos de par chave-valor atribuídos ao recurso cliente.

Motivos de desconexão:

A lista a seguir detalha os diferentes valores para disconnectionReason e sua descrição:

Motivo da desconexão Description
ClientAuthenticationError o cliente foi desconectado por quaisquer motivos de autenticação (por exemplo, certificado expirado, cliente desativado ou configuração do cliente alterada)
ClientAuthorizationError o cliente foi desconectado por quaisquer motivos de autorização (por exemplo, devido a uma alteração na configuração de espaços de tópico, associações de permissão ou grupos de clientes)
ClientError O cliente enviou uma solicitação incorreta ou usou um dos recursos não suportados que resultaram em um término de conexão pelo serviço.
ClientInitiatedDisconnect o cliente inicia uma desconexão normal através de um pacote DISCONNECT para MQTT ou um quadro fechado para MQTT sobre WebSocket.
ConexãoLost A conexão cliente-servidor é perdida.
IpProibido o endereço IP do cliente é bloqueado pelo filtro IP ou pela configuração de links privados.
QuotaExceeded O cliente excedeu um ou mais dos limites de limitação que resultaram no término da conexão pelo serviço.
Erro de servidor A conexão foi encerrada devido a um erro inesperado do servidor
ServerInitiatedDisconnect O servidor inicia uma desconexão normal por qualquer motivo operacional
Estouro de sessão a fila do cliente para mensagens QoS1 não reconhecidas atingiu seu limite, o que resultou em um encerramento de conexão pelo servidor
SessionTakenOver O cliente se reconectou com o mesmo nome de autenticação, o que resultou no término da conexão anterior.

Próximos passos

  • Para saber mais sobre os tópicos do sistema de Grade de Eventos, consulte Tópicos do sistema
  • Para saber mais sobre os eventos emitidos pelo namespace Event Grid e como usá-los, consulte Eventos do ciclo de vida do cliente MQTT.