Eseményértesítések

  • Cikk

Ez a cikk az Azure Digital Twins által létrehozott eseményértesítéseket, azok struktúráját és a létrehozható különböző típusokkal kapcsolatos részleteket ismerteti.

Az Azure Digital Twins különböző eseményei értesítéseket hoznak létre, amelyek lehetővé teszik, hogy a megoldás háttérrendszere értesüljön a különböző műveletekről. Ezek az értesítések ezután az Azure Digital Twinsen belüli és kívüli különböző helyekre lesznek irányítva , amelyek ezeket az információkat felhasználhatják a műveletek végrehajtásához.

Többféle értesítés hozható létre, és az értesítési üzenetek eltérőek lehetnek attól függően, hogy milyen típusú esemény generálta őket. Ez a cikk részletesen ismerteti a különböző típusú üzeneteket, és hogy hogyan néznek ki.

Ez a diagram a különböző értesítési típusokat mutatja:

Notification type (Értesítés típusa) Útválasztási forrás neve Létrehozva...
Digitális ikerpéldány változási értesítése Digitális ikerpéldány változási értesítése bármely digitális ikertulajdonság-változás
Digitális ikerpéldány életciklus-értesítése Digitális ikerpéldány életciklus-értesítése bármely digitális ikerpéldány-létrehozási vagy -törlési művelet
Digitális ikerpéldány kapcsolati változásról szóló értesítése Digitális ikerpéldány kapcsolati változásról szóló értesítése bármely digitális ikerkapcsolat-változás
Digitális ikerpéldány telemetriai üzenetei Telemetriai üzenetek telemetriaüzenetek

Értesítési struktúra

Az Azure Digital Twins eseményértesítéseinek struktúrája az értesítés céljától függ.

Az Event Gridnek küldött értesítések megfelelnek az alábbi formátumok egyikének (az Event Grid beállításaitól függően):

Az Event Hubsnak és a Service Busnak küldött értesítések megfelelnek a CloudEvents AMQP protokollkötésének.

Digitális ikerpéldány változásértesítések

A digitális ikerpéldány változásértesítések a digitális ikerpéldány frissítésekor aktiválódnak, például:

  • Amikor megváltoznak a tulajdonságértékek vagy a metaadatok.
  • Amikor a digitális ikerpéldány vagy az összetevő metaadatai megváltoznak. Erre a forgatókönyvre példa a digitális ikerpéldány modelljének módosítása.

Tulajdonságok

Itt találhatók a digitális ikerpéldány változásértesítés törzsében található mezők.

Name Érték
id Az értesítés azonosítója, például egy UUID vagy egy, a szolgáltatás által karbantartott számláló. source + id egyedi minden egyes eseményhez
source Az IoT Hub vagy az Azure Digital Twins-példány neve, például myhub.azure-devices.net vagy mydigitaltwins.westus2.azuredigitaltwins.net
data Egy JSON Patch-dokumentum, amely az ikerpéldány frissítését ismerteti. A részletekért lásd az alábbi törzsadatokat .
specversion 1.0
Az üzenet megfelel a CloudEvents-specifikáció ezen verziójának.
type Microsoft.DigitalTwins.Twin.Update
datacontenttype application/json
subject A digitális ikerpéldány azonosítója
time A művelet digitális ikerpéldányon való végrehajtásának időbélyege
traceparent Az esemény W3C-nyomkövetési környezete

Törzs részletei

Az üzenetben a data mező egy JSON Patch-dokumentumot tartalmaz, amely tartalmazza a digitális ikerpéldány frissítését.

Az alábbiakban példákat talál erre az üzenettípusra az egyes lehetséges értesítési sémákhoz.

