Skip to content

Commit da07b40

Browse files
Merge pull request #211893 from baanders/9-20-telemetry
ADT: Update event descriptions
2 parents 0031723 + b4dd0b8 commit da07b40

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

articles/digital-twins/concepts-event-notifications.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ titleSuffix: Azure Digital Twins
55
description: Learn to interpret various event types and their different notification messages.
66
author: baanders
77
ms.author: baanders # Microsoft employees only
8-
ms.date: 03/01/2022
8+
ms.date: 09/20/2022
99
ms.topic: conceptual
1010
ms.service: digital-twins
1111
ms.custom: contperf-fy21q4
@@ -106,7 +106,8 @@ The data in the corresponding notification (if synchronously executed by the ser
106106
}
107107
```
108108

109-
This data is the information that will go in the `data` field of the lifecycle notification message.
109+
>[!NOTE]
110+
> Azure Digital Twins currently doesn't support [filtering events](how-to-manage-routes.md#filter-events) based on fields within an array. This includes filtering on properties within a `patch` section of a digital twin change notification.
110111
111112
## Digital twin lifecycle notifications
112113

@@ -274,7 +275,7 @@ Here's an example of the data for a create or delete relationship notification.
274275

275276
## Digital twin telemetry messages
276277

277-
*Telemetry messages* are received in Azure Digital Twins from connected devices that collect and send measurements.
278+
Digital twins can use the [SendTelemetry API](/rest/api/digital-twins/dataplane/twins/digitaltwins_sendtelemetry) to emit *telemetry messages* and send them to egress endpoints.
278279

279280
### Properties
280281

@@ -283,17 +284,17 @@ Here are the fields in the body of a telemetry message.
283284
| Name | Value |
284285
| --- | --- |
285286
| `id` | Identifier of the notification, which is provided by the customer when calling the telemetry API. |
286-
| `source` | Fully qualified name of the twin that the telemetry event was sent to. Uses the following format: `<your-Digital-Twin-instance>.api.<your-region>.digitaltwins.azure.net/<twin-ID>`. |
287+
| `source` | Fully qualified name of the twin that the telemetry event was sent from. Uses the following format: `<your-Digital-Twin-instance>.api.<your-region>.digitaltwins.azure.net/<twin-ID>`. |
287288
| `specversion` | *1.0*<br>The message conforms to this version of the [CloudEvents spec](https://github.com/cloudevents/spec). |
288289
| `type` | `microsoft.iot.telemetry` |
289-
| `data` | The telemetry message that has been sent to twins. The payload is unmodified and may not align with the schema of the twin that has been sent the telemetry. |
290+
| `data` | The telemetry message being sent from the twin. The payload does not need to align with any schema defined in your Azure Digital Twins instance. |
290291
| `dataschema` | The data schema is the model ID of the twin or the component that emits the telemetry. For example, `dtmi:example:com:floor4;2`. |
291292
| `datacontenttype` | `application/json` |
292293
| `traceparent` | A W3C trace context for the event. |
293294

294295
### Body details
295296

296-
The body contains the telemetry measurement along with some contextual information about the device.
297+
The body contains the telemetry measurement along with some contextual information about the twin.
297298

298299
Here's an example telemetry message body:
299300

0 commit comments

Comments
 (0)