Skip to content

Commit fd45701

Browse files
dominicbettsdominicbetts
committed
Acrolinx issues
1 parent 8e3bd4c commit fd45701

7 files changed

+41
-41
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ PUT https://{your app subdomain}.azureiotcentral.com/api/dashboards/{dashboardId
5454
The request body has some required fields:
5555

5656
* `@displayName`: Display name of the dashboard.
57-
* `@favorite`: Is the dashboard in the favorites list.
57+
* `@favorite`: Is the dashboard in the favorites list?
5858
* `group`: Device group ID.
5959
* `Tile` : Configuration specifying tile object, including the layout, display name, and configuration.
6060

‎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
@@ -53,7 +53,7 @@ The following example shows a request body that creates a blob storage destinati
5353
The request body has some required fields:
5454

5555
* `displayName`: Display name of the destination.
56-
* `type`: Type of destination object which can be one of: `blobstorage@v1`, `dataexplorer@v1`, `eventhubs@v1`, `servicebusqueue@v1`, `servicebustopic@v1`, `webhook@v1`.
56+
* `type`: Type of destination object. One of: `blobstorage@v1`, `dataexplorer@v1`, `eventhubs@v1`, `servicebusqueue@v1`, `servicebustopic@v1`, `webhook@v1`.
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

@@ -134,7 +134,7 @@ The response to this request looks like the following example:
134134
PATCH https://{your app subdomain}/api/dataExport/destinations/{destinationId}?api-version=2022-10-31-preview
135135
```
136136

137-
You can use this to perform an incremental update to an export. The sample request body looks like the following example that updates the `displayName` to a destination:
137+
You can use this call to perform an incremental update to an export. The sample request body looks like the following example that updates the `displayName` to a destination:
138138

139139
```json
140140
{
@@ -203,7 +203,7 @@ The request body has some required fields:
203203

204204
There are some optional fields you can use to add more details to the export.
205205

206-
* `enrichments`: Additional 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.
206+
* `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

209209
The response to this request looks like the following example:
@@ -306,7 +306,7 @@ The response to this request looks like the following example:
306306
PATCH https://{your app subdomain}/dataExport/exports/{exportId}?api-version=2022-10-31-preview
307307
```
308308

309-
You can use this to perform an incremental update to an export. The sample request body looks like the following example that updates the `enrichments` to an export:
309+
You can use this call to perform an incremental update to an export. The sample request body looks like the following example that updates the `enrichments` to an export:
310310

311311
```json
312312
{

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

Lines changed: 1 addition & 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 these 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 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

‎articles/iot-central/core/howto-manage-deployment-manifests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: how-to
1111

1212
# Manage IoT Edge deployment manifests in your IoT Central application
1313

14-
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 you manage these deployment manifests in your IoT Central application.
14+
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 you manage deployment manifests in your IoT Central application.
1515

1616
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).
1717

@@ -62,7 +62,7 @@ To completely replace the content of a deployment manifest:
6262

6363
1. Navigate to the **Edge manifests** page.
6464

65-
1. Click on the name of the deployment manifest you want to replace.
65+
1. Select the deployment manifest you want to replace.
6666

6767
1. In the **Customize** dialog, browse for a new deployment manifest file to upload or choose an existing deployment manifest as a starting point. IoT Central validates any uploaded files.
6868

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ PUT https://{your app subdomain}/api/deviceTemplates/{deviceTemplateId}?api-vers
4949
>[!NOTE]
5050
>Device template IDs follow the [DTDL](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) naming convention, for example: `dtmi:contoso:mythermostattemplate;1`
5151
52-
The following example shows a request body that adds a device template for a thermostat device. The `capabilityModel` includes temperature telemetry, two properties, and a command. The device template defines the `CustomerName` cloud property and customizes the `targetTemperature` property with `decimalPlaces`, `displayUnit`, `maxValue`, and `minValue`. The value of the device template `@id` must match the `deviceTemplateId` value in the URL. The value of the device template `@id` is not the same as the value of the `capabilityModel` `@id` value.
52+
The following example shows a request body that adds a device template for a thermostat device. The `capabilityModel` includes temperature telemetry, two properties, and a command. The device template defines the `CustomerName` cloud property and customizes the `targetTemperature` property with `decimalPlaces`, `displayUnit`, `maxValue`, and `minValue`. The value of the device template `@id` must match the `deviceTemplateId` value in the URL. The value of the device template `@id` isn't the same as the value of the `capabilityModel` `@id` value.
5353

5454
```json
5555
{
@@ -1060,27 +1060,27 @@ Use **$filter** to create expressions that filter the list of device templates.
10601060

10611061
| Comparison Operator | Symbol | Example |
10621062
| -------------------- | ------ | ------------------------------ |
1063-
| Equals | eq | '@id' eq 'dtmi:example:test;1' |
1064-
| Not Equals | ne | displayName ne 'template 1' |
1065-
| Less than or equals | le | displayName le 'template A' |
1066-
| Less than | lt | displayName lt 'template B' |
1067-
| Greater than or equals | ge | displayName ge 'template A' |
1068-
| Greater than | gt | displayName gt 'template B' |
1063+
| Equals | eq | `'@id' eq 'dtmi:example:test;1'` |
1064+
| Not Equals | ne | `displayName ne 'template 1'` |
1065+
| Less than or equals | le | `displayName le 'template A'` |
1066+
| Less than | lt | `displayName lt 'template B'` |
1067+
| Greater than or equals | ge | `displayName ge 'template A'` |
1068+
| Greater than | gt | `displayName gt 'template B'` |
10691069

10701070
The following table shows the logic operators you can use in *$filter* expressions:
10711071

10721072
| Logic Operator | Symbol | Example |
10731073
| -------------- | ------ | ------------------------------------------------------------------------------------ |
1074-
| AND | and | '@id' eq 'dtmi:example:test;1' and capabilityModelId eq 'dtmi:example:test:model1;1' |
1075-
| OR | or | '@id' eq 'dtmi:example:test;1' or displayName ge 'template' |
1074+
| AND | and | `'@id' eq 'dtmi:example:test;1' and capabilityModelId eq 'dtmi:example:test:model1;1'` |
1075+
| OR | or | `'@id' eq 'dtmi:example:test;1' or displayName ge 'template'` |
10761076

10771077
Currently, *$filter* works with the following device template fields:
10781078

10791079
| FieldName | Type | Description |
10801080
| ----------------- | ------ | ----------------------------------- |
1081-
| @id | string | Device template ID |
1082-
| displayName | string | Device template display name |
1083-
| capabilityModelId | string | Device template capability model ID |
1081+
| `@id` | string | Device template ID |
1082+
| `displayName` | string | Device template display name |
1083+
| `capabilityModelId` | string | Device template capability model ID |
10841084

10851085
**$filter supported functions:**
10861086

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ The following example shows a request body that adds a device for a device templ
5555
The request body has some required fields:
5656

5757
* `@displayName`: Display name of the device.
58-
* `@enabled`: declares that this object is an interface.
58+
* `@enabled`: Declares that this object is an interface.
5959
* `@etag`: ETag used to prevent conflict in device updates.
60-
* `simulated`: Whether the device is simulated.
60+
* `simulated`: Is the device simulated?
6161
* `template` : The device template definition for the device.
6262

6363
The response to this request looks like the following example:
@@ -253,37 +253,37 @@ Use **$filter** to create expressions that filter the list of devices. The follo
253253

254254
| Comparison Operator | Symbol | Example |
255255
| -------------------- | ------ | --------------------------------------- |
256-
| Equals | eq | id eq 'device1' and scopes eq 'redmond' |
257-
| Not Equals | ne | Enabled ne true |
258-
| Less than or equals | le | contains(displayName, 'device1') le -1 |
259-
| Less than | lt | contains(displayName, 'device1') lt 0 |
260-
| Greater than or equals | ge | contains(displayName, 'device1') ge 0 |
261-
| Greater than | gt | contains(displayName, 'device1') gt 0 |
256+
| Equals | eq | `id eq 'device1' and scopes eq 'redmond'` |
257+
| Not Equals | ne | `Enabled ne true` |
258+
| Less than or equals | le | `contains(displayName, 'device1') le -1` |
259+
| Less than | lt | `contains(displayName, 'device1') lt 0` |
260+
| Greater than or equals | ge | `contains(displayName, 'device1') ge 0` |
261+
| Greater than | gt | `contains(displayName, 'device1') gt 0` |
262262

263263
The following table shows the logic operators you can use in *$filter* expressions:
264264

265265
| Logic Operator | Symbol | Example |
266266
| -------------- | ------ | ------------------------------------- |
267-
| AND | and | id eq 'device1' and enabled eq true |
268-
| OR | or | id eq 'device1' or simulated eq false |
267+
| AND | and | `id eq 'device1' and enabled eq true` |
268+
| OR | or | `id eq 'device1' or simulated eq false` |
269269

270270
Currently, *$filter* works with the following device fields:
271271

272272
| FieldName | Type | Description |
273273
| ----------- | ------- | ------------------------- |
274-
| id | string | Device ID |
275-
| displayName | string | Device display name |
276-
| enabled | boolean | Device enabled status |
277-
| provisioned | boolean | Device provisioned status |
278-
| simulated | boolean | Device simulated status |
279-
| template | string | Device template ID |
280-
| scopes | string | organization ID |
274+
| `id` | string | Device ID |
275+
| `displayName` | string | Device display name |
276+
| `enabled` | boolean | Device enabled status |
277+
| `provisioned` | boolean | Device provisioned status |
278+
| `simulated` | boolean | Device simulated status |
279+
| `template` | string | Device template ID |
280+
| `scopes` | string | organization ID |
281281

282282
**$filter supported functions:**
283283

284284
Currently, the only supported filter function for device lists is the `contains` function:
285285

286-
```
286+
```http
287287
$filter=contains(displayName, 'device1') ge 0
288288
```
289289

@@ -324,7 +324,7 @@ The response to this request looks like the following example:
324324

325325
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:
326326

327-
```
327+
```http
328328
$orderby=displayName
329329
$orderby=displayName desc
330330
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ DELETE https://{your app subdomain}.azureiotcentral.com/api/organizations/{organ
191191

192192
### Manage roles
193193

194-
The REST API lets you list the roles defined in your IoT Central application. Use the following request to retrieve a list of application role and organization role IDs from your application. To learn more see, [How to manage IoT Central organizations](howto-create-organizations.md):
194+
The REST API lets you list the roles defined in your IoT Central application. Use the following request to retrieve a list of application role and organization role IDs from your application. To learn more, see [How to manage IoT Central organizations](howto-create-organizations.md):
195195

196196
```http
197197
GET https://{your app subdomain}.azureiotcentral.com/api/roles?api-version=2022-07-31
@@ -344,7 +344,7 @@ The request body has some required fields:
344344
* `@displayName`: Display name of the device.
345345
* `@enabled`: declares that this object is an interface.
346346
* `@etag`: ETag used to prevent conflict in device updates.
347-
* `simulated`: Whether the device is simulated.
347+
* `simulated`: Is the device simulated?
348348
* `template` : The device template definition for the device.
349349
* `organizations` : List of organization IDs that the device is a part of. Currently, you can only associate a device with a single organization.
350350

0 commit comments

Comments
 (0)