[Hub Generated] Publish private branch 'IoTOperationsDataProcessor' (A…

…zure#26279) * add or modify files * update
dhung-msft · Oct 30, 2023 · ac4134a · ac4134a
1 parent aab4ddf
commit ac4134a
Show file tree

Hide file tree

Showing 42 changed files with 3,475 additions and 0 deletions.
diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/common.tsp
@@ -0,0 +1,41 @@
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+import "@azure-tools/typespec-providerhub";
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using TypeSpec.Versioning;
+using Azure.Core;
+using Azure.ResourceManager;
+
+namespace Microsoft.IoTOperationsDataProcessor;
+
+@doc("Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.")
+model ExtendedLocation {
+  @doc("The name of the extended location.")
+  name: string;
+
+  @doc("The type of the extended location.")
+  type: string;
+}
+
+@lroStatus
+@doc("The provisioning status of the resource.")
+enum ProvisioningState {
+  ...ResourceProvisioningState,
+
+  @doc("The resource is being created.")
+  Provisioning,
+
+  @doc("The resource is being updated.")
+  Updating,
+
+  @doc("The resource is being deleted.")
+  Deleting,
+
+  @doc("The resource was accepted by the server.")
+  Accepted,
+}
diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/dataset.tsp
@@ -0,0 +1,73 @@
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+import "@azure-tools/typespec-providerhub";
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+import "./common.tsp";
+import "./instance.tsp";
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using TypeSpec.Versioning;
+using Azure.Core;
+using Azure.ResourceManager;
+
+namespace Microsoft.IoTOperationsDataProcessor;
+
+@doc("A Dataset resource belonging to an Instance resource.")
+@parentResource(Instance)
+model Dataset is TrackedResource<DatasetProperties> {
+  @doc("Name of dataset.")
+  @key("datasetName")
+  @segment("datasets")
+  @pattern("^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$")
+  @path
+  name: string;
+
+  // Extended location is not included in TrackedResource yet
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
+  @doc("Edge location of the resource.")
+  @visibility("read", "create")
+  extendedLocation: ExtendedLocation;
+}
+
+@doc("The properties of a Dataset resource.")
+model DatasetProperties {
+  @doc("Detailed description of the Dataset.")
+  description?: string;
+
+  @doc("Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.")
+  payload?: string;
+
+  @doc("Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.")
+  timestamp?: string;
+
+  @doc("Time to live for individual records.")
+  ttl?: string;
+
+  @doc("List of keys that can be used for joining on enrich.")
+  keys?: Record<DatasetPropertyKey>;
+
+  @doc("The status of the last operation.")
+  @visibility("read")
+  provisioningState?: ProvisioningState;
+}
+
+@doc("Key that can be used for joining on enrich.")
+model DatasetPropertyKey {
+  @doc("Path to the input value from the message.")
+  path: string;
+
+  @doc("If true the property will be used as a primary key. At most one primary key can exists.")
+  primaryKey?: boolean;
+}
+
+@armResourceOperations
+interface Datasets {
+  get is ArmResourceRead<Dataset>;
+  createOrUpdate is ArmResourceCreateOrUpdateAsync<Dataset>;
+  update is ArmCustomPatchSync<Dataset>;
+  delete is ArmResourceDeleteWithoutOkAsync<Dataset>;
+  listByInstance is ArmResourceListByParent<Dataset>;
+}
diff --git a/...oTOperationsDataProcessor.Management/examples/Datasets_CreateOrUpdate_MaximumSet_Gen.json b/...oTOperationsDataProcessor.Management/examples/Datasets_CreateOrUpdate_MaximumSet_Gen.json
@@ -0,0 +1,90 @@
+{
+  "title": "Datasets create or update - generated by [MaximumSet] rule",
+  "operationId": "Datasets_CreateOrUpdate",
+  "parameters": {
+    "api-version": "2023-10-04-preview",
+    "subscriptionId": "e0aaa3df-e9a4-456a-9824-3c3b5c438110",
+    "resourceGroupName": "rgopenapi",
+    "instanceName": "xh--6h732-2-6-21-4513-2-597q-5412971q",
+    "datasetName": "709v7-95-5-t-52oc5--s-5-5876j45wp6mf6--n-8bh--l55-r477",
+    "resource": {
+      "properties": {
+        "payload": ".value",
+        "timestamp": ".timestamp",
+        "ttl": "72h",
+        "keys": {},
+        "provisioningState": "Succeeded",
+        "description": "pakdvhh"
+      },
+      "extendedLocation": {
+        "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+        "type": "CustomLocation"
+      },
+      "tags": {},
+      "location": "westus"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "payload": ".value",
+          "timestamp": ".timestamp",
+          "ttl": "72h",
+          "keys": {},
+          "provisioningState": "Succeeded",
+          "description": "pakdvhh"
+        },
+        "extendedLocation": {
+          "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+          "type": "CustomLocation"
+        },
+        "tags": {},
+        "location": "westus",
+        "id": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.IoTOperationsDataProcessor/instances/IoTOperationsDataProcessor-instance-name/datasets/IoTOperationsDataProcessor-dataset-name",
+        "name": "IoTOperationsDataProcessor-dataset-name",
+        "type": "Microsoft.IoTOperationsDataProcessor/instances/datasets",
+        "systemData": {
+          "createdBy": "IoTOperationsDataProcessor@contoso.com",
+          "createdByType": "User",
+          "createdAt": "2023-07-14T23:18:33.262Z",
+          "lastModifiedBy": "IoTOperationsDataProcessor@contoso.com",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2023-07-14T23:18:33.262Z"
+        }
+      }
+    },
+    "201": {
+      "headers": {
+        "Azure-AsyncOperation": "https://contoso.com/operationstatus"
+      },
+      "body": {
+        "properties": {
+          "payload": ".value",
+          "timestamp": ".timestamp",
+          "ttl": "72h",
+          "keys": {},
+          "provisioningState": "Succeeded",
+          "description": "pakdvhh"
+        },
+        "extendedLocation": {
+          "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+          "type": "CustomLocation"
+        },
+        "tags": {},
+        "location": "westus",
+        "id": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.IoTOperationsDataProcessor/instances/IoTOperationsDataProcessor-instance-name/datasets/IoTOperationsDataProcessor-dataset-name",
+        "name": "IoTOperationsDataProcessor-dataset-name",
+        "type": "Microsoft.IoTOperationsDataProcessor/instances/datasets",
+        "systemData": {
+          "createdBy": "IoTOperationsDataProcessor@contoso.com",
+          "createdByType": "User",
+          "createdAt": "2023-07-14T23:18:33.262Z",
+          "lastModifiedBy": "IoTOperationsDataProcessor@contoso.com",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2023-07-14T23:18:33.262Z"
+        }
+      }
+    }
+  }
+}
diff --git a/...cessor/IoTOperationsDataProcessor.Management/examples/Datasets_Delete_MaximumSet_Gen.json b/...cessor/IoTOperationsDataProcessor.Management/examples/Datasets_Delete_MaximumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+  "title": "Datasets_Delete - generated by [MaximumSet] rule",
+  "operationId": "Datasets_Delete",
+  "parameters": {
+    "api-version": "2023-10-04-preview",
+    "subscriptionId": "e0aaa3df-e9a4-456a-9824-3c3b5c438110",
+    "resourceGroupName": "rgopenapi",
+    "instanceName": "6j580e8v-9wja6361-2jr212f--m",
+    "datasetName": "8-3j5f43z"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "location": "https://contoso.com/operationstatus"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/...processor/IoTOperationsDataProcessor.Management/examples/Datasets_Get_MaximumSet_Gen.json b/...processor/IoTOperationsDataProcessor.Management/examples/Datasets_Get_MaximumSet_Gen.json
@@ -0,0 +1,42 @@
+{
+  "title": "Datasets_Get - generated by [MaximumSet] rule",
+  "operationId": "Datasets_Get",
+  "parameters": {
+    "api-version": "2023-10-04-preview",
+    "subscriptionId": "e0aaa3df-e9a4-456a-9824-3c3b5c438110",
+    "resourceGroupName": "rgopenapi",
+    "instanceName": "d8-556-7343d--126-21-6187034w-g-26-03--176od-2",
+    "datasetName": "l-c1q8249l"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "payload": ".value",
+          "timestamp": ".timestamp",
+          "ttl": "72h",
+          "keys": {},
+          "provisioningState": "Succeeded",
+          "description": "pakdvhh"
+        },
+        "extendedLocation": {
+          "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+          "type": "CustomLocation"
+        },
+        "tags": {},
+        "location": "westus",
+        "id": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.IoTOperationsDataProcessor/instances/IoTOperationsDataProcessor-instance-name/datasets/IoTOperationsDataProcessor-dataset-name",
+        "name": "IoTOperationsDataProcessor-dataset-name",
+        "type": "Microsoft.IoTOperationsDataProcessor/instances/datasets",
+        "systemData": {
+          "createdBy": "IoTOperationsDataProcessor@contoso.com",
+          "createdByType": "User",
+          "createdAt": "2023-07-14T23:18:33.262Z",
+          "lastModifiedBy": "IoTOperationsDataProcessor@contoso.com",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2023-07-14T23:18:33.262Z"
+        }
+      }
+    }
+  }
+}
diff --git a/...oTOperationsDataProcessor.Management/examples/Datasets_ListByInstance_MaximumSet_Gen.json b/...oTOperationsDataProcessor.Management/examples/Datasets_ListByInstance_MaximumSet_Gen.json
@@ -0,0 +1,46 @@
+{
+  "title": "Datasets_ListByInstance - generated by [MaximumSet] rule",
+  "operationId": "Datasets_ListByInstance",
+  "parameters": {
+    "api-version": "2023-10-04-preview",
+    "subscriptionId": "e0aaa3df-e9a4-456a-9824-3c3b5c438110",
+    "resourceGroupName": "rgopenapi",
+    "instanceName": "43v87---75-8427ivdy5"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "properties": {
+              "payload": ".value",
+              "timestamp": ".timestamp",
+              "ttl": "72h",
+              "keys": {},
+              "provisioningState": "Succeeded",
+              "description": "jsnpmwkzsvchrhugocmf"
+            },
+            "extendedLocation": {
+              "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+              "type": "CustomLocation"
+            },
+            "tags": {},
+            "location": "westus",
+            "id": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.IoTOperationsDataProcessor/instances/IoTOperationsDataProcessor-instance-name/datasets/IoTOperationsDataProcessor-dataset-name",
+            "name": "IoTOperationsDataProcessor-dataset-name",
+            "type": "Microsoft.IoTOperationsDataProcessor/instances/datasets",
+            "systemData": {
+              "createdBy": "IoTOperationsDataProcessor@contoso.com",
+              "createdByType": "User",
+              "createdAt": "2023-07-14T23:18:33.262Z",
+              "lastModifiedBy": "IoTOperationsDataProcessor@contoso.com",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2023-07-14T23:18:33.262Z"
+            }
+          }
+        ],
+        "nextLink": "https://microsoft.com/axpt"
+      }
+    }
+  }
+}
diff --git a/...cessor/IoTOperationsDataProcessor.Management/examples/Datasets_Update_MaximumSet_Gen.json b/...cessor/IoTOperationsDataProcessor.Management/examples/Datasets_Update_MaximumSet_Gen.json
@@ -0,0 +1,45 @@
+{
+  "title": "Datasets_Update - generated by [MaximumSet] rule",
+  "operationId": "Datasets_Update",
+  "parameters": {
+    "api-version": "2023-10-04-preview",
+    "subscriptionId": "e0aaa3df-e9a4-456a-9824-3c3b5c438110",
+    "resourceGroupName": "rgopenapi",
+    "instanceName": "60b-93eu93872-r9i841-82j2-02h3q",
+    "datasetName": "7x69q1-29-82---k5-y44154gm-8772--6i59d88--1l",
+    "properties": {
+      "tags": {}
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "payload": ".value",
+          "timestamp": ".timestamp",
+          "ttl": "72h",
+          "keys": {},
+          "provisioningState": "Succeeded",
+          "description": "pakdvhh"
+        },
+        "extendedLocation": {
+          "name": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.ExtendedLocation/customLocations/dev-space",
+          "type": "CustomLocation"
+        },
+        "tags": {},
+        "location": "westus",
+        "id": "/subscriptions/e0aaa3df-e9a4-456a-9824-3c3b5c438110/resourceGroups/IoTOperationsDataProcessor-rg/providers/Microsoft.IoTOperationsDataProcessor/instances/IoTOperationsDataProcessor-instance-name/datasets/IoTOperationsDataProcessor-dataset-name",
+        "name": "IoTOperationsDataProcessor-dataset-name",
+        "type": "Microsoft.IoTOperationsDataProcessor/instances/datasets",
+        "systemData": {
+          "createdBy": "IoTOperationsDataProcessor@contoso.com",
+          "createdByType": "User",
+          "createdAt": "2023-07-14T23:18:33.262Z",
+          "lastModifiedBy": "IoTOperationsDataProcessor@contoso.com",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2023-07-14T23:18:33.262Z"
+        }
+      }
+    }
+  }
+}