Dela via

Azure Event Grid-namnområde (förhandsversion) som en Event Grid-källa

  • Artikel

Den här artikeln innehåller egenskaper och schema för Azure Event Grid-namnområdeshändelser. En introduktion till händelsescheman finns i Händelseschema för Azure Event Grid.

Tillgängliga händelsetyper

Azure Event Grid-namnområdet (förhandsversion) genererar följande händelsetyper:

Händelsetyp beskrivning
Microsoft.EventGrid.MQTTClientSession Anslut ed Publicerad när en MQTT-klients session är ansluten till Event Grid.
Microsoft.EventGrid.MQTTClientSessionDisconnected Publicerad när en MQTT-klients session kopplas från Event Grid.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Publicerad när en MQTT-klient skapas eller uppdateras i Event Grid-namnområdet.
Microsoft.EventGrid.MQTTClientDeleted Publicerad när en MQTT-klient tas bort från Event Grid-namnområdet.

Exempelhändelse

Den här exempelhändelsen visar schemat för en händelse som genereras när en MQTT-klients session är ansluten till ett Event Grid:

[{
  "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
  }
}]

Den här exempelhändelsen visar schemat för en händelse som genereras när en MQTT-klients session kopplas från till Event Grid:

[{
  "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"
  }
}]

Den här exempelhändelsen visar schemat för en händelse som genereras när en MQTT-klient skapas eller uppdateras i Event Grid-namnområdet:

[{
  "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"
    }
  }
}]

Den här exempelhändelsen visar schemat för en händelse som genereras när en MQTT-klient tas bort från Event Grid-namnområdet:

[{
  "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"
  }
}]

Händelseegenskaper

Alla händelser innehåller samma data på den översta nivån:

Property Type Description
id sträng Unik identifierare för händelsen.
source sträng Fullständig resurssökväg till händelsekällan. Det här fältet kan inte skrivas. Event Grid ger det här värdet.
subject sträng Utgivardefinierad sökväg till händelseobjektet.
type sträng En av de registrerade händelsetyperna för den här händelsekällan.
time sträng Den tid då händelsen genereras baserat på leverantörens UTC-tid.
data objekt Event Grid-namnområdeshändelsedata.
specversion sträng CloudEvents schemaspecifikationsversion.

Dataobjektet innehåller följande egenskaper:

Property Type Description
namespaceName sträng Namnet på Event Grid-namnområdet där MQTT-klienten var ansluten eller frånkopplad.
clientAuthenticationName sträng Unik identifierare för den MQTT-klient som klienten presenterar för tjänsten för autentisering. Den här skiftlägeskänsliga strängen kan vara upp till 128 tecken lång och har stöd för UTF-8 tecken.
clientSessionName sträng Unik identifierare för MQTT-klientens session. Den här skiftlägeskänsliga strängen kan vara upp till 128 tecken lång och har stöd för UTF-8 tecken.
sequenceNumber lång Ett tal som hjälper till att ange ordningen på MQTT-klientsessionens anslutna eller frånkopplade händelser. Den senaste händelsen har ett sekvensnummer som är högre än föregående händelse.
disconnectionReason sträng Orsak till frånkopplingen av MQTT-klientens session. Värdet kan vara ett av värdena i tabellen för frånkopplingsorsaker.
createdOn sträng Den tid då klientresursen skapas baserat på leverantörens UTC-tid.
updatedOn sträng Den tid då klientresursen senast uppdateras baserat på providerns UTC-tid. Om klientresursen aldrig uppdaterades är det här värdet identiskt med värdet för egenskapen "createdOn"
clientName sträng Den tid då klientresursen senast uppdateras baserat på providerns UTC-tid. Om klientresursen aldrig uppdaterades är det här värdet identiskt med värdet för egenskapen "createdOn".
state sträng Klientens konfigurerade tillstånd. Värdet kan vara Aktiverat eller Inaktiverat.
attributes sträng Matrisen med nyckel/värde-parattribut som har tilldelats till klientresursen.

Orsaker till frånkoppling:

Följande lista beskriver de olika värdena för disconnectionReason och deras beskrivning:

Orsak till frånkoppling beskrivning
ClientAuthenticationError klienten kopplades från av autentiseringsskäl (till exempel att certifikatet upphörde att gälla, klienten inaktiverades eller att klientkonfigurationen ändrades)
ClientAuthorizationError klienten kopplades från av auktoriseringsskäl (till exempel på grund av en ändring i konfigurationen av ämnesutrymmen, behörighetsbindningar eller klientgrupper)
ClientError klienten skickade en felaktig begäran eller använde en av de funktioner som inte stöds och som resulterade i att tjänsten avslutade anslutningen.
ClientInitiatedDisconnect klienten initierar en graciös frånkoppling via ett DISCONNECT-paket för MQTT eller en nära ram för MQTT över WebSocket.
Anslut ionLost klientserveranslutningen går förlorad.
IpForbidden klientens IP-adress blockeras av IP-filter eller konfiguration av privata länkar.
QuotaExceeded klienten överskred en eller flera av de begränsningsgränser som ledde till att tjänsten avslutade anslutningen.
ServerError anslutningen avbröts på grund av ett oväntat serverfel
ServerInitiatedDisconnect servern initierar en graciös frånkoppling av någon driftsorsak
SessionOverflow klientens kö för obemärkta QoS1-meddelanden nådde sin gräns, vilket resulterade i att servern avslutade anslutningen
SessionTakenOver klienten återansluts med samma autentiseringsnamn, vilket resulterade i att den tidigare anslutningen avslutades.

Nästa steg