Skip to content

Commit 94270eb

Browse files
committed
Updating based on feedback
1 parent 0f893a5 commit 94270eb

File tree

1 file changed

+46
-45
lines changed

1 file changed

+46
-45
lines changed

articles/iot-central/preview/howto-export-data.md

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Now that you have a destination to export data to, follow these steps to set up
9999

100100
7. Under **Data to export**, choose the types of data to export by setting the type to **On**.
101101

102-
8. To turn on continuous data export, make sure the **Data export** toggle is **On**. Select **Save**.
102+
8. To turn on continuous data export, make sure the **Enabled** toggle is **On**. Select **Save**.
103103

104104
9. After a few minutes, your data appears in your chosen destination.
105105

@@ -187,8 +187,11 @@ This is an example record exported to blob storage:
187187
Each message or record in a snapshot represents one or more changes to a device and its properties since the last exported message. This includes:
188188

189189
- `id` of the device in IoT Central
190-
- `name` of the device
191-
- Device template Id in `instanceOf`
190+
- `displayName` of the device
191+
- Device template Id in `instanceOf`
192+
- `simulated` flag, true if the device is a simulated device
193+
- `provisioned` flag, true if the device has been provisioned
194+
- `approved` flag, true if the device has been approved to send data
192195
- Property values
193196

194197
Deleted devices aren't exported. Currently, there are no indicators in exported messages for deleted devices.
@@ -255,51 +258,49 @@ This is an example snapshot containing devices and properties data in Blob Stora
255258

256259
```json
257260
{
258-
"body":{
259-
"id": "<device Id>",
260-
"etag": "<etag>",
261-
"displayName": "Sensor 1",
262-
"instanceOf": "<device template Id>",
263-
"simulated": false,
264-
"provisioned": true,
265-
"approved": true,
266-
"properties": {
267-
"sensorComponent": {
268-
"setTemp": "30",
269-
"fwVersion": "2.0.1",
270-
"status": { "first": "first", "second": "second" },
271-
"$metadata": {
272-
"setTemp": {
273-
"desiredValue": "30",
274-
"desiredVersion": 3,
275-
"desiredTimestamp": "2020-02-01T17:15:08.9284049Z",
276-
"ackVersion": 3
277-
},
278-
"fwVersion": { "ackVersion": 3 },
279-
"status": {
280-
"desiredValue": {
281-
"first": "first",
282-
"second": "second"
283-
},
284-
"desiredVersion": 2,
285-
"desiredTimestamp": "2020-02-01T17:15:08.9284049Z",
286-
"ackVersion": 2
287-
}
288-
},
289-
290-
}
291-
},
292-
"installDate": { "installDate": "2020-02-01" }
261+
"id": "<device Id>",
262+
"etag": "<etag>",
263+
"displayName": "Sensor 1",
264+
"instanceOf": "<device template Id>",
265+
"simulated": false,
266+
"provisioned": true,
267+
"approved": true,
268+
"properties": {
269+
"sensorComponent": {
270+
"setTemp": "30",
271+
"fwVersion": "2.0.1",
272+
"status": { "first": "first", "second": "second" },
273+
"$metadata": {
274+
"setTemp": {
275+
"desiredValue": "30",
276+
"desiredVersion": 3,
277+
"desiredTimestamp": "2020-02-01T17:15:08.9284049Z",
278+
"ackVersion": 3
279+
},
280+
"fwVersion": { "ackVersion": 3 },
281+
"status": {
282+
"desiredValue": {
283+
"first": "first",
284+
"second": "second"
285+
},
286+
"desiredVersion": 2,
287+
"desiredTimestamp": "2020-02-01T17:15:08.9284049Z",
288+
"ackVersion": 2
289+
}
290+
},
291+
292+
}
293+
},
294+
"installDate": { "installDate": "2020-02-01" }
293295
}
294296
```
295297

296298
## Device templates
297299

298-
Each message or snapshot record represents one or more changes to a device template since the last exported message. Information sent in each message or record includes:
300+
Each message or snapshot record represents one or more changes to a published device template since the last exported message. Information sent in each message or record includes:
299301

300302
- `id` of the device template which matches the `instanceOf` of the devices stream above
301-
- `name` of the device template
302-
- `version` of the device template
303+
- `displayName` of the device template
303304
- The device `capabilityModel` including its `interfaces`, and the telemetry, properties, and commands definitions
304305
- `cloudProperties` definitions
305306
- Overrides and initial values, inline with the `capabilityModel`
@@ -548,22 +549,22 @@ This is an example snapshot containing devices and properties data in Blob Stora
548549
## Data format change notice
549550

550551
> [!Note]
551-
> The telemetry stream data format is unaffected by this change. Only the Devices and device templates streams of data are affected.
552+
> The telemetry stream data format is unaffected by this change. Only the devices and device templates streams of data are affected.
552553
553554
If you have an existing data export in your preview application with the *Devices* and *Device templates* streams turned on, you will need to update your export by **30 June 2020**. This applies to exports to Azure Blob Storage, Azure Event Hubs, and Azure Service Bus.
554555

555-
Starting 3 February 2020, all new exports in applications with Devices and Device templates enabled will have the data format described above. All exports created prior to this will remain on the old data format until 30 June 2020, after which time these exports will automatically be migrated to the new data format. The new data format matches the [device](https://docs.microsoft.com/rest/api/iotcentral/devices/get), [device component properties](https://docs.microsoft.com/rest/api/iotcentral/devices/getcomponentproperties), and [device template](https://docs.microsoft.com/rest/api/iotcentral/devicetemplates/get) objects in the IoT Central public API.
556+
Starting 3 February 2020, all new exports in applications with Devices and Device templates enabled will have the data format described above. All exports created prior to this will remain on the old data format until 30 June 2020, after which time these exports will automatically be migrated to the new data format. The new data format matches the [devices](https://docs.microsoft.com/rest/api/iotcentral/devices/get), [device properties](https://docs.microsoft.com/rest/api/iotcentral/devices/getproperties), [device cloud property]([device cloud properties](https://docs.microsoft.com/rest/api/iotcentral/devices/getcloudproperties) and [device templates](https://docs.microsoft.com/rest/api/iotcentral/devicetemplates/get) objects in the IoT Central public API.
556557

557558
For **Devices**, notable differences between the old data format and the new data format include:
558559
- `@id` for device is removed, `deviceId` is renamed to `id`
559560
- `provisioned` flag is added to describe the provisioning status of the device
560561
- `approved` flag is added to describe the approval state of the device
561-
- `properties` match the component properties of the API
562+
- `properties` including device and cloud properties, matches entities in the public API
562563

563564
For **Device templates**, notable differences between the old data format and the new data format include:
564565

565566
- `@id` for device template is renamed to `id`
566-
- `@type` is renamed to `types`, and is now an array
567+
- `@type` for the device template is renamed to `types`, and is now an array
567568

568569
### Devices (format deprecated as of 3 February 2020)
569570
```json

0 commit comments

Comments
 (0)