{
    "id": "39d4abb9-e3ee-4ed5-ad17-2243a9784946",
    "subject": "example-twin1",
    "data": {
      "data": {
        "modelId": "dtmi:examplecom:interfaceName;1",
        "patch": [
          {
            "value": "new name",
            "path": "/room",
            "op": "replace"
          }
        ]
      },
      "contenttype": "application/json",
      "traceparent": "00-2aa957558db348f387ef704b37631a1d-c28d665340fe5045-01"
    },
    "eventType": "Microsoft.DigitalTwins.Twin.Update",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "eventTime": "2021-12-09T20:28:52.9795363Z",
    "topic": "/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.EventGrid/topics/<topic-name>"
}

Megjegyzés

Az Azure Digital Twins jelenleg nem támogatja a tömbön belüli mezők alapján történő szűrési eseményeket . Ez magában foglalja a tulajdonságok szűrését egy digitális ikerpéldány-változásértesítés egy patch szakaszában.

Digitális iker életciklusra vonatkozó értesítések

Függetlenül attól, hogy a digitális ikerpéldányok IoT Hub eszközöket jelölnek-e az Azure Digital Twinsben, mind értesítéseket bocsátanak ki. Ezt az életciklus-értesítések teszik lehetővé, amelyek magáról a digitális ikerpéldányról szólnak.

Az életciklus-értesítések akkor aktiválódnak, ha:

  • Létrejön egy digitális ikerpéldány
  • A rendszer töröl egy digitális ikerpéldányt

Tulajdonságok

Itt találhatók az életciklus-értesítések törzsében található mezők.

Name Érték
id Az értesítés azonosítója, például egy UUID vagy egy, a szolgáltatás által karbantartott számláló. source + id egyedi minden egyes eseményhez.
source Az IoT Hub vagy az Azure Digital Twins-példány neve, például myhub.azure-devices.net vagy mydigitaltwins.westus2.azuredigitaltwins.net
data Az életciklus-eseményt tapasztaló ikerpéldány adatai. A részletekért lásd az alábbi törzsadatokat .
specversion 1.0
Az üzenet megfelel a CloudEvents-specifikáció ezen verziójának.
type Microsoft.DigitalTwins.Twin.Create
Microsoft.DigitalTwins.Twin.Delete
datacontenttype application/json
subject A digitális ikerpéldány azonosítója
time Az ikerpéldányon végrehajtott művelet időbélyege
traceparent Az esemény W3C-nyomkövetési környezete

Törzs részletei

Az alábbiakban példákat talál erre az üzenettípusra az egyes lehetséges értesítési sémákhoz.

{
    "id": "6ccdb1cd-0dc3-450f-8730-ceccda8439be",
    "subject": "example-twin1",
    "data": {
      "data": {
        "$dtId": "example-twin1",
        "$etag": "W/\"ecf81d6c-8c1a-4a95-afd8-13bd4cea436f\"",
        "room": "room name",
        "$metadata": {
          "$model": "dtmi:examplecom:interfaceName;1",
          "room": {
            "lastUpdateTime": "2021-12-09T20:28:52.6651216Z"
          }
        }
      },
      "contenttype": "application/json",
      "traceparent": "00-2aa957558db348f387ef704b37631a1d-51f716e7397ec64b-01"
    },
    "eventType": "Microsoft.DigitalTwins.Twin.Create",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "eventTime": "2021-12-09T20:28:52.6745538Z",
    "topic": "/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.EventGrid/topics/<topic-name>"
}

Digitális ikerkapcsolatok változásértesítései

A kapcsolatmódosítási értesítések akkor aktiválódnak, ha egy digitális ikerpéldány kapcsolatai létrejönnek, frissülnek vagy törlődnek.

Tulajdonságok

Íme a kapcsolatmódosítási értesítés törzsének mezői.

