Pushing Swagger into Azure SPEC for MS-Learn

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/client.tsp

@@ -0,0 +1,93 @@
+/**
+ * PLACEHOLDER
+ * Add readme and sample
+ */
+import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+using PurviewUnifiedCatalog;
+
+namespace Customizations;
+
+// @@clientName(ListCriticalDataElementAsync, "ListCriticalDataElement");
+// @@clientName(CreateCriticalDataElementAsync, "CreateCriticalDataElement");
+// @@clientName(GetCriticalDataElementByIdAsync, "GetCriticalDataElementById");
+// @@clientName(UpdateCriticalDataElementAsync, "UpdateCriticalDataElement");
+// @@clientName(DeleteCriticalDataElementByIdAsync,
+//   "DeleteCriticalDataElementById"
+// );
+// @@clientName(ListCriticalDataElementRelationshipsAsync,
+//   "ListCriticalDataElementRelationships"
+// );
+// @@clientName(CreateCriticalDataElementRelationshipAsync,
+//   "CreateCriticalDataElementRelationship"
+// );
+// @@clientName(DeleteCriticalDataElementRelationshipAsync,
+//   "DeleteCriticalDataElementRelationship"
+// );
+// @@clientName(GetCriticalDataElementFacetsAsync, "GetCriticalDataElementFacets");
+// @@clientName(CreateCriticalDataColumnAsync, "CreateCriticalDataColumn");
+// @@clientName(ListCriticalDataColumnAsync, "ListCriticalDataColumn");
+// @@clientName(GetCriticalDataColumnByIdAsync, "GetCriticalDataColumnById");
+// @@clientName(CreateCriticalDataColumnRelationshipAsync,
+//   "CreateCriticalDataColumnRelationship"
+// );
+// @@clientName(ListCriticalDataColumnRelationshipsAsync,
+//   "ListCriticalDataColumnRelationships"
+// );
+// @@clientName(DeleteCriticalDataColumnRelationshipAsync,
+//   "DeleteCriticalDataColumnRelationship"
+// );
+// @@clientName(ListDataAssetsAsync, "ListDataAssets");
+// @@clientName(CreateDataAssetAsync, "CreateDataAsset");
+// @@clientName(QueryDataAssetsAsync, "QueryDataAssets");
+// @@clientName(GetDataAssetByIdAsync, "GetDataAssetById");
+// @@clientName(UpdateDataAssetAsync, "UpdateDataAsset");
+// @@clientName(DeleteDataAssetByIdAsync, "DeleteDataAssetById");
+// @@clientName(ListDataAssetRelationshipsAsync, "ListDataAssetRelationships");
+// @@clientName(CreateDataAssetRelationshipAsync, "CreateDataAssetRelationship");
+// @@clientName(DeleteDataAssetRelationshipAsync, "DeleteDataAssetRelationship");
+// @@clientName(ListDataProductsAsync, "ListDataProducts");
+// @@clientName(CreateDataProductAsync, "CreateDataProduct");
+// @@clientName(QueryDataProductsAsync, "QueryDataProducts");
+// @@clientName(GetDataProductFacetsAsync, "GetDataProductFacets");
+// @@clientName(GetDataProductByIdAsync, "GetDataProductById");
+// @@clientName(UpdateDataProductAsync, "UpdateDataProduct");
+// @@clientName(DeleteDataProductByIdAsync, "DeleteDataProductById");
+// @@clientName(ListDataProductRelationshipsAsync, "ListDataProductRelationships");
+// @@clientName(CreateDataProductRelationshipAsync,
+//   "CreateDataProductRelationship"
+// );
+// @@clientName(DeleteDataProductRelationshipAsync,
+//   "DeleteDataProductRelationship"
+// );
+// @@clientName(EnumerateDomainsAsync, "EnumerateDomains");
+// @@clientName(CreateDomainAsync, "CreateDomain");
+// @@clientName(UpdateDomainAsync, "UpdateDomain");
+// @@clientName(GetDomainByIdAsync, "GetDomainById");
+// @@clientName(DeleteDomainByIdAsync, "DeleteDomainById");
+// @@clientName(CreateTermAsync, "CreateTerm");
+// @@clientName(ListTermAsync, "ListTerm");
+// @@clientName(UpdateTermAsync, "UpdateTerm");
+// @@clientName(GetTermAsync, "GetTerm");
+// @@clientName(DeleteTermAsync, "DeleteTerm");
+// @@clientName(QueryTermsAsync, "QueryTerms");
+// @@clientName(GetTermFacetsAsync, "GetTermFacets");
+// @@clientName(ListHierarchyTermsAsync, "ListHierarchyTerms");
+// @@clientName(AddRelatedEntityAsync, "AddRelatedEntity");
+// @@clientName(DeleteRelatedTermAsync, "DeleteRelatedTerm");
+// @@clientName(ListRelatedEntitiesAsync, "ListRelatedEntities");
+// @@clientName(ListObjectivesAsync, "ListObjectives");
+// @@clientName(CreateObjectiveAsync, "CreateObjective");
+// @@clientName(QueryObjectivesAsync, "QueryObjectives");
+// @@clientName(GetObjectiveFacetsAsync, "GetObjectiveFacets");
+// @@clientName(UpdateObjectiveAsync, "UpdateObjective");
+// @@clientName(DeleteObjectiveByIdAsync, "DeleteObjectiveById");
+// @@clientName(GetObjectiveByIdAsync, "GetObjectiveById");
+// @@clientName(ListKeyResultsAsync, "ListKeyResults");
+// @@clientName(CreateKeyResultAsync, "CreateKeyResult");
+// @@clientName(GetKeyResultByIdAsync, "GetKeyResultById");
+// @@clientName(UpdateKeyResultAsync, "UpdateKeyResult");
+// @@clientName(DeleteKeyResultByIdAsync, "DeleteKeyResultById");
+@@clientName(AudienceEnum, "PurviewUnifiedCatalogRole");

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/AddRelatedEntity_MaximumSet_Gen.json

