Skip to content

Commit fb93b69

Browse files
committed
Tidy
1 parent fd45701 commit fb93b69

7 files changed

+21
-24
lines changed

articles/iot-central/core/howto-manage-data-export-with-rest-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The request body has some required fields:
5757
* `connectionString`: The connection string for accessing the destination resource.
5858
* `containerName`: For a blob storage destination, the name of the container where data should be written.
5959

60-
The response to this request looks like the following example:
60+
The response to this request looks like the following example:
6161

6262
```json
6363
{
@@ -99,7 +99,7 @@ Use the following request to retrieve a list of destinations from your applicati
9999
GET https://{your app subdomain}/api/dataExport/destinations?api-version=2022-10-31-preview
100100
```
101101

102-
The response to this request looks like the following example:
102+
The response to this request looks like the following example:
103103

104104
```json
105105
{
@@ -206,7 +206,7 @@ There are some optional fields you can use to add more details to the export.
206206
* `enrichments`: Extra pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.
207207
* `filter`: Query defining which events from the source should be exported.
208208

209-
The response to this request looks like the following example:
209+
The response to this request looks like the following example:
210210

211211
```json
212212
{
@@ -257,7 +257,7 @@ Use the following request to retrieve a list of export definitions from your app
257257
GET https://{your app subdomain}/api/dataExport/exports?api-version=2022-10-31-preview
258258
```
259259

260-
The response to this request looks like the following example:
260+
The response to this request looks like the following example:
261261

262262
```json
263263
{

articles/iot-central/core/howto-manage-deployment-manifests-with-rest-api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services: iot-central
1212

1313
# How to use the IoT Central REST API to manage deployment manifests
1414

15-
A deployment manifest lets you specify the modules the IoT Edge runtime should download and configure. An IoT Edge device can download a deployment manifest when it first connects to your IoT Central application. This article describes how to manage deployment manifests in your IoT Central application by using the REST API.
15+
A deployment manifest lets you specify the modules the IoT Edge runtime should download and configure. An IoT Edge device can download a deployment manifest when it first connects to your IoT Central application. This article describes how to manage deployment manifests stored in your IoT Central application by using the REST API.
1616

1717
To learn more about IoT Edge and IoT Central, see [Connect Azure IoT Edge devices to an Azure IoT Central application](concepts-iot-edge.md).
1818

@@ -532,6 +532,7 @@ The response to this request looks like the following example:
532532

533533
## Assign a deployment manifest to a device
534534

535+
To use a deployment manifest that's already stored in your IoT Central application, first use the [Get a deployment manifest](#get-a-deployment-manifest) API to fetch it.
535536
Use the following request to assign a deployment manifest to an IoT Edge device in your IoT Central application:
536537

537538
```http

articles/iot-central/core/howto-manage-device-templates-with-rest-api.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Each entry in the list of interfaces in the implements section has a:
189189
* `name`: the programming name of the interface.
190190
* `schema`: the interface the capability model implements.
191191

192-
The response to this request looks like the following example:
192+
The response to this request looks like the following example:
193193

194194
```json
195195
{
@@ -737,7 +737,7 @@ Use the following request to retrieve a list of device templates from your appli
737737
GET https://{your app subdomain}/api/deviceTemplates?api-version=2022-07-31
738738
```
739739

740-
The response to this request looks like the following example:
740+
The response to this request looks like the following example:
741741

742742
```json
743743
{
@@ -1057,7 +1057,6 @@ The response includes a **nextLink** value that you can use to retrieve the next
10571057

10581058
Use **$filter** to create expressions that filter the list of device templates. The following table shows the comparison operators you can use:
10591059

1060-
10611060
| Comparison Operator | Symbol | Example |
10621061
| -------------------- | ------ | ------------------------------ |
10631062
| Equals | eq | `'@id' eq 'dtmi:example:test;1'` |
@@ -1086,7 +1085,7 @@ Currently, *$filter* works with the following device template fields:
10861085

10871086
Currently, the only supported filter function for device template lists is the `contains` function:
10881087

1089-
```
1088+
```txt
10901089
$filter=contains(displayName, 'template1')
10911090
$filter=contains(displayName, 'template1) eq false
10921091
```
@@ -1176,12 +1175,12 @@ The response to this request looks like the following example:
11761175

11771176
Use **$orderby** to sort the results. Currently, **$orderby** only lets you sort on **displayName**. By default, **$orderby** sorts in ascending order. Use **desc** to sort in descending order, for example:
11781177

1179-
```
1178+
```txt
11801179
$orderby=displayName
11811180
$orderby=displayName desc
11821181
```
11831182

1184-
The following example shows how to retrieve all the device templates where the result is sorted by `displayName` :
1183+
The following example shows how to retrieve all the device templates where the result is sorted by `displayName`:
11851184

11861185
```http
11871186
GET https://{your app subdomain}/api/deviceTemplates?api-version=2022-07-31&$orderby=displayName

articles/iot-central/core/howto-manage-devices-with-rest-api.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to use the IoT Central REST API to manage devices
33
description: How to use the IoT Central REST API to add devices in an application
44
author: dominicbetts
55
ms.author: dobett
6-
ms.date: 06/22/2022
6+
ms.date: 11/30/2022
77
ms.topic: how-to
88
ms.service: iot-central
99
services: iot-central
@@ -250,7 +250,6 @@ The response includes a **nextLink** value that you can use to retrieve the next
250250

251251
Use **$filter** to create expressions that filter the list of devices. The following table shows the comparison operators you can use:
252252

253-
254253
| Comparison Operator | Symbol | Example |
255254
| -------------------- | ------ | --------------------------------------- |
256255
| Equals | eq | `id eq 'device1' and scopes eq 'redmond'` |
@@ -429,7 +428,7 @@ The request body has some required fields:
429428

430429
The organizations field is only used when an application has an organization hierarchy defined. To learn more about organizations, see [Manage IoT Central organizations](howto-edit-device-template.md)
431430

432-
The response to this request looks like the following example:
431+
The response to this request looks like the following example:
433432

434433
```json
435434
{
@@ -512,7 +511,7 @@ Use the following request to retrieve a list of device groups from your applicat
512511
GET https://{your app subdomain}/api/deviceGroups?api-version=2022-07-31
513512
```
514513

515-
The response to this request looks like the following example:
514+
The response to this request looks like the following example:
516515

517516
```json
518517
{

articles/iot-central/core/howto-manage-jobs-with-rest-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,6 @@ PUT https://{your app subdomain}.azureiotcentral.com/api/jobs/job-006?api-versio
233233

234234
The `group` field in the request body identifies a device group in your IoT Central application. A job uses a device group to identify the set of devices the job operates on.
235235

236-
237236
If you don't already have a suitable device group, you can create one with REST API call. The following example creates a device group with `group1` as the group ID:
238237

239238
```http

articles/iot-central/core/howto-manage-organizations-with-rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ The REST API lets you list the roles defined in your IoT Central application. Us
197197
GET https://{your app subdomain}.azureiotcentral.com/api/roles?api-version=2022-07-31
198198
```
199199

200-
The response to this request looks like the following example that includes the application role and organization role IDs.
200+
The response to this request looks like the following example that includes the application role and organization role IDs.
201201

202202
```json
203203
{
@@ -394,7 +394,7 @@ The request body has some required fields:
394394
* `description`: Short summary of device group.
395395
* `organizations` : List of organization IDs that the device is a part of. Currently, you can only associate a device with a single organization.
396396

397-
The response to this request looks like the following example:
397+
The response to this request looks like the following example:
398398

399399
```json
400400
{
@@ -410,4 +410,4 @@ The response to this request looks like the following example:
410410

411411
## Next steps
412412

413-
Now that you've learned how to manage organizations with the REST API, a suggested next step is to [How to use the IoT Central REST API to manage data exports.](howto-manage-data-export-with-rest-api.md)
413+
Now that you've learned how to manage organizations with the REST API, a suggested next step is to [How to use the IoT Central REST API to manage data exports.](howto-manage-data-export-with-rest-api.md)

articles/iot-central/core/howto-upload-file-rest-api.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ The request body has the following fields:
157157
}
158158
```
159159

160-
The response to this request looks like the following example:
160+
The response to this request looks like the following example:
161161

162162
```json
163163
{
@@ -235,7 +235,7 @@ DELETE https://{your-app-subdomain}.azureiotcentral.com/api/fileUploads?api-vers
235235

236236
After you [configure file uploads](#add-a-file-upload-storage-account-configuration) in your IoT Central application, you can test it with the sample code. If you haven't already cloned the file upload sample repository, use the following commands to clone it to a suitable location on your local machine and install the dependent packages:
237237

238-
```
238+
```cmd/sh
239239
git clone https://github.com/azure-Samples/iot-central-file-upload-device
240240
cd iotc-file-upload-device
241241
npm i
@@ -278,7 +278,7 @@ Copy the values for `ID scope`, `Device ID`, and `Primary key`. You'll use these
278278

279279
Open the git repository you downloaded in VS code. Create an ".env" file at the root of your project and add the values you copied above. The file should look like the sample below with the values you made a note of previously.
280280

281-
```
281+
```cmd/sh
282282
scopeId=<YOUR_SCOPE_ID>
283283
deviceId=<YOUR_DEVICE_ID>
284284
deviceKey=<YOUR_PRIMARY_KEY>
@@ -287,8 +287,7 @@ modelId=dtmi:IoTCentral:IotCentralFileUploadDevice;1
287287

288288
Open the git repository you downloaded in VS code. Press F5 to run/debug the sample. In your terminal window you see that the device is registered and is connected to IoT Central:
289289

290-
```
291-
290+
```cmd/sh
292291
Starting IoT Central device...
293292
> Machine: Windows_NT, 8 core, freemem=6674mb, totalmem=16157mb
294293
Starting device registration...

0 commit comments

Comments
 (0)