Skip to content

Commit 49fa72e

Browse files
committed
values variables per convention
1 parent 127eb5a commit 49fa72e

7 files changed

+40
-40
lines changed

articles/digital-twins/concepts-device-ingress.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: bertvanhoof
66
ms.service: digital-twins
77
services: digital-twins
88
ms.topic: conceptual
9-
ms.date: 10/26/2018
9+
ms.date: 11/13/2018
1010
ms.author: alinast
1111
---
1212

@@ -37,20 +37,20 @@ In the following sections, you learn how to get the IoT Hub device connection st
3737
Do a GET call on the Device API with an `includes=ConnectionString` parameter to get the IoT Hub device connection string. Filter by the device GUID or the hardware ID to find the given device.
3838

3939
```plaintext
40-
yourManagementApiUrl/devices/yourDeviceGuid?includes=ConnectionString
40+
YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_GUID?includes=ConnectionString
4141
```
4242

4343
| Parameters | Replace with |
4444
| --- | --- |
45-
| *yourDeviceGuid* | The device ID |
45+
| *YOUR_DEVICE_GUID* | The device ID |
4646

4747
```plaintext
48-
yourManagementApiUrl/devices?hardwareIds=yourDeviceHardwareId&includes=ConnectionString
48+
YOUR_MANAGEMENT_API_URL/devices?hardwareIds=YOUR_DEVICE_HARDWARE_ID&includes=ConnectionString
4949
```
5050

5151
| Your parameter values | Replace with |
5252
| --- | --- |
53-
| *yourDeviceHardwareId* | The device hardware ID |
53+
| *YOUR_DEVICE_HARDWARE_ID* | The device hardware ID |
5454

5555
In the response payload, copy the device's **connectionString** property. You use it when you call the Azure IoT device SDK to send data to Digital Twins.
5656

articles/digital-twins/concepts-objectmodel-spatialgraph.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: bertvanhoof
66
ms.service: digital-twins
77
services: digital-twins
88
ms.topic: conceptual
9-
ms.date: 10/26/2018
9+
ms.date: 11/13/2018
1010
ms.author: alinast
1111
---
1212

