Azure Event Grid-naamruimte (preview) als een Event Grid-bron

  • Artikel

Dit artikel bevat de eigenschappen en het schema voor Azure Event Grid-naamruimte-gebeurtenissen. Zie het Gebeurtenisschema van Azure Event Grid voor een inleiding tot gebeurtenisschema's.

Beschikbare gebeurtenistypen

Azure Event Grid-naamruimte (preview) verzendt de volgende gebeurtenistypen:

Gebeurtenistype Beschrijving
Microsoft.EventGrid.MQTTClientSession Verbinding maken ed Gepubliceerd wanneer de sessie van een MQTT-client is verbonden met Event Grid.
Microsoft.EventGrid.MQTTClientSessionDisconnected Gepubliceerd wanneer de sessie van een MQTT-client wordt verbroken met Event Grid.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Gepubliceerd wanneer een MQTT-client wordt gemaakt of bijgewerkt in de Event Grid-naamruimte.
Microsoft.EventGrid.MQTTClientDeleted Gepubliceerd wanneer een MQTT-client wordt verwijderd uit de Event Grid-naamruimte.

Voorbeeld van een gebeurtenis

Deze voorbeeldgebeurtenis toont het schema van een gebeurtenis die wordt gegenereerd wanneer de sessie van een MQTT-client is verbonden met een Event Grid:

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

Deze voorbeeldgebeurtenis toont het schema van een gebeurtenis die wordt gegenereerd wanneer de sessie van een MQTT-client is verbroken met Event Grid:

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

Deze voorbeeldgebeurtenis toont het schema van een gebeurtenis die wordt gegenereerd wanneer een MQTT-client wordt gemaakt of bijgewerkt in de Event Grid-naamruimte:

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

Deze voorbeeldgebeurtenis toont het schema van een gebeurtenis die wordt gegenereerd wanneer een MQTT-client wordt verwijderd uit de Event Grid-naamruimte:

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

Eigenschappen van gebeurtenis

Alle gebeurtenissen bevatten dezelfde gegevens op het hoogste niveau:

Eigenschap Type Omschrijving
id tekenreeks Unieke id voor de gebeurtenis.
source tekenreeks Volledig resourcepad naar de gebeurtenisbron. Dit veld kan niet worden geschreven. Event Grid biedt deze waarde.
subject tekenreeks Het door de uitgever gedefinieerde pad naar het gebeurtenisonderwerp.
type tekenreeks Een van de geregistreerde gebeurtenistypen voor deze gebeurtenisbron.
time tekenreeks Het tijdstip waarop de gebeurtenis wordt gegenereerd op basis van de UTC-tijd van de provider.
data object Event Grid-naamruimte-gebeurtenisgegevens.
specversion tekenreeks CloudEvents schemaspecificatieversie.

Het gegevensobject bevat de volgende eigenschappen:

Eigenschap Type Omschrijving
namespaceName tekenreeks Naam van de Event Grid-naamruimte waar de MQTT-client is verbonden of verbroken.
clientAuthenticationName tekenreeks Unieke id voor de MQTT-client die de client aan de service presenteert voor verificatie. Deze hoofdlettergevoelige tekenreeks kan maximaal 128 tekens lang zijn en ondersteunt UTF-8 tekens.
clientSessionName tekenreeks Unieke id voor de sessie van de MQTT-client. Deze hoofdlettergevoelige tekenreeks kan maximaal 128 tekens lang zijn en ondersteunt UTF-8 tekens.
sequenceNumber long Een getal waarmee de volgorde van verbonden of niet-verbonden gebeurtenissen van de MQTT-clientsessie wordt aangegeven. De laatste gebeurtenis heeft een volgnummer dat hoger is dan de vorige gebeurtenis.
disconnectionReason tekenreeks Reden voor de verbroken verbinding van de sessie van de MQTT-client. De waarde kan een van de waarden in de tabel met verbroken redenen zijn.
createdOn tekenreeks Het tijdstip waarop de clientresource wordt gemaakt op basis van de UTC-tijd van de provider.
updatedOn tekenreeks Het tijdstip waarop de clientresource voor het laatst wordt bijgewerkt op basis van de UTC-tijd van de provider. Als de clientresource nooit is bijgewerkt, is deze waarde identiek aan de waarde van de eigenschap CreatedOn
clientName tekenreeks Het tijdstip waarop de clientresource voor het laatst wordt bijgewerkt op basis van de UTC-tijd van de provider. Als de clientresource nooit is bijgewerkt, is deze waarde identiek aan de waarde van de eigenschap 'createdOn'.
state tekenreeks De geconfigureerde status van de client. De waarde kan zijn ingeschakeld of uitgeschakeld.
attributes tekenreeks De matrix van sleutel-waardepaarkenmerken die zijn toegewezen aan de clientresource.

Redenen voor verbroken verbinding:

De volgende lijst bevat informatie over de verschillende waarden voor de disconnectionReason en de bijbehorende beschrijving:

Reden voor verbroken verbinding Beschrijving
ClientAuthenticationError de client is om verificatieredenen verbroken (bijvoorbeeld het certificaat is verlopen, de client is uitgeschakeld of de clientconfiguratie is gewijzigd)
ClientAuthorizationError de client is om autorisatieredenen verbroken (bijvoorbeeld vanwege een wijziging in de configuratie van onderwerpruimten, machtigingsbindingen of clientgroepen)
ClientError de client een ongeldige aanvraag heeft verzonden of een van de niet-ondersteunde functies heeft gebruikt die tot een beëindiging van de verbinding door de service hebben geleid.
ClientInitiatedDisconnect de client initieert een probleemloze verbinding via een DISCONNECT-pakket voor MQTT of een gesloten frame voor MQTT via WebSocket.
Verbinding maken ionLost de client-serververbinding is verbroken.
IpForbidden het IP-adres van de client wordt geblokkeerd door het IP-filter of de configuratie van privékoppelingen.
QuotaExceeded de client heeft een of meer van de beperkingslimieten overschreden die tot een beëindiging van de verbinding door de service hebben geleid.
ServerError de verbinding is beëindigd vanwege een onverwachte serverfout
ServerInitiatedDisconnect de server een probleemloze verbinding tot gevolg heeft om welke operationele reden dan ook
SessionOverflow de wachtrij van de client voor niet-bekende QoS1-berichten heeft de limiet bereikt, wat heeft geresulteerd in een beëindiging van de verbinding door de server
SessionTakenOver de client opnieuw verbinding heeft gemaakt met dezelfde verificatienaam, wat heeft geresulteerd in de beëindiging van de vorige verbinding.

Volgende stappen