Skip to content

Commit aba3255

Browse files
yang-hai-fengmikekistler
yang-hai-feng
and
mikekistler
authored
New 1.2-preview release for IoT Central API (#18383)
* New 1.2-preview release for IoT Central API, Add support for Device Group CRUD, New Job Types * update package version in readme.md * fix lint errors * add missing contract * Fix API Review Comments, Add Default Error Response, Revise the filter description in device group, define any value for capability job * fix description of organization parent field * fix code review comments * remove version enum, fix code review comments * Update specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-preview/iotcentral.json Co-authored-by: Mike Kistler <[email protected]> * add missing comma * fix the code review comments to add application/json-merge-patch only support for device group * fix comments * add description for non-collection definitions * add paging for /jobs/:id/devices * fix typo Co-authored-by: Mike Kistler <[email protected]>
1 parent c5c5e1d commit aba3255

File tree

89 files changed

+9638
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+9638
-2
lines changed

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-preview/examples/apitoken_create.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"title": "Get API tokens in your application",
3+
"description": "Get a list of API tokens in your application.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"tokenId": "testtoken",
8+
"api-version": "1.2-preview",
9+
"body": {
10+
"roles": [
11+
{
12+
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
13+
},
14+
{
15+
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
16+
"organization": "seattle"
17+
}
18+
]
19+
}
20+
},
21+
"responses": {
22+
"200": {
23+
"body": {
24+
"id": "testtoken",
25+
"roles": [
26+
{
27+
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
28+
},
29+
{
30+
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
31+
"organization": "seattle"
32+
}
33+
],
34+
"expiry": "2020-10-18T18:30:40.227Z",
35+
"token": "SharedAccessSignature sr=..."
36+
}
37+
}
38+
}
39+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-preview/examples/apitoken_delete.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"title": "Delete API token",
3+
"description": "Delete an API token using its name.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"tokenId": "testtoken",
8+
"api-version": "1.2-preview"
9+
},
10+
"responses": {
11+
"204": {}
12+
}
13+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-preview/examples/apitoken_get.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"title": "Get an API token in your application",
3+
"description": "Get an API token by Id in your application.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"tokenId": "testtoken",
8+
"api-version": "1.2-preview"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"id": "testtoken",
14+
"roles": [
15+
{
16+
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
17+
"organization": "seattle"
18+
}
19+
],
20+
"expiry": "2020-10-18T18:30:40.227Z"
21+
}
22+
}
23+
}
24+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-preview/examples/apitoken_list.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"title": "List API tokens in your application",
3+
"description": "Get a list of API tokens in your application.",
4+
"parameters": {
5+
"baseDomain": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"api-version": "1.2-preview"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"value": [
13+
{
14+
"id": "testtoken",
15+
"roles": [
16+
{
17+
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
18+
},
19+
{
20+
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
21+
"organization": "seattle"
22+
}
23+
],
24+
"expiry": "2020-10-18T18:30:40.227Z"
25+
}
26+
]
27+
}
28+
}
29+
}
30+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.2-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.2-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.2-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.2-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.2-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.2-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.2-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.2-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.2-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.2-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.2-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.2-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+
}

0 commit comments

Comments
 (0)