Update Jobs API with new parameter support (Azure#14238)

* Add new 1.0.0 version for IoT Central API * fix swagger style * fix wrong json file name * remove unused examples * revert back email format * remove non-used examples * update with latest examples * update preview from 2019-10-28-preview to 2021-04-30-preview * remove extra --- * update version from 1.0.0 to 1.0 * rollback collections for common entities * update _id to Id, update _name to Name from operation, add sdk generation * fix go sdk file * remove go sdk * updatedevicve_templateId to deviceTemplateId * Add query parameter based versioning, remove resource schema * fix example docs reference * fix typo in comments * renaming execute to run for command operations * add api-version to samples files, fix devices_update missining issue * add devices_update.json for 1.0 * fix rerun_id, add missing parameters to examples for preview, fix command comments from execute to run * fix annoymous type issues * add job parameter, update python with different version * add more description for 1.0 device template id and fix sample @types in device template
AzureSDKAutomation · May 5, 2021 · 8169805 · 8169805
1 parent 49f426d
commit 8169805
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 9 deletions.
diff --git a/...tral/data-plane/Microsoft.IoTCentral/preview/2021-04-30-preview/examples/jobs_create.json b/...tral/data-plane/Microsoft.IoTCentral/preview/2021-04-30-preview/examples/jobs_create.json
@@ -10,6 +10,15 @@
     "body": {
       "displayName": "My Job",
       "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
+      "batch": {
+        "type": "percentage",
+        "value": 10
+      },
+      "cancellationThreshold": {
+        "type": "number",
+        "value": 2,
+        "batch": false
+      },
       "data": [
         {
           "type": "PropertyJobData",
@@ -26,6 +35,15 @@
         "id": "myJobId",
         "displayName": "My Job",
         "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
+        "batch": {
+          "type": "percentage",
+          "value": 10
+        },
+        "cancellationThreshold": {
+          "type": "number",
+          "value": 2,
+          "batch": false
+        },
         "data": [
           {
             "type": "PropertyJobData",

diff --git a/...ion/iotcentral/data-plane/Microsoft.IoTCentral/preview/2021-04-30-preview/iotcentral.json b/...ion/iotcentral/data-plane/Microsoft.IoTCentral/preview/2021-04-30-preview/iotcentral.json
@@ -522,6 +522,14 @@
           "description": "The ID of the device group on which to execute the job.",
           "type": "string"
         },
+        "batch": {
+          "description": "The batching configuration for the job.",
+          "$ref": "#/definitions/JobBatch"
+        },
+        "cancellationThreshold": {
+          "description": "The cancellation threshold for the job.",
+          "$ref": "#/definitions/JobCancellationThreshold"
+        },
         "data": {
           "description": "The capabilities being updated by the job and the values with which they are being updated.",
           "type": "array",
@@ -541,6 +549,52 @@
         "data"
       ]
     },
+    "JobBatch": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "description": "Whether batching is done on a specified number of devices or a percentage of the total devices.",
+          "type": "string",
+          "enum": [
+            "number",
+            "percentage"
+          ]
+        },
+        "value": {
+          "description": "The number or percentage of devices on which batching is done.",
+          "type": "number"
+        }
+      },
+      "required": [
+        "type",
+        "value"
+      ]
+    },
+    "JobCancellationThreshold": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "description": "Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices.",
+          "type": "string",
+          "enum": [
+            "number",
+            "percentage"
+          ]
+        },
+        "value": {
+          "description": "The number or percentage of devices on which the cancellation threshold is applied.",
+          "type": "number"
+        },
+        "batch": {
+          "description": "Whether the cancellation threshold applies per-batch or to the overall job.",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "type",
+        "value"
+      ]
+    },
     "JobCollection": {
       "type": "object",
       "properties": {

diff --git a/...otcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_create.json b/...otcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_create.json
@@ -338,7 +338,7 @@
             {
               "@type": [
                 "Property",
-                "CloudProperty"
+                "Cloud"
               ],
               "displayName": "Test Cloud Property",
               "name": "testCloudProperty",

diff --git a/...n/iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_get.json b/...n/iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_get.json
@@ -170,7 +170,7 @@
             {
               "@type": [
                 "Property",
-                "CloudProperty"
+                "Cloud"
               ],
               "displayName": "Test Cloud Property",
               "name": "testCloudProperty",

diff --git a/.../iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_list.json b/.../iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/examples/devicetemplates_list.json
@@ -171,7 +171,7 @@
                 {
                   "@type": [
                     "Property",
-                    "CloudProperty"
+                    "Cloud"
                   ],
                   "displayName": "Test Cloud Property",
                   "name": "testCloudProperty",

diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/stable/1.0/iotcentral.json
@@ -2397,7 +2397,7 @@
     "DeviceTemplateId": {
       "in": "path",
       "name": "deviceTemplateId",
-      "description": "Unique ID of the device template.",
+      "description": "Digital Twin Model Identifier of the device template, [More Details](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier)",
       "x-ms-parameter-location": "method",
       "type": "string",
       "required": true

diff --git a/specification/iotcentral/data-plane/readme.python.md b/specification/iotcentral/data-plane/readme.python.md
@@ -8,14 +8,28 @@ python:
   azure-arm: true
   license-header: MICROSOFT_MIT_NO_VERSION
   payload-flattening-threshold: 2
-  namespace: Microsoft.Azure.IoTCentral
+  no-namespace-folders: true
+  clear-output-folder: true
+```
+
+### Tag: package-2021-04-30-preview
+These settings apply only when `--tag=package-2021-04-30-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2021-04-30-preview'
+python:
+  namespace: Microsoft.Azure.IotCentral.Preview
   package-name: iotcentral
   package-version: 2021-04-30-preview
-  clear-output-folder: true
+  output-folder: $(python-sdks-folder)/iotcentral/preview
 ```
 
-```yaml $(python)
+### Tag: package-1.0
+These settings apply only when `--tag=package-1.0` is specified on the command line.
+
+```yaml $(tag) == 'package-1.0'
 python:
-  no-namespace-folders: true
-  output-folder: $(python-sdks-folder)/iotcentral
+  namespace: Microsoft.Azure.IotCentral.Stable
+  package-name: iotcentral
+  package-version: 1.0
+  output-folder: $(python-sdks-folder)/iotcentral/1.0
 ```