IoT Central Public API 1.1-preview Oct Release

custom-words.txt

@@ -2414,6 +2414,11 @@ pmem
 rawphysical
 rawvirtual
 sesparse
+blobstorage
+dataexplorer
+servicebusqueue
+servicebustopic
+dataexports
 stackset
 CSPM
 autoprovisioning

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

@@ -0,0 +1,42 @@
+{
+  "title": "Create data export ADX destination",
+  "description": "Create an ADX destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Azure Data Explorer",
+      "type": "dataexplorer@v1",
+      "clusterUrl": "https://[clusterName].westus2.kusto.windows.net",
+      "database": "database1",
+      "table": "table1",
+      "authorization": {
+        "type": "servicePrincipal",
+        "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
+        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+        "clientSecret": "[Secret]"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Azure Data Explorer",
+        "type": "dataexplorer@v1",
+        "clusterUrl": "https://[clusterName].westus2.kusto.windows.net",
+        "database": "database1",
+        "table": "table1",
+        "authorization": {
+          "type": "servicePrincipal",
+          "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
+          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+          "clientSecret": "*****"
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,34 @@
+{
+  "title": "Create data export Blob Storage destination",
+  "description": "Create a Blob Storage destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Blob Storage",
+      "type": "blobstorage@v1",
+      "authorization": {
+        "type": "connectionString",
+        "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
+        "containerName": "test"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Blob Storage",
+        "type": "blobstorage@v1",
+        "authorization": {
+          "type": "connectionString",
+          "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=*****;EndpointSuffix=core.windows.net",
+          "containerName": "test"
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,32 @@
+{
+  "title": "Create data export Event Hub destination",
+  "description": "Create an Event hub destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Event Hub",
+      "type": "eventhubs@v1",
+      "authorization": {
+        "type": "connectionString",
+        "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[Key];EntityPath=entityPath1"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Event Hub",
+        "type": "eventhubs@v1",
+        "authorization": {
+          "type": "connectionString",
+          "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,32 @@
+{
+  "title": "Create data export Service Bus Queue destination",
+  "description": "Create an Service Bus Queue destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Service Bus Queue",
+      "type": "servicebusqueue@v1",
+      "authorization": {
+        "type": "connectionString",
+        "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Service Bus Queue",
+        "type": "servicebusqueue@v1",
+        "authorization": {
+          "type": "connectionString",
+          "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]"
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,32 @@
+{
+  "title": "Create data export Event Hub destination",
+  "description": "Create an Event hub destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Service Bus Topic",
+      "type": "servicebustopic@v1",
+      "authorization": {
+        "type": "connectionString",
+        "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Service Bus Topic",
+        "type": "servicebustopic@v1",
+        "authorization": {
+          "type": "connectionString",
+          "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]"
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+{
+  "title": "Create data export Webhook destination",
+  "description": "Create a Webhook destination with an Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview",
+    "body": {
+      "displayName": "Webhook No Auth",
+      "type": "webhook@v1",
+      "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
+      "headerCustomizations": {
+        "x-custom-region": {
+          "value": "westcentralus",
+          "secret": false
+        }
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "destination1",
+        "displayName": "Webhook No Auth",
+        "type": "webhook@v1",
+        "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
+        "headerCustomizations": {
+          "x-custom-region": {
+            "value": "westcentralus",
+            "secret": false
+          }
+        },
+        "status": "waiting"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,13 @@
+{
+  "title": "Delete data export destination",
+  "description": "Delete a data export destination with Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview"
+  },
+  "responses": {
+    "204": {}
+  }
+}

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

@@ -0,0 +1,32 @@
+{
+  "title": "List all data exports connected to the given destination",
+  "description": "Get a list of data exports connected to the given destination, returned exports include everything except the destination.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "api-version": "1.1-preview",
+    "destinationId": "destination1"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "newTest",
+            "displayName": "Test Export 1",
+            "enabled": true,
+            "source": "telemetry",
+            "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"",
+            "enrichments": {
+              "abc": {
+                "path": "$templateDisplayName"
+              }
+            },
+            "destinations": [],
+            "status": "healthy"
+          }
+        ]
+      }
+    }
+  }
+}

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

@@ -0,0 +1,33 @@
+{
+  "title": "Get data export destination",
+  "description": "Get a data export destination with Id.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "destinationId": "destination1",
+    "api-version": "1.1-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "1021f12a-6969-4eff-8518-57cac5f128ab",
+        "displayName": "Webhook No Auth",
+        "type": "webhook@v1",
+        "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
+        "headerCustomizations": {
+          "x-custom-region": {
+            "value": "westcentralus",
+            "secret": false
+          }
+        },
+        "status": "error",
+        "errors": [
+          {
+            "code": "InvalidResponse",
+            "message": "The webhook returned a 4xx status code."
+          }
+        ]
+      }
+    }
+  }
+}

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

@@ -0,0 +1,86 @@
+{
+  "title": "List data export destinations in your application",
+  "description": "Get a list of data export destinations in your application.",
+  "parameters": {
+    "baseDomain": "azureiotcentral.com",
+    "subdomain": "appsubdomain",
+    "api-version": "1.1-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "1021f12a-6969-4eff-8518-57cac5f128ab",
+            "displayName": "Webhook No Auth",
+            "type": "webhook@v1",
+            "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd",
+            "headerCustomizations": {
+              "x-custom-region": {
+                "value": "westcentralus",
+                "secret": false
+              }
+            },
+            "status": "waiting"
+          },
+          {
+            "id": "70bb70e7-e308-4628-95aa-706596646f02",
+            "displayName": "Service Bus Queue",
+            "type": "servicebusqueue@v1",
+            "authorization": {
+              "type": "connectionString",
+              "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[queue name]"
+            },
+            "status": "waiting"
+          },
+          {
+            "id": "7308456f-c72b-43d8-99ba-22a49ea5d51a",
+            "displayName": "Service Bus Topic",
+            "type": "servicebustopic@v1",
+            "authorization": {
+              "type": "connectionString",
+              "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[topic name]"
+            },
+            "status": "waiting"
+          },
+          {
+            "id": "b3bfe8f0-ea63-42f9-82e1-bbade5250aba",
+            "displayName": "Azure Data Explorer",
+            "type": "dataexplorer@v1",
+            "clusterUrl": "https://[clusterName].westus2.kusto.windows.net",
+            "database": "iiot",
+            "table": "demo",
+            "authorization": {
+              "type": "servicePrincipal",
+              "clientId": "5b420743-2020-44c6-9b70-cc42f945db0c",
+              "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
+              "clientSecret": "*****"
+            },
+            "status": "waiting"
+          },
+          {
+            "id": "beb083d0-cec9-4e7e-8e4b-22b88e8e3479",
+            "displayName": "Azure Blob Storage",
+            "type": "blobstorage@v1",
+            "authorization": {
+              "type": "connectionString",
+              "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=*****;EndpointSuffix=core.windows.net",
+              "containerName": "test"
+            },
+            "status": "waiting"
+          },
+          {
+            "id": "c0e2a49f-6d5b-4bc1-b448-069806b72781",
+            "displayName": "Event Hub",
+            "type": "eventhubs@v1",
+            "authorization": {
+              "type": "connectionString",
+              "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=[hub name]"
+            },
+            "status": "waiting"
+          }
+        ]
+      }
+    }
+  }
+}