Skip to content

Commit 747766f

Browse files
itechedititechedit
authored
Merge pull request #57915 from KingdomOfEnds/digital-twins-tables
tables and params
2 parents a54cc89 + cad61c9 commit 747766f

9 files changed

+120
-103
lines changed

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

Lines changed: 11 additions & 7 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

@@ -32,21 +32,25 @@ In the following sections, you learn how to get the IoT Hub device connection st
3232

3333
## Get the IoT Hub device connection string from the Management API
3434

35+
[!INCLUDE [Digital Twins Management API](../../includes/digital-twins-management-api.md)]
36+
3537
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.
3638

3739
```plaintext
38-
https://yourManagementApiUrl/api/v1.0/devices/yourDeviceGuid?includes=ConnectionString
40+
YOUR_MANAGEMENT_API_URL/devices/YOUR_DEVICE_GUID?includes=ConnectionString
3941
```
4042

43+
| Parameter | Replace with |
44+
| --- | --- |
45+
| *YOUR_DEVICE_GUID* | The device ID |
46+
4147
```plaintext
42-
https://yourManagementApiUrl/api/v1.0/devices?hardwareIds=yourDeviceHardwareId&includes=ConnectionString
48+
YOUR_MANAGEMENT_API_URL/devices?hardwareIds=YOUR_DEVICE_HARDWARE_ID&includes=ConnectionString
4349
```
4450

45-
| Custom attribute name | Replace with |
51+
| Parameter value | Replace with |
4652
| --- | --- |
47-
| **yourManagementApiUrl** | The full URL path for your Management API |
48-
| **yourDeviceGuid** | The device ID |
49-
| **yourDeviceHardwareId** | The device hardware ID |
53+
| *YOUR_DEVICE_HARDWARE_ID* | The device hardware ID |
5054

5155
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.
5256

‎articles/digital-twins/concepts-objectmodel-spatialgraph.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

@@ -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

80-
| Custom attribute name | Replace with |
80+
| 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: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: deshner
66
ms.service: digital-twins
77
services: digital-twins
88
ms.topic: conceptual
9-
ms.date: 10/22/2018
9+
ms.date: 11/13/2018
1010
ms.author: stefanmsft
1111
---
1212

@@ -37,12 +37,12 @@ After sending telemetry, open up Azure Log Analytics to query for logs using the
3737

3838
```Kusto
3939
AzureDiagnostics
40-
| where CorrelationId = 'yourCorrelationIdentifier'
40+
| where CorrelationId = 'YOUR_CORRELATION_IDENTIFIER'
4141
```
4242

43-
| Custom Attribute Name | Replace With |
43+
| Query value | Replace with |
4444
| --- | --- |
45-
| *yourCorrelationIdentifier* | The Correlation ID that was specified on the event data |
45+
| YOUR_CORRELATION_IDENTIFIER | The Correlation ID that was specified on the event data |
4646

4747
If you log your user-defined function, those logs will appear in your Azure Log Analytics instance with the category `UserDefinedFunction`. To retrieve them, enter the following query condition in Azure Log Analytics:
4848

@@ -57,20 +57,21 @@ For more information about powerful query operations, see [getting started with
5757

5858
Both diagnosing and identifying common issues are important when troubleshooting your solution. Several Common issues encountered when developing user-defined functions are summarized below.
5959

60+
[!INCLUDE [Digital Twins Management API](../../includes/digital-twins-management-api.md)]
61+
6062
### Ensure a role assignment was created
6163

6264
Without a role assignment created within Management API, the user-defined function will not have access to perform any actions such as sending notifications, retrieving metadata, and setting computed values within the topology.
6365

6466
Check if a role assignment exists for your user-defined function through your Management API:
6567

6668
```plaintext
67-
GET https://yourManagementApiUrl/api/v1.0/roleassignments?path=/&traverse=Down&objectId=yourUserDefinedFunctionId
69+
GET YOUR_MANAGEMENT_API_URL/roleassignments?path=/&traverse=Down&objectId=YOUR_USER_DEFINED_FUNCTION_ID
6870
```
6971

70-
| Custom Attribute Name | Replace With |
72+
| Parameter | Replace with |
7173
| --- | --- |
72-
| *yourManagementApiUrl* | The full URL path for your Management API |
73-
| *yourUserDefinedFunctionId* | The ID of the user-defined function to retrieve role assignments for|
74+
| *YOUR_USER_DEFINED_FUNCTION_ID* | The ID of the user-defined function to retrieve role assignments for|
7475

7576
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).
7677

