Egress a koncové body ve službě Azure Digital Twins

Článek
01/21/2020

Důležité

Byla vydána nová verze služby Azure Digital Twins. Vzhledem k rozšířeným funkcím nové služby byla původní služba Azure Digital Twins (popsaná v této sadě dokumentace) vyřazena.

Pokud chcete zobrazit dokumentaci k nové službě, navštivte aktivní dokumentaci ke službě Azure Digital Twins.

Koncové body Služby Azure Digital Twins představují zprávu nebo zprostředkovatele událostí v rámci předplatného Azure uživatele. Události a zprávy se dají odesílat do témat Azure Event Hubs, Azure Event Grid a Azure Service Bus.

Události se směrují na koncové body podle předdefinovaných předvoleb směrování. Uživatelé určují, které typy událostí můžou každý koncový bod přijímat.

Další informace o událostech, směrování a typech událostí najdete v tématu Směrování událostí a zpráv ve službě Azure Digital Twins.

událost

Události se odesílají objekty IoT (například zařízení a senzory) pro zpracování zpráv Azure a zprostředkovatelů událostí. Události jsou definovány následujícími Azure Event Grid odkazy na schéma událostí.

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

Atribut	Typ	Description
id	řetězec	Jedinečný identifikátor události.
subject	řetězec	Cesta k předmětu události, kterou definuje vydavatel.
data	object	Data událostí specifická pro poskytovatele prostředků.
eventType	řetězec	Jeden z registrovaných typů události pro tento zdroj události.
eventTime	řetězec	Čas vygenerování události na základě času UTC poskytovatele.
dataVersion	řetězec	Verze schématu datového objektu. Verzi schématu definuje vydavatel.
metadataVersion	řetězec	Verze schématu metadat události. Schéma vlastností nejvyšší úrovně definuje Event Grid. Tuto hodnotu poskytuje Event Grid.
téma	řetězec	Úplná cesta prostředku ke zdroji událostí. Toto pole není zapisovatelné. Tuto hodnotu poskytuje Event Grid.

Další informace o schématu událostí Event Gridu:

Projděte si referenční informace ke schématu událostí Azure Event Grid.
Přečtěte si referenční informace k sadě Azure EventGrid Node.js SDK EventGridEvent.

Typy událostí

Typy událostí klasifikují povahu události a jsou nastavené v poli eventType . Dostupné typy událostí jsou uvedeny v následujícím seznamu:

TopologyOperation
UdfCustom
SensorChange
SpaceChange
DeviceMessage

Formáty událostí pro každý typ události jsou dále popsány v následujících pododdílech.

TopologyOperation

TopologyOperation se vztahuje na změny grafu. Vlastnost předmětu určuje typ ovlivněného objektu. Tato událost může aktivovat následující typy objektů:

Zařízení
DeviceBlobMetadata
DeviceExtendedProperty
ExtendedPropertyKey
ExtendedType
Keystore
Sestava
RoleDefinition
Senzor
SensorBlobMetadata
SensorExtendedProperty
Místo
SpaceBlobMetadata
SpaceExtendedProperty
SpaceResource
SpaceRoleAssignment
Systém
Uživatel
UserBlobMetadata
UserExtendedProperty

Příklad

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

Hodnota	Nahradit hodnotou
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

UdfCustom

UdfCustom je událost odeslaná uživatelem definovanou funkcí (UDF).

Důležité

Tato událost musí být explicitně odeslána ze samotného UDF.

Příklad

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

Hodnota	Nahradit hodnotou
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

SensorChange

SensorChange je aktualizace stavu senzoru na základě změn telemetrie.

Příklad

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

Hodnota	Nahradit hodnotou
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

SpaceChange

SpaceChange je aktualizace stavu prostoru na základě změn telemetrie.

Příklad

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

Hodnota	Nahradit hodnotou
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

DeviceMessage

Pomocí deviceMessage můžete zadat připojení EventHubu , ke kterému se dají směrovat nezpracované telemetrické události i z Azure Digital Twins.

Poznámka

DeviceMessage je možné kombinovat pouze s EventHubem. DeviceMessage nemůžete kombinovat s žádným z dalších typů událostí.
Můžete zadat pouze jeden koncový bod kombinace typu EventHub nebo DeviceMessage.