Name Érték
id Az értesítés azonosítója, például egy UUID vagy egy, a szolgáltatás által karbantartott számláló. source + id egyedi minden egyes eseményhez
source Az Azure Digital Twins-példány neve, például mydigitaltwins.westus2.azuredigitaltwins.net
data A módosított kapcsolat hasznos adatai. A részletekért lásd az alábbi törzsadatokat .
specversion 1.0
Az üzenet megfelel a CloudEvents-specifikáció ezen verziójának.
type Microsoft.DigitalTwins.Relationship.Create
Microsoft.DigitalTwins.Relationship.Update
Microsoft.DigitalTwins.Relationship.Delete
datacontenttype application/json
subject A kapcsolat azonosítója, például <twin-ID>/relationships/<relationshipID>
time A kapcsolaton végrehajtott művelet időbélyege
traceparent Az esemény W3C-nyomkövetési környezete

Törzs részletei

Az üzenetben a data mező egy kapcsolat hasznos adatait tartalmazza JSON formátumban. Ugyanazt a formátumot használja, mint egy GET kapcsolatra vonatkozó kérés a DigitalTwins API-val.

Az alábbiakban példákat talál erre az üzenettípusra az egyes lehetséges értesítési sémákhoz.

{
    "id": "4d850574-0a28-4667-a59e-3b382ff0e74e",
    "subject": "example-twin1/relationships/RuntimeEventsScenario_edge",
    "data": {
    "data": {
        "modelId": "dtmi:examplecom:interfaceName;1",
        "patch": [
        {
            "value": "new value",
            "path": "/prop1",
            "op": "replace"
        }
        ]
    },
    "contenttype": "application/json",
    "traceparent": "00-2aa957558db348f387ef704b37631a1d-c1fcf951f540ec44-01"
    },
    "eventType": "Microsoft.DigitalTwins.Relationship.Update",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "eventTime": "2021-12-09T20:28:53.2016395Z",
    "topic": "/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.EventGrid/topics/<topic-name>"
}

Digitális ikerpéldány telemetriai üzenetei

A digitális ikerpéldányok a SendTelemetry API használatával telemetriai üzeneteket bocsáthatnak ki és küldhetnek a kimenő végpontokra.

Tulajdonságok

Íme a telemetriaüzenet törzsének mezői.

Name Érték
id Az értesítés azonosítója, amelyet az ügyfél a telemetriai API meghívásakor ad meg.
source Annak az ikerpéldánynak a teljes neve, amelyről a telemetriai eseményt küldte. A következő formátumot használja: <your-Digital-Twin-instance>.api.<your-region>.digitaltwins.azure.net/<twin-ID>.
specversion 1.0
Az üzenet megfelel a CloudEvents specifikáció jelen verziójának.
type microsoft.iot.telemetry
data Az ikerpéldánytól küldött telemetriai üzenet. A hasznos adatnak nem kell igazodnia az Azure Digital Twins-példányban definiált sémához.
dataschema Az adatséma az ikerpéldány vagy a telemetriát kibocsátó összetevő modellazonosítója. Például: dtmi:example:com:floor4;2.
datacontenttype application/json
traceparent Az esemény W3C-nyomkövetési környezete.

Törzs részletei

A törzs tartalmazza a telemetriai mérést, valamint néhány környezeti információt az ikerpéldányról. Az alábbiakban példákat talál erre az üzenettípusra az egyes lehetséges értesítési sémákhoz.

{
    "id": "6f6635d8-f1b8-43ec-80fb-bb9453fc611c",
    "subject": "example-twin1",
    "data": {
        "data": {
        "prop": "hello from telemetry"
        },
        "dataschema": "dtmi:examplecom:interfaceName;1",
        "contenttype": "application/json-patch+json; charset=utf-8",
        "traceparent": "00-2aa957558db348f387ef704b37631a1d-e894098b46243743-01"
    },
    "eventType": "microsoft.iot.telemetry",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "eventTime": "0001-01-01T00:00:00Z",
    "topic": "/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.EventGrid/topics/<topic-name>"
}

Következő lépések

Megtudhatja, hogyan kézbesíthet eseményeket különböző célhelyekre végpontok és útvonalak használatával: