Freigeben über


Azure Event Grid-Namespace als Ereignisrasterquelle

Dieser Artikel enthält die Eigenschaften und das Schema für Azure Event Grid-Namespaceereignisse. Eine Einführung in Ereignisschemas finden Sie unter Azure Event Grid-Ereignisschema.

Verfügbare Ereignistypen

Der Azure Event Grid-Namespace gibt die folgenden Ereignistypen aus:

Ereignistyp Description
Microsoft.EventGrid.MQTTClientSessionConnected Veröffentlicht, wenn die Sitzung eines MQTT-Clients mit dem Event Grid verbunden ist.
Microsoft.EventGrid.MQTTClientSessionDisconnected Veröffentlicht, wenn die Sitzung eines MQTT-Clients vom Event Grid getrennt wird.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Veröffentlicht, wenn ein MQTT-Client im Event Grid-Namespace erstellt oder aktualisiert wird.
Microsoft.EventGrid.MQTTClientDeleted Veröffentlicht, wenn ein MQTT-Client aus dem Event Grid-Namespace gelöscht wird.

Beispielereignis

Dieses Beispielereignis zeigt das Schema eines Ereignisses, das ausgelöst wird, wenn die Sitzung eines MQTT-Clients mit einem Ereignisraster verbunden ist:

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

Dieses Beispielereignis zeigt das Schema eines Ereignisses, das ausgelöst wird, wenn die Sitzung eines MQTT-Clients mit Event Grid getrennt wird:

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

Dieses Beispielereignis zeigt das Schema eines Ereignisses, das ausgelöst wird, wenn ein MQTT-Client im Event Grid-Namespace erstellt oder aktualisiert wird:

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

Dieses Beispielereignis zeigt das Schema eines Ereignisses, das ausgelöst wird, wenn ein MQTT-Client aus dem Event Grid-Namespace gelöscht wird:

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

Ereigniseigenschaften

Alle Ereignisse enthalten dieselben Daten auf oberster Ebene:

Eigentum Typ Description
id Schnur Eindeutiger Bezeichner für das Ereignis.
source Schnur Vollständiger Ressourcenpfad zur Ereignisquelle. Dieses Feld ist nicht beschreibbar. Dieser Wert wird von Event Grid bereitgestellt.
subject Schnur Vom Herausgeber definierter Pfad zum Ereignisbetreff
type Schnur Einer der registrierten Ereignistypen für die Ereignisquelle.
time Schnur Die Zeit, in der das Ereignis generiert wird, basierend auf der UTC-Zeit des Anbieters.
data Objekt Ereignisdaten des Event Grid-Namespaces.
specversion Schnur Version der CloudEvents-Schemaspezifikation.

Das Datenobjekt enthält die folgenden Eigenschaften:

Eigentum Typ Description
namespaceName Schnur Name des Event Grid-Namespace, in dem der MQTT-Client verbunden oder getrennt wurde.
clientAuthenticationName Schnur Eindeutiger Bezeichner für den MQTT-Client, den der Client dem Dienst zur Authentifizierung präsentiert. Diese von der Groß-/Kleinschreibung abhängige Zeichenfolge kann bis zu 128 Zeichen lang sein und unterstützt UTF-8-Zeichen.
clientSessionName Schnur Eindeutiger Bezeichner für die MQTT-Client-Sitzung. Diese case-sensitive Zeichenfolge kann bis zu 128 Zeichen lang sein und unterstützt UTF-8-Zeichen.
sequenceNumber long Eine Zahl, die hilft, die Reihenfolge von Ereignissen der verbundenen oder getrennten MQTT-Clientsitzungen anzugeben. Das neueste Ereignis weist eine Sequenznummer auf, die höher als das vorherige Ereignis ist.
disconnectionReason Schnur Grund für die Trennung der Sitzung des MQTT-Clients. Der Wert kann einer der Werte in der Tabelle mit den Gründen für die Trennung sein.
createdOn Schnur Die Uhrzeit, zu der die Clientressource basierend auf der UTC-Zeit des Anbieters erstellt wird.
updatedOn Schnur Der Zeitpunkt, zu dem die Clientressource zuletzt aktualisiert wird, basierend auf der UTC-Zeit des Anbieters. Wenn die Clientressource nie aktualisiert wurde, ist dieser Wert mit dem Wert der Eigenschaft "createdOn" identisch.
clientName Schnur Der Zeitpunkt, zu dem die Clientressource zuletzt aktualisiert wird, basierend auf der UTC-Zeit des Anbieters. Wenn die Clientressource nie aktualisiert wurde, ist dieser Wert identisch mit dem Wert der Eigenschaft "createdOn".
state Schnur Der konfigurierte Status des Clients. Der Wert könnte aktiviert oder deaktiviert sein.
attributes Schnur Das Array von Schlüssel-Wert-Paarattributen, die der Clientressource zugewiesen sind.

Gründe für Verbindungsabbruch

Die folgende Liste enthält die verschiedenen Werte für disconnectionReason (Grund für Trennung) und deren Beschreibung:

Trennungsgrund Description
ClientAuthenticationError Der Client wurde aus Authentifizierungsgründen getrennt (z. B. abgelaufenes Zertifikat, Client wurde deaktiviert oder Clientkonfiguration geändert).
ClientAuthorizationError Der Client wurde aus Autorisierungsgründen getrennt (z. B. aufgrund einer Änderung der Konfiguration von Themenbereichen, Berechtigungsbindungen oder Clientgruppen).
ClientError Der Client hat eine ungültige Anforderung gesendet oder eine der nicht unterstützten Funktionen verwendet, was zu einem Verbindungsabbruch durch den Dienst geführt hat.
Vom Client initiierte Trennung Der Client initiiert eine ordnungsgemäße Trennung über ein DISCONNECT-Paket für MQTT oder einen Close-Frame für MQTT über WebSocket.
ConnectionLost Die Clientserververbindung geht verloren.
IpForbidden die IP-Adresse des Clients wird durch die Konfiguration von IP-Filtern oder privaten Links blockiert.
QuotaExceeded Der Client hat mindestens einen der Einschränkungsgrenzwerte überschritten, die zu einer Verbindungsbeendigung durch den Dienst geführt haben.
ServerError die Verbindung aufgrund eines unerwarteten Serverfehlers beendet wurde
ServerInitiatedDisconnect Der Server initiiert eine ordnungsgemäße Trennung aus einem beliebigen betriebsbedingten Grund.
SessionOverflow Die Warteschlange des Clients für nicht bestätigte QoS1-Nachrichten erreichte ihr Limit, was zu einem Verbindungsabbruch durch den Server führte.
SessionTakenOver Der Client hat sich mit demselben Authentifizierungsnamen erneut verbunden, was zur Beendigung der vorherigen Verbindung führte.

Nächste Schritte

  • Weitere Informationen zu Event Grid-Systemthemen finden Sie unter "Systemthemen".
  • Informationen zu den Ereignissen, die vom Event Grid-Namespace ausgegeben werden und wie sie verwendet werden, finden Sie unter MQTT Client Life Cycle Events.