Egress és végpontok az Azure Digital Twinsben

Cikk
01/21/2020

Fontos

Megjelent az Azure Digital Twins szolgáltatás új verziója. Az új szolgáltatás kibővített képességeinek fényében az eredeti Azure Digital Twins szolgáltatás (amelyet ebben a dokumentációs készletben ismertetünk) kivezetettünk.

Az új szolgáltatás dokumentációjának megtekintéséhez tekintse meg az aktív Azure Digital Twins-dokumentációt.

Az Azure Digital Twins-végpontok egy üzenet- vagy eseményközvetítőt jelölnek a felhasználó Azure-előfizetésében. Eseményeket és üzeneteket küldhet Azure Event Hubs, Azure Event Grid és Azure Service Bus témakörökbe.

Az eseményeket a rendszer az előre meghatározott útválasztási beállításoknak megfelelően irányítja a végpontokra. A felhasználók határozzák meg, hogy az egyes végpontok mely eseménytípusokat kapják meg.

Az eseményekről, az útválasztásról és az eseménytípusokról az Azure Digital Twins útválasztási eseményei és üzenetei című témakörben olvashat bővebben.

esemény

Az eseményeket IoT-objektumok (például eszközök és érzékelők) küldik az Azure-üzenet- és eseményközvetítők általi feldolgozáshoz. Az eseményeket az alábbi Azure Event Grid eseményséma-referencia határozza meg.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "subject": "ExtendedPropertyKey",
  "data": {
    "SpacesToNotify": [
      "3a16d146-ca39-49ee-b803-17a18a12ba36"
    ],
    "Id": "00000000-0000-0000-0000-000000000000",
      "Type": "ExtendedPropertyKey",
    "AccessType": "Create"
  },
  "eventType": "TopologyOperation",
  "eventTime": "2018-04-17T17:41:54.9400177Z",
  "dataVersion": "1",
  "metadataVersion": "1",
  "topic": "/subscriptions/YOUR_TOPIC_NAME"
}

Attribútum	Típus	Description
id	sztring	Az esemény egyedi azonosítója.
tárgy	sztring	Az esemény tárgyra mutató, a közzétevő által megadott elérési út.
adatok	object	Az erőforrás-szolgáltatóra vonatkozó eseményadatok.
eventType	sztring	Az eseményforráshoz felvett eseménytípusok egyike.
eventTime	sztring	Az esemény létrejöttének időpontja a szolgáltató UTC-ideje alapján.
dataVersion	sztring	Az adatobjektum sémaverziója. A sémaverziót a közzétevő határozza meg.
metadataVersion	sztring	Az esemény metaadatok sémaverziója. A legfelső szintű tulajdonságokra az Event Grid határozza meg a sémát. Az értéket az Event Grid adja meg.
témakör	sztring	Az eseményforrás teljes erőforrás-elérési útja. Ez a mező nem írható. Az értéket az Event Grid adja meg.

További információ az Event Grid eseménysémáról:

Tekintse át az Azure Event Grid eseményséma referenciáját.
Olvassa el az Azure EventGrid Node.js SDK EventGridEvent referenciáját.

Eseménytípusok

Az eseménytípusok az esemény természetét sorolják be, és az eventType mezőben vannak beállítva. Az elérhető eseménytípusokat az alábbi lista adja meg:

TopologyOperation
UdfCustom
SensorChange
SpaceChange
DeviceMessage

Az egyes eseménytípusok eseményformátumait az alábbi alszakaszok ismertetik.

TopologyOperation

A TopologyOperation a gráfmódosításokra vonatkozik. A tárgy tulajdonság határozza meg az érintett objektum típusát. Az alábbi típusú objektumok aktiválhatják ezt az eseményt:

Eszköz
DeviceBlobMetadata
DeviceExtendedProperty
ExtendedPropertyKey
ExtendedType
Keystore
Jelentés
RoleDefinition
Érzékelő
SensorBlobMetadata
SensorExtendedProperty
Space (Szóköz)
SpaceBlobMetadata
SpaceExtendedProperty
SpaceResource
SpaceRoleAssignment
Rendszer
Felhasználó
UserBlobMetadata
UserExtendedProperty

Példa

{
  "id": "00000000-0000-0000-0000-000000000000",
  "subject": "ExtendedPropertyKey",
  "data": {
    "SpacesToNotify": [
      "3a16d146-ca39-49ee-b803-17a18a12ba36"
    ],
    "Id": "00000000-0000-0000-0000-000000000000",
      "Type": "ExtendedPropertyKey",
    "AccessType": "Create"
  },
  "eventType": "TopologyOperation",
  "eventTime": "2018-04-17T17:41:54.9400177Z",
  "dataVersion": "1",
  "metadataVersion": "1",
  "topic": "/subscriptions/YOUR_TOPIC_NAME"
}