@@ -79,14 +80,13 @@ If no role assignment is retrieved, follow this article on [How to create a role
7980
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.
8081

8182
```plaintext
82-
GET https://yourManagementApiUrl/api/v1.0/matchers/yourMatcherIdentifier/evaluate/yourSensorIdentifier?enableLogging=true
83+
GET YOUR_MANAGEMENT_API_URL/matchers/YOUR_MATCHER_IDENTIFIER/evaluate/YOUR_SENSOR_IDENTIFIER?enableLogging=true
8384
```
8485

85-
| Custom Attribute Name | Replace With |
86+
| Parameter | Replace with |
8687
| --- | --- |
87-
| *yourManagementApiUrl* | The full URL path for your Management API |
88-
| *yourMatcherIdentifier* | The ID of the matcher you wish to evaluate |
89-
| *yourSensorIdentifier* | The ID of the sensor you wish to evaluate |
88+
| *YOUR_MATCHER_IDENTIFIER* | The ID of the matcher you wish to evaluate |
89+
| *YOUR_SENSOR_IDENTIFIER* | The ID of the sensor you wish to evaluate |
9090

9191
Response:
9292

@@ -104,13 +104,12 @@ Response:
104104
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:
105105

106106
```plaintext
107-
GET https://yourManagementApiUrl/api/v1.0/sensors/yourSensorIdentifier/matchers?includes=UserDefinedFunctions
107+
GET YOUR_MANAGEMENT_API_URL/sensors/YOUR_SENSOR_IDENTIFIER/matchers?includes=UserDefinedFunctions
108108
```
109109

110-
| Custom Attribute Name | Replace With |
110+
| Parameter | Replace with |
111111
| --- | --- |
112-
| *yourManagementApiUrl* | The full URL path for your Management API |
113-
| *yourSensorIdentifier* | The ID of the sensor that will be sending telemetry |
112+
| *YOUR_SENSOR_IDENTIFIER* | The ID of the sensor that will be sending telemetry |
114113

115114
Response:
116115

‎articles/digital-twins/how-to-egress-endpoints.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ The event formats for each of the event types are described in the following sec
7171
"eventTime": "2018-04-17T17:41:54.9400177Z",
7272
"dataVersion": "1",
7373
"metadataVersion": "1",
74-
"topic": "/subscriptions/yourTopicName"
74+
"topic": "/subscriptions/YOUR_TOPIC_NAME"
7575
}
7676
```
7777

78-
| Custom attribute name | Replace with |
78+
| Value | Replace with |
7979
| --- | --- |
80-
| yourTopicName | The name of your customized topic |
80+
| YOUR_TOPIC_NAME | The name of your customized topic |
8181

8282
### UdfCustom
8383

@@ -102,13 +102,13 @@ The event formats for each of the event types are described in the following sec
102102
"eventTime": "2018-10-02T06:50:15.198Z",
103103
"dataVersion": "1.0",
104104
"metadataVersion": "1",
105-
"topic": "/subscriptions/yourTopicName"
105+
"topic": "/subscriptions/YOUR_TOPIC_NAME"
106106
}
107107
```
108108

109-
| Custom attribute name | Replace with |
109+
| Value | Replace with |
110110
| --- | --- |
111-
| yourTopicName | The name of your customized topic |
111+
| YOUR_TOPIC_NAME | The name of your customized topic |
112112

113113
### SensorChange
114114

@@ -137,13 +137,13 @@ The event formats for each of the event types are described in the following sec
137137
"eventTime": "2018-04-17T17:46:18.5452993Z",
138138
"dataVersion": "1",
139139
"metadataVersion": "1",
140-
"topic": "/subscriptions/yourTopicName"
140+
"topic": "/subscriptions/YOUR_TOPIC_NAME"
141141
}
142142
```
143143

144-
| Custom attribute name | Replace with |
144+
| Value | Replace with |
145145
| --- | --- |
146-
| yourTopicName | The name of your customized topic |
146+
| YOUR_TOPIC_NAME | The name of your customized topic |
147147

148148
### SpaceChange
149149

@@ -172,13 +172,13 @@ The event formats for each of the event types are described in the following sec
172172
"eventTime": "2018-10-02T06:50:20.128Z",
173173
"dataVersion": "1.0",
174174
"metadataVersion": "1",
175-
"topic": "/subscriptions/yourTopicName"
175+
"topic": "/subscriptions/YOUR_TOPIC_NAME"
176176
}
177177
```
178178

179-
| Custom attribute name | Replace with |
179+
| Value | Replace with |
180180
| --- | --- |
181-
| yourTopicName | The name of your customized topic |
181+
| YOUR_TOPIC_NAME | The name of your customized topic |
182182

183183
### DeviceMessage
184184

