Eseményértesítések

Cikk
08/01/2024

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ípusokat 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 használhatják a műveletek végrehajtásához.

Számos típusú é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 azok megjelenését.

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

É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	a digitális ikertulajdonságok módosítása
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űvelete
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ármilyen digitális ikerkapcsolat-változás
Digitális ikerpéldány telemetriai üzenetei	Telemetriai üzenetek	bármilyen telemetriai üzenet

É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):

Azure Event Grid-eseményséma
HTTP protokollkötés a CloudEventshez.

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ányok változásértesítései a következő digitális ikerpéldányok frissítésekor aktiválódnak:

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

Tulajdonságok

A digitális ikerpéldány változásértesítés törzsének mezői az alábbiak.

Név szerint	Érték
`id`	Az értesítés azonosítója, például egy UUID vagy a szolgáltatás által karbantartott számláló. `source` + `id` minden különálló eseményhez egyedi
`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 ikerpéldány frissítését leíró JSON Patch-dokumentum. További részletekért lásd az alábbi törzsadatokat .
`specversion`	1.0 Az üzenet megfelel a CloudEvents specifikáció jelen verziójának.
`type`	`Microsoft.DigitalTwins.Twin.Update`
`datacontenttype`	`application/json`
`subject`	A digitális ikerpéldány azonosítója
`time`	A digitális 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 üzenetben a data mező tartalmaz egy JSON Patch-dokumentumot, 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>"
}

{
    "specversion": "1.0",
    "id": "39d4abb9-e3ee-4ed5-ad17-2243a9784946",
    "type": "Microsoft.DigitalTwins.Twin.Update",
    "source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "data": {
      "modelId": "dtmi:examplecom:interfaceName;1",
      "patch": [
        {
          "value": "new name",
          "path": "/room",
          "op": "replace"
        }
      ]
    },
    "subject": "example-twin1",
    "time": "2021-12-09T20:28:52.9795363Z",
    "datacontenttype": "application/json",
    "traceparent": "00-2aa957558db348f387ef704b37631a1d-590d733a1b798149-01"
}

Példa az AMQP alkalmazástulajdonságok szakaszának tulajdonságaira:

    "cloudEvents:id": "39d4abb9-e3ee-4ed5-ad17-2243a9784946",
    "cloudEvents:source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "cloudEvents:specversion": "1.0",
    "cloudEvents:type": "Microsoft.DigitalTwins.Twin.Update",
    "cloudEvents:time": "2021-12-09T20:28:52.9795363Z",
    "cloudEvents:subject": "example-twin1",
    "cloudEvents:traceparent": "00-2aa957558db348f387ef704b37631a1d-e66f14eb07b50d40-01"

Példa üzenettörzs az AMQP adatszakaszában:

{
    "modelId": "dtmi:examplecom:interfaceName;1",
    "patch": [
      {
        "value": "new name",
        "path": "/room",
        "op": "replace"
      }
    ]
}

Feljegyzés

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

Digitális iker életciklus-értesítések

Függetlenül attól, hogy a digitális ikerpéldányok IoT Hub-eszközöket képviselnek-e az Azure Digital Twinsben, mind értesítéseket fognak küldeni. Erre az életciklus-értesítések miatt kerülnek, 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

Az életciklus-értesítés törzsének mezői az alábbiak.

Név szerint	Érték
`id`	Az értesítés azonosítója, például egy UUID vagy a szolgáltatás által karbantartott számláló. `source` + `id` minden különálló eseményhez egyedi.
`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 átélő ikerpéldány adatai. További részletekért lásd az alábbi törzsadatokat .
`specversion`	1.0 Az üzenet megfelel a CloudEvents specifikáció jelen 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>"
}

{
    "specversion": "1.0",
    "id": "6ccdb1cd-0dc3-450f-8730-ceccda8439be",
    "type": "Microsoft.DigitalTwins.Twin.Create",
    "source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "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"
        }
      }
    },
    "subject": "example-twin1",
    "time": "2021-12-09T20:28:52.6745538Z",
    "datacontenttype": "application/json",
    "traceparent": "00-2aa957558db348f387ef704b37631a1d-96f834571bf4fe45-01"
}

Példa az AMQP alkalmazástulajdonságok szakaszának tulajdonságaira:

    "cloudEvents:id": "6ccdb1cd-0dc3-450f-8730-ceccda8439be",
    "cloudEvents:source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "cloudEvents:specversion": "1.0",
    "cloudEvents:type": "Microsoft.DigitalTwins.Twin.Create",
    "cloudEvents:time": "2021-12-09T20:28:52.6745538Z",
    "cloudEvents:subject": "example-twin1",
    "cloudEvents:traceparent": "00-2aa957558db348f387ef704b37631a1d-a158c39c72ec1049-01"

