-
Notifications
You must be signed in to change notification settings - Fork 6
Add Purview plugin #102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
johnhayes-squaredup
wants to merge
7
commits into
squaredup:main
Choose a base branch
from
johnhayes-squaredup:add-purview-plugin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add Purview plugin #102
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
bfb135c
Add Microsoft Purview plugin v1.4.3
johnhayes-squaredup 02b3388
Update Microsoft Purview plugin to v1.5.0
johnhayes-squaredup 2992e3c
Update Overview dashboard layout to v1.5.1
johnhayes-squaredup 3952610
Add Governance Domains and Glossary Terms streams to v1.6.2
johnhayes-squaredup d6234e4
Address CodeRabbit review comments on Microsoft Purview plugin v1.7.0
johnhayes-squaredup 39d17a1
Update readme to remove incorrect reference to Scans being indexed
johnhayes-squaredup 368c78d
Use composite scan ID to ensure globally unique indexed scan objects
johnhayes-squaredup File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "steps": [ | ||
| { | ||
| "displayName": "Authenticate and list collections", | ||
| "dataStream": { "name": "collections" }, | ||
| "required": true, | ||
| "error": "Could not authenticate or read collections. Check the account name, tenant/client ID, secret, and that the app registration has been added as Data Reader on the Purview root collection.", | ||
| "success": "Connected to Purview and read collections." | ||
| }, | ||
| { | ||
| "displayName": "List data sources", | ||
| "dataStream": { "name": "listDataSources" }, | ||
| "required": false, | ||
| "error": "Authenticated but could not list data sources. Add the app registration as Data Source Administrator on the Purview root collection.", | ||
| "success": "Data sources accessible." | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| [ | ||
| { | ||
| "name": "Purview Collection", | ||
| "sourceType": "Purview Collection", | ||
| "icon": "folder-tree", | ||
| "singular": "Collection", | ||
| "plural": "Collections" | ||
| }, | ||
| { | ||
| "name": "Purview Data Source", | ||
| "sourceType": "Purview Data Source", | ||
| "icon": "database", | ||
| "singular": "Data Source", | ||
| "plural": "Data Sources" | ||
| } | ||
| ] |
25 changes: 25 additions & 0 deletions
25
plugins/MicrosoftPurview/v1/dataStreams/accountAssetCount.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "name": "accountAssetCount", | ||
| "displayName": "Total Asset Count", | ||
| "description": "Total number of assets cataloged across the whole Purview account", | ||
| "tags": ["Assets"], | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1 | ||
| }, | ||
| "postRequestScript": "accountAssetCount.js" | ||
| }, | ||
| "matches": "none", | ||
| "metadata": [ | ||
| { "name": "label", "displayName": "Label", "role": "label" }, | ||
| { "name": "totalAssets", "displayName": "Total Assets", "shape": "number", "role": "value" } | ||
| ], | ||
| "timeframes": false | ||
| } |
37 changes: 37 additions & 0 deletions
37
plugins/MicrosoftPurview/v1/dataStreams/assetCountByEntityType.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "name": "assetCountByEntityType", | ||
| "displayName": "Asset Count by Entity Type", | ||
| "description": "Count of assets in the selected collection grouped by entity type", | ||
| "tags": ["Assets"], | ||
| "baseDataSourceName": "httpRequestScopedSingle", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1, | ||
| "filter": { | ||
| "collectionId": "{{object.collectionName}}" | ||
| }, | ||
| "facets": [ | ||
| { | ||
| "facet": "entityType", | ||
| "count": 50, | ||
| "sort": { "count": "desc" } | ||
| } | ||
| ] | ||
| }, | ||
| "pathToData": "@search.facets.entityType", | ||
| "postRequestScript": "assetCountByEntityType.js" | ||
| }, | ||
| "matches": { "sourceType": { "type": "oneOf", "values": ["Purview Collection"] } }, | ||
| "metadata": [ | ||
| { "name": "entityType", "displayName": "Entity Type", "role": "label" }, | ||
| { "name": "count", "displayName": "Assets", "shape": "number" } | ||
| ], | ||
| "timeframes": false, | ||
| "defaultShaping": { "sort": { "by": [["count", "desc"]] } } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| { | ||
| "name": "assetLineage", | ||
| "displayName": "Asset Lineage", | ||
| "description": "Upstream and downstream lineage for an asset identified by its GUID", | ||
| "tags": ["Assets"], | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "ui": [ | ||
| { | ||
| "type": "text", | ||
| "name": "assetGuid", | ||
| "label": "Asset GUID", | ||
| "placeholder": "Asset GUID from the catalog", | ||
| "validation": { | ||
| "required": true, | ||
| "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" | ||
| }, | ||
| "help": "The Purview asset's GUID. Copy it from the asset details page in the Purview portal, or from the **Asset GUID** column of the Search Assets stream." | ||
| }, | ||
| { | ||
| "type": "switch", | ||
| "name": "direction", | ||
| "label": "Direction", | ||
| "defaultValue": "BOTH", | ||
| "options": [ | ||
| { "value": "BOTH", "label": "Both" }, | ||
| { "value": "INPUT", "label": "Upstream" }, | ||
| { "value": "OUTPUT", "label": "Downstream" } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "number", | ||
| "name": "depth", | ||
| "label": "Depth", | ||
| "defaultValue": 3, | ||
| "validation": { "min": 0, "max": 10 }, | ||
| "help": "Number of hops to traverse in each direction." | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| } | ||
| ], | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "endpointPath": "datamap/api/atlas/v2/lineage/{{assetGuid}}", | ||
| "getArgs": [ | ||
| { "key": "direction", "value": "{{direction}}" }, | ||
| { "key": "depth", "value": "{{depth}}" } | ||
| ], | ||
| "postRequestScript": "assetLineage.js" | ||
| }, | ||
| "manualConfigApply": true, | ||
| "matches": "none", | ||
| "metadata": [ | ||
| { "name": "guid", "displayName": "GUID", "shape": "guid", "visible": false }, | ||
| { "name": "name", "displayName": "Name", "role": "label" }, | ||
| { "name": "typeName", "displayName": "Entity Type" }, | ||
| { "name": "qualifiedName", "displayName": "Qualified Name" }, | ||
| { | ||
| "name": "role", | ||
| "displayName": "Role", | ||
| "shape": [ | ||
| "state", | ||
| { | ||
| "map": { | ||
| "success": ["Base"], | ||
| "warning": ["Upstream"], | ||
| "unknown": ["Downstream"] | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| { "name": "status", "displayName": "Status" }, | ||
| { | ||
| "name": "classifications", | ||
| "displayName": "Classifications" | ||
| } | ||
| ], | ||
| "timeframes": false | ||
| } | ||
42 changes: 42 additions & 0 deletions
42
plugins/MicrosoftPurview/v1/dataStreams/assetsByCollection.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "name": "assetsByCollection", | ||
| "displayName": "Assets in Collection", | ||
| "description": "Assets found in the selected Purview collection", | ||
| "tags": ["Assets"], | ||
| "baseDataSourceName": "httpRequestScopedSingle", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 100, | ||
| "filter": { | ||
| "collectionId": "{{object.collectionName}}" | ||
| }, | ||
| "orderby": [{ "name": "ASC" }] | ||
| }, | ||
| "postRequestScript": "assetsByCollection.js", | ||
| "paging": { | ||
| "mode": "token", | ||
| "in": { "realm": "payload", "path": "continuationToken" }, | ||
| "out": { "realm": "body", "path": "continuationToken" } | ||
| } | ||
| }, | ||
| "matches": { "sourceType": { "type": "oneOf", "values": ["Purview Collection"] } }, | ||
| "metadata": [ | ||
| { "name": "id", "displayName": "Asset GUID", "shape": "guid", "visible": false }, | ||
| { "name": "name", "displayName": "Name", "role": "label" }, | ||
| { "name": "qualifiedName", "displayName": "Qualified Name" }, | ||
| { "name": "entityType", "displayName": "Entity Type" }, | ||
| { "name": "assetType", "displayName": "Asset Type" }, | ||
| { "name": "classification", "displayName": "Classifications" }, | ||
| { "name": "term", "displayName": "Glossary Terms" }, | ||
| { "name": "label", "displayName": "Labels" }, | ||
| { "name": "description", "displayName": "Description" }, | ||
| { "name": "owner", "displayName": "Owner" } | ||
| ], | ||
| "timeframes": false | ||
| } |
31 changes: 31 additions & 0 deletions
31
plugins/MicrosoftPurview/v1/dataStreams/assetsByEntityTypeGlobal.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| { | ||
| "name": "assetsByEntityTypeGlobal", | ||
| "displayName": "Asset Count by Entity Type", | ||
| "description": "Count of assets grouped by entity type across the whole account", | ||
| "tags": ["Assets"], | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1000 | ||
| }, | ||
| "postRequestScript": "assetsByEntityTypeGlobal.js", | ||
| "paging": { | ||
| "mode": "token", | ||
| "in": { "realm": "payload", "path": "continuationToken" }, | ||
| "out": { "realm": "body", "path": "continuationToken" } | ||
| } | ||
| }, | ||
| "matches": "none", | ||
| "metadata": [ | ||
| { "name": "entityType", "displayName": "Entity Type", "role": "label" }, | ||
| { "name": "count", "displayName": "Assets", "shape": "number" } | ||
| ], | ||
| "timeframes": false, | ||
| "defaultShaping": { "sort": { "by": [["count", "desc"]] } } | ||
| } |
36 changes: 36 additions & 0 deletions
36
plugins/MicrosoftPurview/v1/dataStreams/classificationCoverage.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "name": "classificationCoverage", | ||
| "displayName": "Classification Coverage", | ||
| "description": "Count of assets carrying each classification across the whole account", | ||
| "tags": ["Classifications"], | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1000 | ||
| }, | ||
| "postRequestScript": "classificationCoverage.js", | ||
| "paging": { | ||
| "mode": "token", | ||
| "in": { "realm": "payload", "path": "continuationToken" }, | ||
| "out": { "realm": "body", "path": "continuationToken" } | ||
| } | ||
| }, | ||
| "matches": "none", | ||
| "metadata": [ | ||
| { "name": "classification", "displayName": "Classification", "role": "label" }, | ||
| { "name": "assets", "displayName": "Assets", "shape": "number" }, | ||
| { | ||
| "name": "coverage", | ||
| "displayName": "% of Total Assets", | ||
| "shape": ["percent", { "asZeroToOne": true, "decimalPlaces": 1 }] | ||
| } | ||
| ], | ||
| "timeframes": false, | ||
| "defaultShaping": { "sort": { "by": [["assets", "desc"]] } } | ||
| } |
27 changes: 27 additions & 0 deletions
27
plugins/MicrosoftPurview/v1/dataStreams/classificationTypes.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "name": "classificationTypes", | ||
| "displayName": "Classification Types", | ||
| "description": "All classification type definitions in the Purview account", | ||
| "tags": ["Classifications"], | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "endpointPath": "datamap/api/atlas/v2/types/typedefs", | ||
| "getArgs": [ | ||
| { "key": "type", "value": "CLASSIFICATION" } | ||
| ], | ||
| "postRequestScript": "classificationTypes.js" | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| }, | ||
| "matches": "none", | ||
| "metadata": [ | ||
| { "name": "name", "displayName": "Classification", "role": "label" }, | ||
| { "name": "description", "displayName": "Description" }, | ||
| { "name": "category", "displayName": "Category" }, | ||
| { "name": "typeVersion", "displayName": "Version" }, | ||
| { "name": "superTypes", "displayName": "Super Types" }, | ||
| { "name": "createdBy", "displayName": "Created By" }, | ||
| { "name": "createTime", "displayName": "Created", "shape": "date" }, | ||
| { "name": "guid", "displayName": "GUID", "shape": "guid", "visible": false } | ||
| ], | ||
| "timeframes": false | ||
| } | ||
34 changes: 34 additions & 0 deletions
34
plugins/MicrosoftPurview/v1/dataStreams/collectionClassificationSummary.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| { | ||
| "name": "collectionClassificationSummary", | ||
| "displayName": "Classification Summary", | ||
| "description": "Classified vs unclassified asset counts for the selected collection", | ||
| "tags": ["Classifications"], | ||
| "baseDataSourceName": "httpRequestScopedSingle", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1000, | ||
| "filter": { | ||
| "collectionId": "{{object.collectionName}}" | ||
| } | ||
| }, | ||
| "paging": { | ||
| "mode": "token", | ||
| "in": { "realm": "payload", "path": "continuationToken" }, | ||
| "out": { "realm": "body", "path": "continuationToken" } | ||
| }, | ||
| "postRequestScript": "collectionClassificationSummary.js" | ||
| }, | ||
| "matches": { "sourceType": { "type": "oneOf", "values": ["Purview Collection"] } }, | ||
| "metadata": [ | ||
| { "name": "state", "displayName": "State", "shape": ["state", { "map": { "success": ["Classified"], "warning": ["Unclassified"] } }] }, | ||
| { "name": "label", "displayName": "Category", "role": "label" }, | ||
| { "name": "assets", "displayName": "Assets", "shape": "number", "role": "value" } | ||
| ], | ||
| "timeframes": false | ||
| } |
35 changes: 35 additions & 0 deletions
35
plugins/MicrosoftPurview/v1/dataStreams/collectionClassifiedAssets.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "name": "collectionClassifiedAssets", | ||
| "displayName": "Classified Assets", | ||
| "description": "Assets with classifications in the selected collection, one row per asset-classification pair", | ||
| "tags": ["Classifications"], | ||
| "baseDataSourceName": "httpRequestScopedSingle", | ||
| "config": { | ||
| "httpMethod": "post", | ||
| "endpointPath": "datamap/api/search/query", | ||
| "getArgs": [ | ||
| { "key": "api-version", "value": "2023-09-01" } | ||
| ], | ||
| "postBody": { | ||
| "keywords": null, | ||
| "limit": 1000, | ||
| "filter": { | ||
| "collectionId": "{{object.collectionName}}" | ||
| } | ||
| }, | ||
| "paging": { | ||
| "mode": "token", | ||
| "in": { "realm": "payload", "path": "continuationToken" }, | ||
| "out": { "realm": "body", "path": "continuationToken" } | ||
| }, | ||
| "postRequestScript": "collectionClassifiedAssets.js" | ||
| }, | ||
| "matches": { "sourceType": { "type": "oneOf", "values": ["Purview Collection"] } }, | ||
| "metadata": [ | ||
| { "name": "assetName", "displayName": "Asset", "role": "label" }, | ||
| { "name": "entityType", "displayName": "Entity Type" }, | ||
| { "name": "collectionId", "displayName": "Collection", "visible": false }, | ||
| { "name": "classification", "displayName": "Classification" } | ||
| ], | ||
| "timeframes": false | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.