Namespace da Grade de Eventos do Azure (Versão Prévia) como uma origem da Grade de Eventos

  • Artigo

Este artigo fornece as propriedades e o esquema dos eventos de namespace da Grade de Eventos do Azure. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure.

Tipos de evento disponíveis

O namespace da Grade de Eventos do Azure emite os seguintes tipos de eventos:

Tipo de evento Descrição
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 da Grade de Eventos.
Microsoft.EventGrid.MQTTClientDeleted Publicado quando um cliente MQTT é excluído do Namespace da Grade de Eventos.

Exemplo de evento

Este exemplo de evento 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 exemplo de evento mostra o esquema de um evento gerado quando a sessão de um cliente MQTT é desconectada da 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 da Grade de Eventos:

[{
  "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 conterão os mesmos dados de nível superior:

Propriedade Type Descrição
id string Identificador exclusivo do evento.
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.
data objeto Dados de evento do namespace da Grade de Eventos.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados contém as seguintes propriedades:

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

Motivos de desconexão:

A seguinte lista fornece detalhes sobre os diferentes valores do disconnectionReason e a descrição:

Motivo da desconexão Descrição
ClientAuthenticationError o cliente foi desconectado por qualquer motivo de autenticação (por exemplo, o certificado expirou, o cliente foi desabilitado ou a configuração do cliente foi alterada)
ClientAuthorizationError o cliente foi desconectado por algum motivo de autorização (por exemplo, devido a uma alteração na configuração de espaços de tópicos, associações de permissão ou grupos de clientes)
ClientError o cliente enviou uma solicitação inválida ou usou um dos recursos sem suporte que resultou em um encerramento da conexão pelo serviço.
ClientInitiatedDisconnect o cliente inicia uma desconexão normal por meio de um pacote DISCONNECT do MQTT ou fecha um quadro do MQTT via WebSocket.
ConnectionLost a conexão cliente-servidor é perdida.
IpForbidden 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 resultou em um encerramento da conexão pelo serviço.
ServerError a conexão foi encerrada devido a um erro inesperado do servidor
ServerInitiatedDisconnect o servidor inicia uma desconexão normal por qualquer motivo operacional
SessionOverflow a fila do cliente de mensagens QoS1 não confirmadas atingiu o limite, o que resultou em um encerramento da conexão pelo servidor
SessionTakenOver o cliente reconectou-se com o mesmo nome de autenticação, o que resultou no encerramento da conexão anterior.

Próximas etapas