Érték	Csere erre
YOUR_TOPIC_NAME	A testre szabott témakör neve

UdfCustom

Az UdfCustom egy felhasználó által definiált függvény (UDF) által küldött esemény.

Fontos

Ezt az eseményt kifejezetten magának az UDF-nek kell elküldenie.

Példa

{
  "id": "568fd394-380b-46fa-925a-ebb96f658cce",
  "subject": "UdfCustom",
  "data": {
    "TopologyObjectId": "7c799bfc-1bff-4b9e-b15a-669933969d20",
    "ResourceType": "Space",
    "Payload": "\"Room is not available or air quality is poor\"",
    "CorrelationId": "568fd394-380b-46fa-925a-ebb96f658cce"
  },
  "eventType": "UdfCustom",
  "eventTime": "2018-10-02T06:50:15.198Z",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "topic": "/subscriptions/YOUR_TOPIC_NAME"
}

Érték	Csere erre
YOUR_TOPIC_NAME	A testre szabott témakör neve

SensorChange

A SensorChange az érzékelő állapotának a telemetriai változásokon alapuló frissítése.

Példa

{
  "id": "60bf5336-2929-45b4-bb4c-b45699dfe95f",
  "subject": "SensorChange",
  "data": {
    "Type": "Classic",
    "DataType": "Motion",
    "Id": "60bf5336-2929-45b4-bb4c-b45699dfe95f",
    "Value": "False",
    "PreviousValue": "True",
    "EventTimestamp": "2018-04-17T17:46:15.4964262Z",
    "MessageType": "sensor",
    "Properties": {
      "ms-client-request-id": "c9e576b7-5eea-4f61-8617-92a57add5179",
      "ms-activity-id": "ct22YwXEGJ5u.605.0"
    }
  },
  "eventType": "SensorChange",
  "eventTime": "2018-04-17T17:46:18.5452993Z",
  "dataVersion": "1",
  "metadataVersion": "1",
  "topic": "/subscriptions/YOUR_TOPIC_NAME"
}

Érték	Csere erre
YOUR_TOPIC_NAME	A testre szabott témakör neve

SpaceChange

A SpaceChange a tér állapotának a telemetriai változásokon alapuló frissítése.

Példa

{
  "id": "42522e10-b1aa-42ff-a5e7-7181788ffc4b",
  "subject": "SpaceChange",
  "data": {
    "Type": null,
    "DataType": "AvailableAndFresh",
    "Id": "7c799bfc-1bff-4b9e-b15a-669933969d20",
    "Value": "Room is not available or air quality is poor",
    "PreviousValue": null,
    "RawData": null,
    "transactionId": null,
    "EventTimestamp": null,
    "MessageType": null,
    "Properties": null,
    "CorrelationId": "42522e10-b1aa-42ff-a5e7-7181788ffc4b"
  },
  "eventType": "SpaceChange",
  "eventTime": "2018-10-02T06:50:20.128Z",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "topic": "/subscriptions/YOUR_TOPIC_NAME"
}

Érték	Csere erre
YOUR_TOPIC_NAME	A testre szabott témakör neve

DeviceMessage

A DeviceMessage használatával megadhat egy EventHub-kapcsolatot , amelyhez a nyers telemetriai események is irányíthatók az Azure Digital Twinsből.

Megjegyzés

A DeviceMessage csak az EventHubbal kombinálható. A DeviceMessage nem kombinálható a többi eseménytípussal.
Az EventHub vagy a DeviceMessage típus kombinációjából csak egy végpontot adhat meg.

Végpontok konfigurálása

A végpontkezelés a Végpontok API-val történik.

Az alábbi YOUR_MANAGEMENT_API_URL példákban a Digital Twins API-k URI-jára hivatkozunk:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0

Name	Csere erre
YOUR_INSTANCE_NAME	Az Azure Digital Twins-példány neve
YOUR_LOCATION	A régió, amelyen a példány üzemel

Az alábbi példák a támogatott végpontok konfigurálását mutatják be.

Fontos

Ügyeljen az eventTypes attribútumra . Meghatározza, hogy a végpont mely eseménytípusokat kezeli, és így határozza meg az útválasztást.

Hitelesített HTTP POST-kérés a következőre:

YOUR_MANAGEMENT_API_URL/endpoints

Útvonal Service Bus SensorChange, SpaceChange és TopologyOperation eseménytípusokhoz:

