Partilhar via


Azure Event Grid Namespace como fonte de Event Grid

Este artigo fornece as propriedades e o esquema dos eventos do namespace Azure Event Grid. 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 espaço de nomes Azure Event Grid emite os seguintes tipos de eventos:

Tipo de evento Description
Microsoft.EventGrid.MQTTClientSessionConnected Publicado quando a sessão de um cliente MQTT está ligada ao Event Grid.
Microsoft.EventGrid.MQTTClientSessionDisconnected Publicado quando a sessão de um cliente MQTT é desligada do Event Grid.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Publicado quando um cliente MQTT é criado ou atualizado no Namespace do Event Grid.
Microsoft.EventGrid.MQTTClientDeleted Publicado quando um cliente MQTT é eliminado do Event Grid Namespace.

Exemplo de evento

Este evento de exemplo mostra o esquema de um evento gerado quando a sessão de um cliente MQTT está ligada a uma Grelha 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 é desligada da Grelha 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 Event Grid Namespace:

[{
  "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 é eliminado do Event Grid Namespace:

[{
  "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 topo:

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

O objeto de dados contém as seguintes propriedades:

Propriedade Tipo Description
namespaceName cadeia (de caracteres) Nome do espaço de nomes Event Grid onde o cliente MQTT estava ligado ou desconectado.
clientAuthenticationName cadeia (de caracteres) Identificador único para o cliente MQTT que o cliente apresenta ao serviço para autenticação. Esta cadeia de caracteres (sensível a maiúsculas e minúsculas) pode ter até 128 caracteres e suporta caracteres UTF-8.
clientSessionName cadeia (de caracteres) Identificador único para a sessão do cliente MQTT. Esta cadeia sensível a maiúsculas 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 ligados ou desligados da sessão do cliente MQTT. O evento mais recente terá um número de sequência superior ao do evento anterior.
disconnectionReason cadeia (de caracteres) Razão para a desconexão da sessão do cliente MQTT. O valor pode ser um dos valores na tabela de razões de desconexão.
createdOn cadeia (de caracteres) O tempo em que o recurso cliente é criado com base no tempo UTC do fornecedor.
updatedOn cadeia (de caracteres) A hora em que o recurso cliente é atualizado pela última vez com base na hora UTC do fornecedor. Se o recurso cliente nunca foi atualizado, este valor é idêntico ao valor da propriedade 'createdOn'
clientName cadeia (de caracteres) A hora em que o recurso cliente é atualizado pela última vez com base na hora UTC do fornecedor. Se o recurso cliente nunca foi atualizado, este valor é idêntico ao valor da propriedade 'createdOn'.
state cadeia (de caracteres) O estado configurado do cliente. O valor pode ser Ativado ou Desativado.
attributes cadeia (de caracteres) Os atributos de pares chave-valor atribuídos ao recurso do cliente.

Razões de desligamento:

A lista seguinte detalha os diferentes valores para o motivo de desconexão e as suas descrições.

Razão da Desconexão Description
ClientAuthenticationError O cliente foi desligado por quaisquer razões de autenticação (por exemplo, certificado expirado, cliente desativado ou configuração do cliente alterada)
ErroDeAutorizaçãoDoCliente O cliente foi desconectado por motivos de autorização (por exemplo, devido a uma alteração na configuração dos espaços de tópicos, vinculações de permissões ou grupos de clientes)
Erro do Cliente O cliente enviou um pedido mau ou usou uma das funcionalidades não suportadas que resultaram na terminação da ligação pelo serviço.
DesconexãoIniciadaPeloCliente o cliente inicia uma desconexão graciosa através de um pacote DISCONNECT para MQTT ou de um frame fechado para MQTT sobre WebSocket.
ConnectionLost A ligação cliente-servidor está perdida.
IpForbidden o endereço IP do cliente é bloqueado pelo filtro IP ou pela configuração de ligações privadas.
QuotaExceeded O cliente ultrapassou um ou mais dos limites de limitação que resultaram na interrupção da ligação pelo serviço.
ServerError A ligação foi interrompida devido a um erro inesperado do servidor
DesconexãoIniciadaPeloServidor O servidor inicia uma desconexão graciosa por qualquer motivo operacional
SessionOverflow a fila do cliente para mensagens QoS1 não confirmadas atingiu o seu limite, o que resultou numa terminação de ligação pelo servidor
Sessão Assumida o cliente reconectou-se com o mesmo nome de autenticação, o que resultou na terminação da ligação anterior.

Próximos passos