@@ -0,0 +1,29 @@
+{
+  "title": "AddRelatedEntity_MaximumSet",
+  "operationId": "AddRelatedEntity",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "termId": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+    "entityType": "TERM",
+    "termRelation": {
+      "description": "xs",
+      "entityId": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+      "relationshipType": "Synonym"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "systemData": {
+          "lastModifiedAt": "1970-01-01T00:00:00.000Z",
+          "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "createdAt": "1970-01-01T00:00:00.000Z",
+          "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
+        },
+        "description": "This is a description",
+        "relationshipType": "Related",
+        "entityId": "4e74f902-62f5-49f4-8258-92ed2b8537ba"
+      }
+    }
+  }
+}

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/CreateCriticalDataColumnRelationship_MaximumSet_Gen.json

@@ -0,0 +1,31 @@
+{
+  "title": "CreateCriticalDataColumnRelationship_MaximumSet",
+  "operationId": "CreateCriticalDataColumnRelationship",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "criticalDataColumnId": "7e74f902-62f5-49f4-8258-92ed2b8537ba",
+    "entityType": "CRITICALDATAELEMENT",
+    "relationship": {
+      "systemData": {},
+      "description": "This is a description",
+      "relationshipType": "Related",
+      "assetId": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+      "entityId": "06678fd6-2e68-44e3-bc58-4e878e8dfa09"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "systemData": {
+          "lastModifiedAt": "1970-01-01T00:00:00.000Z",
+          "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "createdAt": "1970-01-01T00:00:00.000Z",
+          "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
+        },
+        "description": "This is a description",
+        "relationshipType": "Related",
+        "entityId": "4e74f902-62f5-49f4-8258-92ed2b8537ba"
+      }
+    }
+  }
+}

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/CreateCriticalDataColumn_MaximumSet_Gen.json

@@ -0,0 +1,53 @@
+{
+  "title": "CreateCriticalDataColumn_MaximumSet",
+  "operationId": "CreateCriticalDataColumn",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "criticalDataColumn": {
+      "id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+      "name": "columnA",
+      "systemData": {
+        "lastModifiedAt": "1970-01-01T00:00:00.000Z",
+        "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+        "createdAt": "1970-01-01T00:00:00.000Z",
+        "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+        "expiredAt": "1970-01-01T00:00:00.000Z",
+        "expiredBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
+      },
+      "domain": "7e74f902-62f5-49f4-8258-92ed2b8537ba",
+      "assetId": "9e74f902-62f5-49f4-8258-92ed2b8537ba",
+      "description": "column A description",
+      "classifications": [
+        "PII",
+        "PHI"
+      ],
+      "dataType": "nvarchar",
+      "assetName": "TableA"
+    }
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+        "name": "columnA",
+        "systemData": {
+          "lastModifiedAt": "1970-01-01T00:00:00.000Z",
+          "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "createdAt": "1970-01-01T00:00:00.000Z",
+          "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "expiredAt": "1970-01-01T00:00:00.000Z",
+          "expiredBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
+        },
+        "domain": "7e74f902-62f5-49f4-8258-92ed2b8537ba",
+        "assetId": "9e74f902-62f5-49f4-8258-92ed2b8537ba",
+        "description": "column A description",
+        "classifications": [
+          "PII",
+          "PHI"
+        ],
+        "dataType": "nvarchar",
+        "assetName": "TableA"
+      }
+    }
+  }
+}

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/CreateCriticalDataElementRelationship_MaximumSet_Gen.json

