Skip to content

Commit 4045556

Browse files
Merge pull request #286015 from dominicbetts/central-security-update-rest
IoT Central: Data export security update
2 parents 4ac3ffa + 03ad922 commit 4045556

File tree

1 file changed

+35
-24
lines changed

1 file changed

+35
-24
lines changed

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

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,21 @@ The following example shows a request body that creates a blob storage destinati
4141

4242
```json
4343
{
44-
"displayName": "Blob Storage Destination",
45-
"type": "blobstorage@v1",
46-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=********;EndpointSuffix=core.windows.net",
47-
"containerName": "central-data"
44+
"displayName": "Blob Storage",
45+
"type": "blobstorage@v1",
46+
"authorization": {
47+
"type": "systemAssignedManagedIdentity",
48+
"endpointUri": "https://yourapplication.blob.core.windows.net/",
49+
"containerName": "central-data"
50+
}
4851
}
4952
```
5053

5154
The request body has some required fields:
5255

5356
* `displayName`: Display name of the destination.
5457
* `type`: Type of destination object. One of: `blobstorage@v1`, `dataexplorer@v1`, `eventhubs@v1`, `servicebusqueue@v1`, `servicebustopic@v1`, `webhook@v1`.
55-
* `connectionString`: The connection string for accessing the destination resource.
56-
* `containerName`: For a blob storage destination, the name of the container where data should be written.
58+
* `authorization`: The authorization details for the destination. The supported authorization types are `systemAssignedManagedIdentity` and `connectionString`.
5759

5860
The response to this request looks like the following example:
5961

@@ -63,8 +65,8 @@ The response to this request looks like the following example:
6365
"displayName": "Blob Storage",
6466
"type": "blobstorage@v1",
6567
"authorization": {
66-
"type": "connectionString",
67-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=*****;EndpointSuffix=core.windows.net",
68+
"type": "systemAssignedManagedIdentity",
69+
"endpointUri": "https://yourapplication.blob.core.windows.net/",
6870
"containerName": "central-data"
6971
},
7072
"status": "waiting"
@@ -87,8 +89,8 @@ The response to this request looks like the following example:
8789
"displayName": "Blob Storage",
8890
"type": "blobstorage@v1",
8991
"authorization": {
90-
"type": "connectionString",
91-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=*****;EndpointSuffix=core.windows.net",
92+
"type": "systemAssignedManagedIdentity",
93+
"endpointUri": "https://yourapplication.blob.core.windows.net/",
9294
"containerName": "central-data"
9395
},
9496
"status": "waiting"
@@ -113,9 +115,9 @@ The response to this request looks like the following example:
113115
"displayName": "Blob Storage Destination",
114116
"type": "blobstorage@v1",
115117
"authorization": {
116-
"type": "connectionString",
117-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=********;EndpointSuffix=core.windows.net",
118-
"containerName": "central-data"
118+
"type": "systemAssignedManagedIdentity",
119+
"endpointUri": "https://yourapplication.blob.core.windows.net/",
120+
"containerName": "central-data"
119121
},
120122
"status": "waiting"
121123
},
@@ -137,11 +139,11 @@ The response to this request looks like the following example:
137139
PATCH https://{your app subdomain}/api/dataExport/destinations/{destinationId}?api-version=2022-10-31-preview
138140
```
139141

140-
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 `connectionString` of a destination:
142+
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 `containerName` of a destination:
141143

142144
```json
143145
{
144-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=********;EndpointSuffix=core.windows.net"
146+
"containerName": "central-data-analysis"
145147
}
146148
```
147149

@@ -153,9 +155,9 @@ The response to this request looks like the following example:
153155
"displayName": "Blob Storage",
154156
"type": "blobstorage@v1",
155157
"authorization": {
156-
"type": "connectionString",
157-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=*****;EndpointSuffix=core.windows.net",
158-
"containerName": "central-data"
158+
"type": "systemAssignedManagedIdentity",
159+
"endpointUri": "https://yourapplication.blob.core.windows.net/",
160+
"containerName": "central-data-analysis"
159161
},
160162
"status": "waiting"
161163
}
@@ -332,12 +334,21 @@ The response to this request looks like the following example:
332334

333335
```json
334336
{
335-
"id": "8dbcdb53-c6a7-498a-a976-a824b694c150",
336-
"displayName": "Blob Storage Destination",
337-
"type": "blobstorage@v1",
338-
"connectionString": "DefaultEndpointsProtocol=https;AccountName=yourAccountName;AccountKey=********;EndpointSuffix=core.windows.net",
339-
"containerName": "central-data",
340-
"status": "waiting"
337+
"id": "802894c4-33bc-4f1e-ad64-e886f315cece",
338+
"displayName": "Enriched Export",
339+
"enabled": true,
340+
"source": "telemetry",
341+
"enrichments": {
342+
"Custom data": {
343+
"value": "My value"
344+
}
345+
},
346+
"destinations": [
347+
{
348+
"id": "9742a8d9-c3ca-4d8d-8bc7-357bdc7f39d9"
349+
}
350+
],
351+
"status": "healthy"
341352
}
342353
```
343354

0 commit comments

Comments
 (0)