{
  "type": "ServiceBus",
  "eventTypes": [
    "SensorChange",
    "SpaceChange",
    "TopologyOperation"
  ],
  "connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY",
  "secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY",
  "path": "YOUR_TOPIC_NAME"
}

Érték	Csere erre
YOUR_NAMESPACE	A végpont névtere
YOUR_PRIMARY_KEY	A hitelesítéshez használt elsődleges kapcsolati sztring
YOUR_SECONDARY_KEY	A hitelesítéshez használt másodlagos kapcsolati sztring
YOUR_TOPIC_NAME	A testre szabott témakör neve

Útvonal event Grid-eseménytípusokhoz SensorChange, SpaceChange és TopologyOperation:

{
  "type": "EventGrid",
  "eventTypes": [
    "SensorChange",
    "SpaceChange",
    "TopologyOperation"
  ],
  "connectionString": "YOUR_PRIMARY_KEY",
  "secondaryConnectionString": "YOUR_SECONDARY_KEY",
  "path": "YOUR_TOPIC_NAME.westus-1.eventgrid.azure.net"
}

Érték	Csere erre
YOUR_PRIMARY_KEY	A hitelesítéshez használt elsődleges kapcsolati sztring
YOUR_SECONDARY_KEY	A hitelesítéshez használt másodlagos kapcsolati sztring
YOUR_TOPIC_NAME	A testre szabott témakör neve

Útvonal az Event Hubs eseménytípusaihoz SensorChange, SpaceChange és TopologyOperation:

{
  "type": "EventHub",
  "eventTypes": [
    "SensorChange",
    "SpaceChange",
    "TopologyOperation"
  ],
  "connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY",
  "secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY",
  "path": "YOUR_EVENT_HUB_NAME"
}

Érték	Csere erre
YOUR_NAMESPACE	A végpont névtere
YOUR_PRIMARY_KEY	A hitelesítéshez használt elsődleges kapcsolati sztring
YOUR_SECONDARY_KEY	A hitelesítéshez használt másodlagos kapcsolati sztring
YOUR_EVENT_HUB_NAME	Az eseményközpont neve

Útvonal az Event Hubs DeviceMessage eseménytípusához. A connectionString használata EntityPath kötelező:

{
  "type": "EventHub",
  "eventTypes": [
    "DeviceMessage"
  ],
  "connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY;EntityPath=YOUR_EVENT_HUB_NAME",
  "secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY;EntityPath=YOUR_EVENT_HUB_NAME",
  "path": "YOUR_EVENT_HUB_NAME"
}

Érték	Csere erre
YOUR_NAMESPACE	A végpont névtere
YOUR_PRIMARY_KEY	A hitelesítéshez használt elsődleges kapcsolati sztring
YOUR_SECONDARY_KEY	A hitelesítéshez használt másodlagos kapcsolati sztring
YOUR_EVENT_HUB_NAME	Az eseményközpont neve

Megjegyzés

Új végpont létrehozásakor akár 5–10 percet is igénybe vehet, amíg elkezdenek eseményeket fogadni a végponton.

Elsődleges és másodlagos kapcsolati kulcsok

Ha egy elsődleges kapcsolati kulcs jogosulatlanná válik, a rendszer automatikusan megpróbálja a másodlagos kapcsolatkulcsot. Ez biztonsági mentést biztosít, és lehetővé teszi az elsődleges kulcs szabályos hitelesítését és frissítését az Endpoints API-val.

Ha az elsődleges és a másodlagos kapcsolati kulcs sem engedélyezett, a rendszer exponenciális, legfeljebb 30 perces visszaállási várakozási időt ad meg. A rendszer elveti az eseményeket az egyes aktivált visszatartási várakozási időkre.

Ha a rendszer háttérbeli várakozási állapotban van, a kapcsolati kulcsok Endpoints API-val történő frissítése akár 30 percet is igénybe vehet.

Nem elérhető végpontok

Amikor egy végpont elérhetetlenné válik, a rendszer exponenciális, legfeljebb 30 perces visszatartási várakozási időt ad meg. A rendszer elveti az eseményeket az egyes aktivált visszatartási várakozási időkre.

Következő lépések

Ismerje meg az Azure Digital Twins Swagger használatát.
További információ az események és üzenetek útválasztásáról az Azure Digital Twinsben.

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

Egress és végpontok az Azure Digital Twinsben

esemény

Eseménytípusok

TopologyOperation

Példa

UdfCustom

Példa

SensorChange

Példa

SpaceChange

Példa

DeviceMessage

Végpontok konfigurálása

Elsődleges és másodlagos kapcsolati kulcsok

Nem elérhető végpontok

Következő lépések

További források