@@ -74,13 +74,13 @@ If you deploy a Digital Twins service in your subscription, you become the globa
7474
After you deploy Digital Twins from the [Azure portal](https://portal.azure.com), the [Swagger](https://swagger.io/tools/swagger-ui/) URL of the Management APIs is automatically generated. It's displayed in the Azure portal in the **Overview** section with the following format.
7575

7676
```plaintext
77-
https://yourInstanceName.yourLocation.azuresmartspaces.net/management/swagger
77+
https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
7878
```
7979

8080
| Custom name | Replace with |
8181
| --- | --- |
82-
| yourInstanceName | The name of your Digital Twins instance |
83-
| yourLocation | Which server region your instance is hosted on |
82+
| YOUR_INSTANCE_NAME | The name of your Digital Twins instance |
83+
| YOUR_LOCATION | Which server region your instance is hosted on |
8484

8585
The full URL format appears in this image.
8686

articles/digital-twins/how-to-diagnose-user-defined-functions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@ Without a role assignment created within Management API, the user-defined functi
6464
Check if a role assignment exists for your user-defined function through your Management API:
6565

6666
```plaintext
67-
GET yourManagementApiUrl/roleassignments?path=/&traverse=Down&objectId=yourUserDefinedFunctionId
67+
GET YOUR_MANAGEMENT_API_URL/roleassignments?path=/&traverse=Down&objectId=YOUR_USER_DEFINED_FUNCTION_ID
6868
```
6969

7070
| Parameters | Replace with |
7171
| --- | --- |
72-
| *yourUserDefinedFunctionId* | The ID of the user-defined function to retrieve role assignments for|
72+
| *YOUR_USER_DEFINED_FUNCTION_ID* | The ID of the user-defined function to retrieve role assignments for|
7373

7474
If no role assignment is retrieved, follow this article on [How to create a role assignment for your user-defined function](./how-to-user-defined-functions.md).
7575

@@ -78,13 +78,13 @@ If no role assignment is retrieved, follow this article on [How to create a role
7878
With the following call against your Azure Digital Twins instances' Management API, you will be able to determine if a given matcher applies for the given sensor.
7979

8080
```plaintext
81-
GET yourManagementApiUrl/matchers/yourMatcherIdentifier/evaluate/yourSensorIdentifier?enableLogging=true
81+
GET YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_IDENTIFIER/evaluate/YOUR_SENSOR_IDENTIFIER?enableLogging=true
8282
```
8383

8484
| Parameters | Replace with |
8585
| --- | --- |
86-
| *yourMatcherIdentifier* | The ID of the matcher you wish to evaluate |
87-
| *yourSensorIdentifier* | The ID of the sensor you wish to evaluate |
86+
| *YOUR_MATCHER_IDENTIFIER* | The ID of the matcher you wish to evaluate |
87+
| *YOUR_SENSOR_IDENTIFIER* | The ID of the sensor you wish to evaluate |
8888

8989
Response:
9090

@@ -102,12 +102,12 @@ Response:
102102
With the following call against your Azure Digital Twins instances' Management API, you will be able to determine the identifiers of your user-defined functions that will be triggered by the given sensor's incoming telemetry:
103103

104104
```plaintext
105-
GET yourManagementApiUrl/sensors/yourSensorIdentifier/matchers?includes=UserDefinedFunctions
105+
GET YOUR_MANAGEMENT_API_URL/sensors/YOUR_SENSOR_IDENTIFIER/matchers?includes=UserDefinedFunctions
106106
```
107107

108108
| Parameters | Replace with |
109109
| --- | --- |
110-
| *yourSensorIdentifier* | The ID of the sensor that will be sending telemetry |
110+
| *YOUR_SENSOR_IDENTIFIER* | The ID of the sensor that will be sending telemetry |
111111

112112
Response:
113113

articles/digital-twins/how-to-user-defined-functions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Matchers are graph objects that determine what user-defined functions run for a
3939
The following example matcher evaluates to true on any sensor telemetry event with `"Temperature"` as its data type value. You can create multiple matchers on a user-defined function:
4040

4141
```plaintext
42-
POST yourManagementApiUrl/matchers
42+
POST YOUR_MANAGEMENT_API_URL/matchers
4343
{
4444
"Name": "Temperature Matcher",
4545
"Conditions": [
@@ -67,20 +67,20 @@ After the matchers are created, upload the function snippet with the following *
6767
> - The body is multipart:
6868
> - The first part is about metadata needed for the UDF.
6969
> - The second part is the JavaScript compute logic.
70-
> - In the **userDefinedBoundary** section, replace the **SpaceId** and **Machers** values.
70+
> - In the **USER_DEFINED_BOUNDARY** section, replace the **SpaceId** and **Machers** values.
7171
7272
```plaintext
73-
POST yourManagementApiUrl/userdefinedfunctions with Content-Type: multipart/form-data; boundary="userDefinedBoundary"
73+
POST YOUR_MANAGEMENT_API_URL/userdefinedfunctions with Content-Type: multipart/form-data; boundary="USER_DEFINED_BOUNDARY"
7474
```
7575

7676
| Parameter value | Replace with |
7777
| --- | --- |
78-
| *userDefinedBoundary* | A multipart content boundary name |
78+
| *USER_DEFINED_BOUNDARY* | A multipart content boundary name |
7979

8080
### Body
8181

8282
```plaintext
83-
--userDefinedBoundary
83+
--USER_DEFINED_BOUNDARY
8484
Content-Type: application/json; charset=utf-8
8585
Content-Disposition: form-data; name="metadata"
8686
@@ -90,15 +90,15 @@ Content-Disposition: form-data; name="metadata"
9090
"Description": "The contents of this udf will be executed when matched against incoming telemetry.",
9191
"Matchers": ["YOUR_MATCHER_IDENTIFIER"]
9292
}
93-
--userDefinedBoundary
93+
--USER_DEFINED_BOUNDARY
9494
Content-Disposition: form-data; name="contents"; filename="userDefinedFunction.js"
9595
Content-Type: text/javascript
9696
9797
function process(telemetry, executionContext) {
9898
// Code goes here.
9999
}
100100
101-
--userDefinedBoundary--
101+
--USER_DEFINED_BOUNDARY--
102102
```
103103

104104
| Your value | Replace with |
@@ -184,25 +184,25 @@ We need to create a role assignment for the user-defined function to run under.
184184
1. Query for roles and get the ID of the role you want to assign to the UDF. Pass it to **RoleId**:
185185

186186
```plaintext
187-
GET yourManagementApiUrl/system/roles
187+
GET YOUR_MANAGEMENT_API_URL/system/roles
188188
```
189189
190190
1. **ObjectId** will be the UDF ID that was created earlier.
191191
1. Find the value of **Path** by querying your spaces with `fullpath`.
192192
1. Copy the returned `spacePaths` value. You'll use that in the following code:
193193
194194
```plaintext
195-
GET yourManagementApiUrl/spaces?name=yourSpaceName&includes=fullpath
195+
GET YOUR_MANAGEMENT_API_URL/spaces?name=YOUR_SPACE_NAME&includes=fullpath
196196
```
197197
198198
| Parameter value | Replace with |
199199
| --- | --- |
200-
| *yourSpaceName* | The name of the space you wish to use |
200+
| *YOUR_SPACE_NAME* | The name of the space you wish to use |
201201
202202
1. Paste the returned `spacePaths` value into **Path** to create a UDF role assignment:
203203
204204
```plaintext
205-
POST yourManagementApiUrl/roleassignments
205+
POST YOUR_MANAGEMENT_API_URL/roleassignments
206206
{
207207
"RoleId": "YOUR_DESIRED_ROLE_IDENTIFIER",
208208
"ObjectId": "YOUR_USER_DEFINED_FUNCTION_ID",

articles/digital-twins/security-create-manage-role-assignments.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: alinast
66
ms.service: digital-twins
77
services: digital-twins
88
ms.topic: conceptual
9-
ms.date: 10/10/2018
9+
ms.date: 11/13/2018
1010
ms.author: lyrana
1111
---
1212

@@ -54,7 +54,7 @@ The supported `ObjectIdTypes`:
5454
## Create a role assignment
5555

5656
```plaintext
57-
HTTP POST yourManagementApiUrl/roleassignments
57+
HTTP POST YOUR_MANAGEMENT_API_URL/roleassignments
5858
```
5959

6060
| **Name** | **Required** | **Type** | **Description** |
@@ -105,22 +105,22 @@ All users who are part of a domain receive read access for spaces, sensors, and
105105
Use GET to get a role assignment.
106106

107107
```plaintext
108-
HTTP GET yourManagementApiUrl/roleassignments?path={path}
108+
HTTP GET YOUR_MANAGEMENT_API_URL/roleassignments?path=YOUR_PATH
109109
```
110110

111111
| **Name** | **In** | **Required** | **Type** | **Description** |
112112
| --- | --- | --- | --- | --- |
113-
| path | Path | True | String | The full path to the space |
113+
| YOUR_PATH | Path | True | String | The full path to the space |
114114

115115
Use DELETE to delete a role assignment.
116116

117117
```plaintext
118-
HTTP DELETE yourManagementApiUrl/roleassignments/{id}
118+
HTTP DELETE YOUR_MANAGEMENT_API_URL/roleassignments/YOUR_ROLE_ID
119119
```
120120

121121
| **Name** | **In** | **Required** | **Type** | **Description** |
122122
| --- | --- | --- | --- | --- |
123-
| id | Path | True | String | Role Assignment ID |
123+
| YOUR_ROLE_ID | Path | True | String | Role Assignment ID |
124124

125125
## Next steps
126126

includes/digital-twins-management-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
ms.custom: include file
1111
---
1212

13-
In the examples below, `yourManagementApiUrl` refers to the URI of the Digital Twins APIs:
13+
In the examples below, `YOUR_MANAGEMENT_API_URL` refers to the URI of the Digital Twins APIs:
1414

1515
```plaintext
16-
https://yourInstanceName.yourLocation.azuresmartspaces.net/management/api/v1.0/
16+
https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0/
1717
```
1818

1919
| Custom name | Replace with |
2020
| --- | --- |
21-
| yourInstanceName | The name of your Azure Digital Twins instance |
22-
| yourLocation | Which server region your instance is hosted on |
21+
| YOUR_INSTANCE_NAME | The name of your Azure Digital Twins instance |
22+
| YOUR_LOCATION | Which server region your instance is hosted on |

includes/digital-twins-swagger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
You can access your own generated Management API Swagger documentation at:
1818

1919
```plaintext
20-
https://yourInstanceName.yourLocation.azuresmartspaces.net/management/swagger
20+
https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
2121
```
2222

2323
| Custom name | Replace with |
2424
| --- | --- |
25-
| yourInstanceName | The name of your Azure Digital Twins instance |
26-
| yourLocation | Which server region your instance is hosted on |
25+
| YOUR_INSTANCE_NAME | The name of your Azure Digital Twins instance |
26+
| YOUR_LOCATION | Which server region your instance is hosted on |

0 commit comments

Comments
 (0)