@@ -0,0 +1,29 @@
+{
+  "title": "CreateCriticalDataElementRelationship_MaximumSet",
+  "operationId": "CreateCriticalDataElementRelationship",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "criticalDataElementId": "7e74f902-62f5-49f4-8258-92ed2b8537ba",
+    "entityType": "CRITICALDATACOLUMN",
+    "relationship": {
+      "description": "",
+      "entityId": "0df56531-7b63-41d6-87f3-870ed21d8f6e",
+      "relationshipType": "Related"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "systemData": {
+          "lastModifiedAt": "2025-08-05T16:48:43.702Z",
+          "lastModifiedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "createdAt": "string",
+          "createdBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+        },
+        "description": "string",
+        "relationshipType": "string",
+        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+      }
+    }
+  }
+}

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/CreateCriticalDataElement_MaximumSet_Gen.json

@@ -0,0 +1,70 @@
+{
+  "title": "CreateCriticalDataElement_MaximumSet",
+  "operationId": "CreateCriticalDataElement",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "criticalDataElement": {
+      "status": "PUBLISHED",
+      "dataType": "TEXT",
+      "id": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+      "name": "uwae",
+      "systemData": {
+        "createdAt": "2025-06-16T21:01:37.447Z",
+        "createdBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+        "lastModifiedAt": "2025-06-16T21:01:37.447Z",
+        "lastModifiedBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+        "expiredAt": "2025-06-16T21:01:37.447Z",
+        "expiredBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a"
+      },
+      "domain": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+      "description": "lkijxttoytawcul",
+      "contacts": {
+        "key5875": [
+          {
+            "id": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+            "description": "atitetlocznsnmithbzk"
+          }
+        ]
+      },
+      "managedAttributes": [
+        {
+          "name": "yudgednngbwobftmdyfwiblftdw"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "status": "PUBLISHED",
+        "dataType": "TEXT",
+        "id": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+        "name": "uwae",
+        "systemData": {
+          "createdAt": "2025-06-16T21:01:37.447Z",
+          "createdBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+          "lastModifiedAt": "2025-06-16T21:01:37.447Z",
+          "lastModifiedBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+          "expiredAt": "2025-06-16T21:01:37.447Z",
+          "expiredBy": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a"
+        },
+        "domain": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+        "description": "lkijxttoytawcul",
+        "contacts": {
+          "key5875": [
+            {
+              "id": "b3b4cc6e-6a91-4d34-8af3-90e2f93d6c7a",
+              "description": "atitetlocznsnmithbzk"
+            }
+          ]
+        },
+        "managedAttributes": [
+          {
+            "name": "analytics campign.efg",
+            "value": "\"trst\""
+          }
+        ]
+      }
+    }
+  }
+}

specification/purviewdatagovernance/Azure.Analytics.Purview.UnifiedCatalog/examples/2025-09-15-preview/CreateDataAssetRelationship_MaximumSet_Gen.json

@@ -0,0 +1,38 @@
+{
+  "title": "CreateDataAssetRelationship_MaximumSet",
+  "operationId": "CreateDataAssetRelationship",
+  "parameters": {
+    "api-version": "2025-09-15-preview",
+    "dataAssetId": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+    "entityType": "CRITICALDATACOLUMN",
+    "relationship": {
+      "relationship1": {
+        "systemData": {
+          "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "createdAt": "2025-09-22T12:00:00Z",
+          "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "lastModifiedAt": "2025-09-22T12:00:00Z"
+        },
+        "description": "This is a description",
+        "relationshipType": "Related",
+        "assetId": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
+        "entityId": "4e74f902-62f5-49f4-8258-92ed2b8537ba"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "systemData": {
+          "lastModifiedAt": "1970-01-01T00:00:00.000Z",
+          "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
+          "createdAt": "1970-01-01T00:00:00.000Z",
+          "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
+        },
+        "description": "This is a description",
+        "relationshipType": "Related",
+        "entityId": "4e74f902-62f5-49f4-8258-92ed2b8537ba"
+      }
+    }
+  }
+}