Konfigurace koncových bodů

Správa koncových bodů se provádí prostřednictvím rozhraní API koncových bodů.

V následujících YOUR_MANAGEMENT_API_URL příkladech se odkazuje na identifikátor URI rozhraní API služby Digital Twins:

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

Name	Nahradit hodnotou
YOUR_INSTANCE_NAME	Název instance služby Azure Digital Twins
YOUR_LOCATION	Oblast, ve které je vaše instance hostovaná

Následující příklady ukazují, jak nakonfigurovat podporované koncové body.

Důležité

Věnujte pozornost atributu eventTypes . Definuje, které typy událostí se zpracovávají koncovým bodem, a určí tak jeho směrování.

Ověřený požadavek HTTP POST na:

YOUR_MANAGEMENT_API_URL/endpoints

Trasa k Service Bus typů událostí SensorChange, SpaceChange a TopologyOperation:

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

Hodnota	Nahradit hodnotou
YOUR_NAMESPACE	Obor názvů vašeho koncového bodu
YOUR_PRIMARY_KEY	Primární připojovací řetězec použitý k ověření
YOUR_SECONDARY_KEY	Sekundární připojovací řetězec použitý k ověření
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

Směrování na typy událostí Event Grid SensorChange, SpaceChange a TopologyOperation:

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

Hodnota	Nahradit hodnotou
YOUR_PRIMARY_KEY	Primární připojovací řetězec použitý k ověření
YOUR_SECONDARY_KEY	Sekundární připojovací řetězec použitý k ověření
YOUR_TOPIC_NAME	Název přizpůsobeného tématu

Směrování na typy událostí Event Hubs SensorChange, SpaceChange a 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"
}

Hodnota	Nahradit hodnotou
YOUR_NAMESPACE	Obor názvů vašeho koncového bodu
YOUR_PRIMARY_KEY	Primární připojovací řetězec použitý k ověření
YOUR_SECONDARY_KEY	Sekundární připojovací řetězec použitý k ověření
YOUR_EVENT_HUB_NAME	Název centra událostí

Trasa na typ události Event Hubs DeviceMessage Zahrnutí do připojovacíhoEntityPath řetězce je povinné:

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

Hodnota	Nahradit hodnotou
YOUR_NAMESPACE	Obor názvů vašeho koncového bodu
YOUR_PRIMARY_KEY	Primární připojovací řetězec použitý k ověření
YOUR_SECONDARY_KEY	Sekundární připojovací řetězec použitý k ověření
YOUR_EVENT_HUB_NAME	Název centra událostí

Poznámka

Po vytvoření nového koncového bodu může trvat až 5 až 10 minut, než začnete přijímat události v koncovém bodu.

Primární a sekundární připojovací klíče

Když se primární připojovací klíč stane neoprávněným, systém automaticky pokusí sekundární připojovací klíč. To poskytuje zálohu a umožňuje možnost řádného ověřování a aktualizace primárního klíče prostřednictvím rozhraní ENDPOINTS API.

Pokud jsou primární i sekundární klíče připojení neoprávněné, systém zadá exponenciální dobu čekání na 30 minut. Události se zahodí na každou aktivovanou dobu čekání v back-off.

Kdykoli je systém ve stavu čekání back-off, aktualizace klíčů připojení prostřednictvím rozhraní ENDPOINTS API může trvat až 30 minut, než se projeví.

Nedostupné koncové body

Když se koncový bod stane nedostupným, systém zadá exponenciální dobu čekání do 30 minut. Události se zahodí na každou aktivovanou dobu čekání v back-off.

Další kroky

Zjistěte , jak používat Azure Digital Twins Swagger.
Další informace o směrování událostí a zpráv ve službě Azure Digital Twins

Sdílet prostřednictvím

Egress a koncové body ve službě Azure Digital Twins

událost

Typy událostí

TopologyOperation

Příklad

UdfCustom

Příklad

SensorChange

Příklad

SpaceChange

Příklad

DeviceMessage

Konfigurace koncových bodů

Primární a sekundární připojovací klíče

Nedostupné koncové body

Další kroky

Další materiály