Skip to content

Commit 3b16e57

Browse files
viv-liuviv-liu
authored
IoTC 2011 Adding jobs, DTDLv2 templates, groups (#11622)
* Adding jobs, DTDLv2 templates, groups * Spelling mistakes fix * Trying to suppress email lint * Small update to fix linter * Added additional suppression for long running ops * Again * Updated again * Removing the other suppressors * New suppression without quotes * back to just email suppression
1 parent 150da63 commit 3b16e57

File tree

11 files changed

+817
-478
lines changed

11 files changed

+817
-478
lines changed

‎custom-words.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@ deserializing
496496
destinationshares
497497
deterministically
498498
devicecredentials
499+
devicegroups
499500
deviceprovisioningservices
500501
devicetemplates
501502
devspaces

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicegroups_list.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"title": "DeviceGroup List",
3+
"description": "List all device groups in your application.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"id": "475cad48-b7ff-4a09-b51e-1a9021385453",
14+
"displayName": "DeviceGroupEntry1"
15+
},
16+
{
17+
"id": "c2d5ae1d-2cb7-4f58-bf44-5e816aba0a0e",
18+
"displayName": "DeviceGroupEntry2"
19+
},
20+
{
21+
"id": "241ad72b-32aa-4216-aabe-91b240582c8d",
22+
"displayName": "DeviceGroupEntry3"
23+
},
24+
{
25+
"id": "241ad72b-32aa-4216-aabe-91b240582c8d",
26+
"displayName": "DeviceGroupEntry4"
27+
}
28+
]
29+
}
30+
}
31+
}
32+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_create.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"title": "Execute a new job",
3+
"description": "Create and execute a new job via its job definition.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId",
8+
"body": {
9+
"displayName": "My Job",
10+
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
11+
"data": [
12+
{
13+
"type": "PropertyJobData",
14+
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
15+
"path": "componentName.propertyName",
16+
"value": "updated value"
17+
}
18+
]
19+
}
20+
},
21+
"responses": {
22+
"200": {
23+
"body": {
24+
"id": "myJobId",
25+
"displayName": "My Job",
26+
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
27+
"data": [
28+
{
29+
"type": "PropertyJobData",
30+
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
31+
"path": "componentName.propertyName",
32+
"value": "updated value"
33+
}
34+
],
35+
"status": "running"
36+
}
37+
}
38+
}
39+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_devices.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"title": "Get device statuses",
3+
"description": "Get the list of individual device statuses by job ID.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"value": [
13+
{
14+
"id": "ylleedih6k",
15+
"status": "completed"
16+
},
17+
{
18+
"id": "t81v3k204k",
19+
"status": "completed"
20+
},
21+
{
22+
"id": "iotc-1",
23+
"status": "completed"
24+
},
25+
{
26+
"id": "iotc",
27+
"status": "completed"
28+
},
29+
{
30+
"id": "1c5cs18m7k1",
31+
"status": "completed"
32+
}
33+
]
34+
}
35+
}
36+
}
37+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_get.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"title": "Get a job by Id",
3+
"description": "Get a job by Id",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "myJobId",
13+
"displayName": "My Job",
14+
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
15+
"data": [
16+
{
17+
"type": "PropertyJobData",
18+
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
19+
"path": "componentName.propertyName",
20+
"value": "updated value"
21+
}
22+
],
23+
"status": "running"
24+
}
25+
}
26+
}
27+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_list.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"title": "List jobs",
3+
"description": "List all jobs in your application.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"id": "myJobId",
14+
"displayName": "My Job",
15+
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
16+
"data": [
17+
{
18+
"type": "PropertyJobData",
19+
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
20+
"path": "componentName.propertyName",
21+
"value": "updated value"
22+
}
23+
],
24+
"status": "running"
25+
}
26+
]
27+
}
28+
}
29+
}
30+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_rerun.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"title": "Rerun a job on failed devices",
3+
"description": "Execute a rerun of an existing job on all failed devices.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId",
8+
"rerun_id": "myJobRerunId"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"id": "myJobRerunId",
14+
"displayName": "My Job",
15+
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
16+
"data": [
17+
{
18+
"type": "PropertyJobData",
19+
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
20+
"path": "componentName.propertyName",
21+
"value": "updated value"
22+
}
23+
],
24+
"status": "running"
25+
}
26+
}
27+
}
28+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_resume.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"title": "Resume a stopped job",
3+
"description": "Resume execution of an existing stoppped job.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId"
8+
},
9+
"responses": {
10+
"204": {}
11+
}
12+
}

‎specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/jobs_stop.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"title": "Stop a running job",
3+
"description": "Stop execution of a job that is currently running.",
4+
"parameters": {
5+
"centralDnsSuffixInPath": "azureiotcentral.com",
6+
"subdomain": "appsubdomain",
7+
"job_id": "myJobId"
8+
},
9+
"responses": {
10+
"204": {}
11+
}
12+
}

0 commit comments

Comments
 (0)