Példa üzenettörzs az AMQP adatszakaszában:

{
    "$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"
        }
    }
}

Digitális ikerkapcsolat változásértesítések

A kapcsolatváltozási értesítések akkor aktiválódnak, ha egy digitális ikerpéldány kapcsolatát létrehozták, frissítték vagy törölték.

Tulajdonságok

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

Név szerint	Érték
`id`	Az értesítés azonosítója, például egy UUID vagy a szolgáltatás által karbantartott számláló. `source` + `id` minden különálló eseményhez egyedi
`source`	Az Azure Digital Twins-példány neve, például mydigitaltwins.westus2.azuredigitaltwins.net
`data`	A módosított kapcsolat hasznos adatai. További részletekért lásd az alábbi törzsadatokat .
`specversion`	1.0 Az üzenet megfelel a CloudEvents specifikáció jelen 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>"
}

{
    "specversion": "1.0",
    "id": "4d850574-0a28-4667-a59e-3b382ff0e74e",
    "type": "Microsoft.DigitalTwins.Relationship.Update",
    "source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "data": {
    "modelId": "dtmi:examplecom:interfaceName;1",
    "patch": [
        {
        "value": "new value",
        "path": "/prop1",
        "op": "replace"
        }
    ]
    },
    "subject": "example-twin1/relationships/RuntimeEventsScenario_edge",
    "time": "2021-12-09T20:28:53.2016395Z",
    "datacontenttype": "application/json",
    "traceparent": "00-2aa957558db348f387ef704b37631a1d-723b3f49efd2e445-01"
}

Példa az AMQP alkalmazástulajdonságok szakaszának tulajdonságaira:

    "cloudEvents:id": "4d850574-0a28-4667-a59e-3b382ff0e74e",
    "cloudEvents:source": "my-example-digital-twin.api.sea.digitaltwins.azure.net",
    "cloudEvents:specversion": "1.0",
    "cloudEvents:type": "Microsoft.DigitalTwins.Relationship.Update",
    "cloudEvents:time": "2021-12-09T20:28:53.2016395Z",
    "cloudEvents:subject": "example-twin1/relationships/RuntimeEventsScenario_edge",
    "cloudEvents:traceparent": "00-2aa957558db348f387ef704b37631a1d-6f3805aab2b73e49-01"

Példa üzenettörzs az AMQP adatszakaszában:

{
    "modelId": "dtmi:examplecom:interfaceName;1",
    "patch": [
      {
        "value": "new value",
        "path": "/prop1",
        "op": "replace"
      }
    ]
}

Digitális iker telemetriaüzenetek

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

A telemetriaüzenet törzsének mezői az alábbiak.

Név szerint	Érték
`id`	Az ügyfél által a telemetriai API meghívásakor megadott értesítés azonosítója.
`source`	A telemetriai esemény által küldött ikerpéldány teljes neve. 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>"
}

{
    "specversion": "1.0",
    "id": "622e6818-f042-4be8-96df-1a77ee9caf9b",
    "type": "microsoft.iot.telemetry",
    "source": "my-example-digital-twin.api.sea.digitaltwins.azure.net/digitaltwins/RuntimeEventsScenario_componentTwin_6f6635d8-f1b8-43ec-80fb-bb9453fc611c",
    "data": {
        "prop": "hello from telemetry"
    },
    "dataschema": "dtmi:examplecom:interfaceName;1",
    "subject": "component1",
    "datacontenttype": "application/json-patch+json; charset=utf-8",
    "traceparent": "00-2aa957558db348f387ef704b37631a1d-f58ef0c31162c548-01"
}

Példa az AMQP alkalmazástulajdonságok szakaszának tulajdonságaira:

    "cloudEvents:id": "6f6635d8-f1b8-43ec-80fb-bb9453fc611c",
    "cloudEvents:source": "my-example-digital-twin.api.sea.digitaltwins.azure.net/digitaltwins/example-twin1",
    "cloudEvents:specversion": "1.0",
    "cloudEvents:type": "microsoft.iot.telemetry",
    "cloudEvents:dataschema": "dtmi:examplecom:interfaceName;1",
    "cloudEvents:traceparent": "00-2aa957558db348f387ef704b37631a1d-ce042d67cbbfd948-01"

Példa üzenettörzs az AMQP adatszakaszában:

{
    "Temperature": 50
}

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:

Végpontok és eseményútvonalak

Megosztás a következőn keresztül:

Eseményértesítések

Értesítési struktúra

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

Tulajdonságok

Törzs részletei

Digitális iker életciklus-értesítések

Tulajdonságok

Törzs részletei

Digitális ikerkapcsolat változásértesítések

Tulajdonságok

Törzs részletei

Digitális iker telemetriaüzenetek

Tulajdonságok

Törzs részletei

Következő lépések

Visszajelzés

További források