@@ -206,18 +206,18 @@ POST https://endpoints-demo.azuresmartspaces.net/management/api/v1.0/endpoints
206206
"SpaceChange",
207207
"TopologyOperation"
208208
],
209-
"connectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourPrimaryKey",
210-
"secondaryConnectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourSecondaryKey",
211-
"path": "yourTopicName"
209+
"connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY",
210+
"secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY",
211+
"path": "YOUR_TOPIC_NAME"
212212
}
213213
```
214214

215-
| Custom attribute name | Replace with |
215+
| Value | Replace with |
216216
| --- | --- |
217-
| yourNamespace | The namespace of your endpoint |
218-
| yourPrimaryKey | The primary connection string used to authenticate |
219-
| yourSecondaryKey | The secondary connection string used to authenticate |
220-
| yourTopicName | The name of your customized topic |
217+
| YOUR_NAMESPACE | The namespace of your endpoint |
218+
| YOUR_PRIMARY_KEY | The primary connection string used to authenticate |
219+
| YOUR_SECONDARY_KEY | The secondary connection string used to authenticate |
220+
| YOUR_TOPIC_NAME | The name of your customized topic |
221221

222222
- Route to Event Grid event types **SensorChange**, **SpaceChange**, and **TopologyOperation**:
223223

@@ -229,17 +229,17 @@ POST https://endpoints-demo.azuresmartspaces.net/management/api/v1.0/endpoints
229229
"SpaceChange",
230230
"TopologyOperation"
231231
],
232-
"connectionString": "yourPrimaryKey",
233-
"secondaryConnectionString": "yourSecondaryKey",
234-
"path": "yourTopicName.westus-1.eventgrid.azure.net"
232+
"connectionString": "YOUR_PRIMARY_KEY",
233+
"secondaryConnectionString": "YOUR_SECONDARY_KEY",
234+
"path": "YOUR_TOPIC_NAME.westus-1.eventgrid.azure.net"
235235
}
236236
```
237237

238-
| Custom attribute name | Replace with |
238+
| Value | Replace with |
239239
| --- | --- |
240-
| yourPrimaryKey | The primary connection string used to authenticate|
241-
| yourSecondaryKey | The secondary connection string used to authenticate |
242-
| yourTopicName | The name of your customized topic |
240+
| YOUR_PRIMARY_KEY | The primary connection string used to authenticate|
241+
| YOUR_SECONDARY_KEY | The secondary connection string used to authenticate |
242+
| YOUR_TOPIC_NAME | The name of your customized topic |
243243

244244
- Route to Event Hubs event types **SensorChange**, **SpaceChange**, and **TopologyOperation**:
245245

@@ -251,18 +251,18 @@ POST https://endpoints-demo.azuresmartspaces.net/management/api/v1.0/endpoints
251251
"SpaceChange",
252252
"TopologyOperation"
253253
],
254-
"connectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourPrimaryKey",
255-
"secondaryConnectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourSecondaryKey",
256-
"path": "yourEventHubName"
254+
"connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY",
255+
"secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY",
256+
"path": "YOUR_EVENT_HUB_NAME"
257257
}
258258
```
259259

260-
| Custom attribute name | Replace with |
260+
| Value | Replace with |
261261
| --- | --- |
262-
| yourNamespace | The namespace of your endpoint |
263-
| yourPrimaryKey | The primary connection string used to authenticate |
264-
| yourSecondaryKey | The secondary connection string used to authenticate |
265-
| yourEventHubName | The name of your event hub |
262+
| YOUR_NAMESPACE | The namespace of your endpoint |
263+
| YOUR_PRIMARY_KEY | The primary connection string used to authenticate |
264+
| YOUR_SECONDARY_KEY | The secondary connection string used to authenticate |
265+
| YOUR_EVENT_HUB_NAME | The name of your event hub |
266266

267267
- Route to Event Hubs event type **DeviceMessage**. The inclusion of `EntityPath` in the **connectionString** is mandatory:
268268

@@ -272,18 +272,18 @@ POST https://endpoints-demo.azuresmartspaces.net/management/api/v1.0/endpoints
272272
"eventTypes": [
273273
"DeviceMessage"
274274
],
275-
"connectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourPrimaryKey;EntityPath=yourEventHubName",
276-
"secondaryConnectionString": "Endpoint=sb://yourNamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yourSecondaryKey;EntityPath=yourEventHubName",
277-
"path": "yourEventHubName"
275+
"connectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_PRIMARY_KEY;EntityPath=YOUR_EVENT_HUB_NAME",
276+
"secondaryConnectionString": "Endpoint=sb://YOUR_NAMESPACE.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=YOUR_SECONDARY_KEY;EntityPath=YOUR_EVENT_HUB_NAME",
277+
"path": "YOUR_EVENT_HUB_NAME"
278278
}
279279
```
280280

281-
| Custom attribute name | Replace with |
281+
| Value | Replace with |
282282
| --- | --- |
283-
| yourNamespace | The namespace of your endpoint |
284-
| yourPrimaryKey | The primary connection string used to authenticate |
285-
| yourSecondaryKey | The secondary connection string used to authenticate |
286-
| yourEventHubName | The name of your event hub |
283+
| YOUR_NAMESPACE | The namespace of your endpoint |
284+
| YOUR_PRIMARY_KEY | The primary connection string used to authenticate |
285+
| YOUR_SECONDARY_KEY | The secondary connection string used to authenticate |
286+
| YOUR_EVENT_HUB_NAME | The name of your event hub |
287287

288288
> [!NOTE]
289289
> Upon the creation of a new endpoint, it might take up to 5 to 10 minutes to start receiving events at the endpoint.

0 commit comments

Comments
 (0)