Skip to content

Commit a4a7566

Browse files
yang-hai-fengyang-hai-feng
authored
Merge IoT Central Public API Oct Release to main branch (#16606)
* Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo
1 parent a159bb4 commit a4a7566

30 files changed

+3078
-76
lines changed

‎custom-words.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2414,6 +2414,11 @@ pmem
24142414
rawphysical
24152415
rawvirtual
24162416
sesparse
2417+
blobstorage
2418+
dataexplorer
2419+
servicebusqueue
2420+
servicebustopic
2421+
dataexports
24172422
stackset
24182423
CSPM
24192424
autoprovisioning

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_adx.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"title": "Create data export ADX destination",
3+
"description": "Create an ADX destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Azure Data Explorer",
11+
"type": "dataexplorer@v1",
12+
"clusterUrl": "https://[clusterName].westus2.kusto.windows.net",
13+
"database": "database1",
14+
"table": "table1",
15+
"authorization": {
16+
"type": "servicePrincipal",
17+
"clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
18+
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
19+
"clientSecret": "[Secret]"
20+
}
21+
}
22+
},
23+
"responses": {
24+
"200": {
25+
"body": {
26+
"id": "destination1",
27+
"displayName": "Azure Data Explorer",
28+
"type": "dataexplorer@v1",
29+
"clusterUrl": "https://[clusterName].westus2.kusto.windows.net",
30+
"database": "database1",
31+
"table": "table1",
32+
"authorization": {
33+
"type": "servicePrincipal",
34+
"clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
35+
"tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
36+
"clientSecret": "*****"
37+
},
38+
"status": "waiting"
39+
}
40+
}
41+
}
42+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_blob.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"title": "Create data export Blob Storage destination",
3+
"description": "Create a Blob Storage destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Blob Storage",
11+
"type": "blobstorage@v1",
12+
"authorization": {
13+
"type": "connectionString",
14+
"connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
15+
"containerName": "test"
16+
}
17+
}
18+
},
19+
"responses": {
20+
"200": {
21+
"body": {
22+
"id": "destination1",
23+
"displayName": "Blob Storage",
24+
"type": "blobstorage@v1",
25+
"authorization": {
26+
"type": "connectionString",
27+
"connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=*****;EndpointSuffix=core.windows.net",
28+
"containerName": "test"
29+
},
30+
"status": "waiting"
31+
}
32+
}
33+
}
34+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_eventhub.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"title": "Create data export Event Hub destination",
3+
"description": "Create an Event hub destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Event Hub",
11+
"type": "eventhubs@v1",
12+
"authorization": {
13+
"type": "connectionString",
14+
"connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[Key];EntityPath=entityPath1"
15+
}
16+
}
17+
},
18+
"responses": {
19+
"200": {
20+
"body": {
21+
"id": "destination1",
22+
"displayName": "Event Hub",
23+
"type": "eventhubs@v1",
24+
"authorization": {
25+
"type": "connectionString",
26+
"connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
27+
},
28+
"status": "waiting"
29+
}
30+
}
31+
}
32+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_queue.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"title": "Create data export Service Bus Queue destination",
3+
"description": "Create an Service Bus Queue destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Service Bus Queue",
11+
"type": "servicebusqueue@v1",
12+
"authorization": {
13+
"type": "connectionString",
14+
"connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
15+
}
16+
}
17+
},
18+
"responses": {
19+
"200": {
20+
"body": {
21+
"id": "destination1",
22+
"displayName": "Service Bus Queue",
23+
"type": "servicebusqueue@v1",
24+
"authorization": {
25+
"type": "connectionString",
26+
"connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]"
27+
},
28+
"status": "waiting"
29+
}
30+
}
31+
}
32+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_topic.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"title": "Create data export Event Hub destination",
3+
"description": "Create an Event hub destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Service Bus Topic",
11+
"type": "servicebustopic@v1",
12+
"authorization": {
13+
"type": "connectionString",
14+
"connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
15+
}
16+
}
17+
},
18+
"responses": {
19+
"200": {
20+
"body": {
21+
"id": "destination1",
22+
"displayName": "Service Bus Topic",
23+
"type": "servicebustopic@v1",
24+
"authorization": {
25+
"type": "connectionString",
26+
"connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]"
27+
},
28+
"status": "waiting"
29+
}
30+
}
31+
}
32+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_webhook.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"title": "Create data export Webhook destination",
3+
"description": "Create a Webhook destination with an Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview",
9+
"body": {
10+
"displayName": "Webhook No Auth",
11+
"type": "webhook@v1",
12+
"url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
13+
"headerCustomizations": {
14+
"x-custom-region": {
15+
"value": "westcentralus",
16+
"secret": false
17+
}
18+
}
19+
}
20+
},
21+
"responses": {
22+
"200": {
23+
"body": {
24+
"id": "destination1",
25+
"displayName": "Webhook No Auth",
26+
"type": "webhook@v1",
27+
"url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
28+
"headerCustomizations": {
29+
"x-custom-region": {
30+
"value": "westcentralus",
31+
"secret": false
32+
}
33+
},
34+
"status": "waiting"
35+
}
36+
}
37+
}
38+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_delete.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"title": "Delete data export destination",
3+
"description": "Delete a data export destination with Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview"
9+
},
10+
"responses": {
11+
"204": {}
12+
}
13+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_exports_list.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"title": "List all data exports connected to the given destination",
3+
"description": "Get a list of data exports connected to the given destination, returned exports include everything except the destination.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"api-version": "1.1-preview",
8+
"destinationId": "destination1"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"value": [
14+
{
15+
"id": "newTest",
16+
"displayName": "Test Export 1",
17+
"enabled": true,
18+
"source": "telemetry",
19+
"filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"",
20+
"enrichments": {
21+
"abc": {
22+
"path": "$templateDisplayName"
23+
}
24+
},
25+
"destinations": [],
26+
"status": "healthy"
27+
}
28+
]
29+
}
30+
}
31+
}
32+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_get.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"title": "Get data export destination",
3+
"description": "Get a data export destination with Id.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"destinationId": "destination1",
8+
"api-version": "1.1-preview"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"id": "1021f12a-6969-4eff-8518-57cac5f128ab",
14+
"displayName": "Webhook No Auth",
15+
"type": "webhook@v1",
16+
"url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
17+
"headerCustomizations": {
18+
"x-custom-region": {
19+
"value": "westcentralus",
20+
"secret": false
21+
}
22+
},
23+
"status": "error",
24+
"errors": [
25+
{
26+
"code": "InvalidResponse",
27+
"message": "The webhook returned a 4xx status code."
28+
}
29+
]
30+
}
31+
}
32+
}
33+
}

0 commit comments

Comments
 (0)