Feature/datamap tsp

custom-words.txt

@@ -668,6 +668,7 @@ datalake
 datalakeanalytics
 datalakestore
 datamanagement
+datamap
 datamasking
 datamigration
 datamodel
@@ -2898,6 +2899,7 @@ timeseries
 timeseriesinsights
 timespan
 timestep
+timerange
 timezones
 tinyint
 titledatakeyvalues

specification/purview/Azure.Analytics.Purview.DataMap/client.tsp

@@ -0,0 +1,138 @@
+import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+using PurviewDataMap;
+
+@TypeSpec.Versioning.useDependency(PurviewDataMap.ApiVersions.v2023_09_01)
+namespace Customizations;
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+@client({
+  name: "DataMapClient",
+  service: PurviewDataMap,
+})
+@operationGroup
+interface Entity {
+  createOrUpdate is PurviewDataMap.Entity.createOrUpdate;
+  getByIds is PurviewDataMap.Entity.listByGuids;
+  batchCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate;
+  batchDelete is PurviewDataMap.Entity.bulkDelete;
+  addClassification is PurviewDataMap.Entity.addClassification;
+  get is PurviewDataMap.Entity.get;
+  partialUpdateAttributeById is PurviewDataMap.Entity.partialUpdateAttributeByGuid;
+  delete is PurviewDataMap.Entity.delete;
+  getClassification is PurviewDataMap.Entity.getClassification;
+  removeClassification is PurviewDataMap.Entity.removeClassification;
+  getClassifications is PurviewDataMap.Entity.getClassifications;
+  addClassifications is PurviewDataMap.Entity.addClassifications;
+  updateClassifications is PurviewDataMap.Entity.updateClassifications;
+  getByAttributes is PurviewDataMap.Entity.getByUniqueAttributes;
+  partialUpdateByAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes;
+  deleteByAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute;
+  removeClassificationByAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute;
+  addClassificationsByAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute;
+  updateClassificationsByAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute;
+  batchSetClassifications is PurviewDataMap.Entity.bulkSetClassifications;
+  batchGetByAttributes is PurviewDataMap.Entity.listByUniqueAttributes;
+  getHeader is PurviewDataMap.Entity.getHeader;
+  removeBusinessMetadata is PurviewDataMap.Entity.removeBusinessMetadata;
+  addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata;
+  removeBusinessMetadataAttributes is PurviewDataMap.Entity.removeBusinessMetadataAttributes;
+  addOrUpdateBusinessMetadataAttributes is PurviewDataMap.Entity.addOrUpdateBusinessMetadataAttributes;
+  getSampleBusinessMetadataTemplate is PurviewDataMap.Entity.getSampleBusinessMetadataTemplate;
+  #suppress "@azure-tools/typespec-azure-core/byos" "This is Atlas API"
+  importBusinessMetadata is PurviewDataMap.Entity.importBusinessMetadata;
+  removeLabels is PurviewDataMap.Entity.removeLabels;
+  setLabels is PurviewDataMap.Entity.setLabels;
+  addLabel is PurviewDataMap.Entity.addLabel;
+  removeLabelsByAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute;
+  setLabelsByAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute;
+  addLabelsByAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute;
+  moveEntitiesToCollection is PurviewDataMap.Entity.moveEntitiesToCollection;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+@operationGroup
+interface Glossary {
+  batchGet is PurviewDataMap.Glossary.list;
+  create is PurviewDataMap.Glossary.create;
+  createCategories is PurviewDataMap.Glossary.createCategories;
+  createCategory is PurviewDataMap.Glossary.createCategory;
+  getCategory is PurviewDataMap.Glossary.getCategory;
+  updateCategory is PurviewDataMap.Glossary.updateCategory;
+  deleteCategory is PurviewDataMap.Glossary.deleteCategory;
+  partialUpdateCategory is PurviewDataMap.Glossary.partialUpdateCategory;
+  getRelatedCategories is PurviewDataMap.Glossary.listRelatedCategories;
+  getCategoryTerms is PurviewDataMap.Glossary.listCategoryTerms;
+  createTerm is PurviewDataMap.Glossary.createTerm;
+  getTerm is PurviewDataMap.Glossary.getTerm;
+  updateTerm is PurviewDataMap.Glossary.updateTerm;
+  deleteTerm is PurviewDataMap.Glossary.deleteTerm;
+  partialUpdateTerm is PurviewDataMap.Glossary.partialUpdateTerm;
+  createTerms is PurviewDataMap.Glossary.createTerms;
+  getEntitiesAssignedWithTerm is PurviewDataMap.Glossary.listEntitiesAssignedWithTerm;
+  assignTermToEntities is PurviewDataMap.Glossary.assignTermToEntities;
+  deleteTermAssignmentFromEntities is PurviewDataMap.Glossary.deleteTermAssignmentFromEntities;
+  getRelatedTerms is PurviewDataMap.Glossary.listRelatedTerms;
+  get is PurviewDataMap.Glossary.get;
+  update is PurviewDataMap.Glossary.update;
+  delete is PurviewDataMap.Glossary.delete;
+  getCategories is PurviewDataMap.Glossary.listCategories;
+  getCategoriesHeaders is PurviewDataMap.Glossary.listCategoriesHeaders;
+  getDetailed is PurviewDataMap.Glossary.getDetailed;
+  partialUpdate is PurviewDataMap.Glossary.partialUpdate;
+  getTerms is PurviewDataMap.Glossary.listTerms;
+  getTermHeaders is PurviewDataMap.Glossary.listTermHeaders;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+@operationGroup
+interface Discovery {
+  query is PurviewDataMap.Discovery.query;
+  suggest is PurviewDataMap.Discovery.suggest;
+  autoComplete is PurviewDataMap.Discovery.autoComplete;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+@operationGroup
+interface Lineage {
+  get is PurviewDataMap.Lineage.get;
+  getNextPage is PurviewDataMap.Lineage.getNextPage;
+  getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+interface Relationship {
+  create is PurviewDataMap.Relationship.create;
+  update is PurviewDataMap.Relationship.update;
+  get is PurviewDataMap.Relationship.get;
+  delete is PurviewDataMap.Relationship.delete;
+}
+
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
+@operationGroup
+interface TypeDefinition {
+  getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid;
+  getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName;
+  getClassificationById is PurviewDataMap.Type.getClassificationDefByGuid;
+  getClassificationByName is PurviewDataMap.Type.getClassificationDefByName;
+  getEntityById is PurviewDataMap.Type.getEntityDefByGuid;
+  getEntityByName is PurviewDataMap.Type.getEntityDefByName;
+  getEnumById is PurviewDataMap.Type.getEnumDefByGuid;
+  getEnumByName is PurviewDataMap.Type.getEnumDefByName;
+  getRelationshipById is PurviewDataMap.Type.getRelationshipDefByGuid;
+  getRelationshipByName is PurviewDataMap.Type.getRelationshipDefByName;
+  getStructById is PurviewDataMap.Type.getStructDefByGuid;
+  getStructByName is PurviewDataMap.Type.getStructDefByName;
+  getById is PurviewDataMap.Type.getByGuid;
+  getByName is PurviewDataMap.Type.getByName;
+  delete is PurviewDataMap.Type.delete;
+  get is PurviewDataMap.Type.list;
+  batchCreate is PurviewDataMap.Type.bulkCreate;
+  batchUpdate is PurviewDataMap.Type.bulkUpdate;
+  batchDelete is PurviewDataMap.Type.bulkDelete;
+  getHeaders is PurviewDataMap.Type.listHeaders;
+  getTermTemplateById is PurviewDataMap.Type.getTermTemplateDefByGuid;
+  getTermTemplateByName is PurviewDataMap.Type.getTermTemplateDefByName;
+}

specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json

@@ -0,0 +1,42 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "autoCompleteRequest": {
+      "keywords": "exa",
+      "filter": {
+        "kind": "AndFilter",
+        "and": [
+          {
+            "kind": "EntityTypeFilter",
+            "entityType": "azure_blob_path",
+            "includeSubTypes": false
+          }
+        ]
+      },
+      "limit": 10
+    },
+    "api-version": "2023-09-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "text": "example",
+            "queryPlusText": "example"
+          },
+          {
+            "text": "exampleconfiguration",
+            "queryPlusText": "exampleconfiguration"
+          },
+          {
+            "text": "exampleresources",
+            "queryPlusText": "exampleresources"
+          }
+        ]
+      }
+    }
+  },
+  "title": "Discovery_AutoComplete",
+  "operationId": "Discovery_AutoComplete"
+}

specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json

@@ -0,0 +1,112 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "searchRequest": {
+      "keywords": "exampledata",
+      "filter": {
+        "kind": "AndFilter",
+        "and": [
+          {
+            "kind": "ObjectTypeFilter",
+            "objectType": "Files"
+          },
+          {
+            "kind": "EntityTypeFilter",
+            "entityType": "azure_blob_path"
+          }
+        ]
+      },
+      "limit": 10,
+      "orderby": [
+        {
+          "name": "ASC"
+        },
+        {
+          "updateTime": "DESC"
+        }
+      ],
+      "facets": [
+        {
+          "facet": "assetType",
+          "count": 0,
+          "sort": {
+            "count": "desc"
+          }
+        },
+        {
+          "facet": "classification",
+          "count": 10,
+          "sort": {
+            "count": "desc"
+          }
+        },
+        {
+          "facet": "contactId",
+          "count": 10,
+          "sort": {
+            "count": "desc"
+          }
+        },
+        {
+          "facet": "label",
+          "count": 10,
+          "sort": {
+            "count": "desc"
+          }
+        },
+        {
+          "facet": "term",
+          "count": 10,
+          "sort": {
+            "count": "desc"
+          }
+        }
+      ]
+    },
+    "api-version": "2023-09-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "@search.count": 2,
+        "@search.count.approximate": false,
+        "value": [
+          {
+            "@search.score": 1.0,
+            "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
+            "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
+            "name": "exampledata1.txt",
+            "description": null,
+            "owner": null,
+            "entityType": "azure_blob_path",
+            "classification": [],
+            "label": [],
+            "assetType": [
+              "Azure Blob Storage"
+            ],
+            "term": [],
+            "contact": []
+          },
+          {
+            "@search.score": 1.0,
+            "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
+            "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
+            "name": "exampledata2.txt",
+            "description": null,
+            "owner": null,
+            "entityType": "azure_blob_path",
+            "classification": [],
+            "label": [],
+            "assetType": [
+              "Azure Blob Storage"
+            ],
+            "term": [],
+            "contact": []
+          }
+        ]
+      }
+    }
+  },
+  "title": "Discovery_Query",
+  "operationId": "Discovery_Query"
+}

specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json

@@ -0,0 +1,83 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "searchRequest": {
+      "keywords": null,
+      "limit": 10,
+      "filter": {
+        "kind": "AndFilter",
+        "and": [
+          {
+            "kind": "EntityTypeFilter",
+            "entityType": "azure_blob_path"
+          },
+          {
+            "kind": "AttributeFilter",
+            "attributeName": "qualifiedName",
+            "operator": "contains",
+            "attributeValue": ".csv"
+          }
+        ]
+      }
+    },
+    "api-version": "2023-09-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "@search.count": 5,
+        "@search.count.approximate": false,
+        "value": [
+          {
+            "@search.score": 1.0,
+            "@search.highlights": {
+              "qualifiedName": [
+                "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/exampledata.csv"
+              ]
+            },
+            "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
+            "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
+            "name": "exampledata.csv",
+            "description": null,
+            "owner": null,
+            "entityType": "azure_blob_path",
+            "classification": [],
+            "label": [
+              "Example.Label"
+            ],
+            "assetType": [
+              "Azure Blob Storage"
+            ],
+            "term": [],
+            "contact": []
+          },
+          {
+            "@search.score": 1.0,
+            "@search.highlights": {
+              "qualifiedName": [
+                "https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/AllTypes.csv"
+              ]
+            },
+            "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab",
+            "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv",
+            "name": "AllTypes.csv",
+            "description": null,
+            "owner": null,
+            "entityType": "azure_blob_path",
+            "classification": [],
+            "label": [
+              "Example.Label"
+            ],
+            "assetType": [
+              "Azure Blob Storage"
+            ],
+            "term": [],
+            "contact": []
+          }
+        ]
+      }
+    }
+  },
+  "title": "Discovery_Query_And",
+  "operationId": "Discovery_Query"
+}