You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/purview/tutorial-azure-purview-tools.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,23 @@ ms.author: arindamba
6
6
ms.service: purview
7
7
ms.subservice: purview-data-catalog
8
8
ms.topic: tutorial
9
-
ms.date: 10/10/2021
9
+
ms.date: 12/07/2022
10
10
# Customer Intent: As a Microsoft Purview administrator, I want to kickstart and be up and running with Microsoft Purview service in a matter of minutes; additionally, I want to perform and set up automations, batch-mode API executions and scripts that help me run Microsoft Purview smoothly and effectively for the long-term on a regular basis.
11
11
---
12
12
13
13
# Microsoft Purview governance services open-source tools and utilities
14
14
15
15
This article lists several open-source tools and utilities (command-line, python, and PowerShell interfaces) that help you get started quickly with Microsoft Purview governance services, like Microsoft Purview Data Map, Data Catalog, and Data Estate Insights in a matter of minutes! These tools have been authored & developed by collective effort of the Microsoft Purview Product Group and the open-source community. The objective of such tools is to make learning, starting up, regular usage, and long-term adoption of Microsoft Purview fast and easy.
16
16
17
-
###Intended audience
17
+
## Intended audience
18
18
19
19
- Microsoft Purview community including customers, developers, ISVs, partners, evangelists, and enthusiasts.
20
20
21
21
- The Microsoft Purview Data Catalog is based on [Apache Atlas](https://atlas.apache.org/) and extends full support for Apache Atlas APIs. We welcome Apache Atlas community, enthusiasts, and developers to wholeheartedly build on and evangelize Microsoft Purview.
22
22
23
-
###Microsoft Purview customer journey stages
23
+
## Microsoft Purview customer journey stages
24
24
25
-
-*Microsoft Purview Learners*: Learners who are starting fresh with Microsoft Purview governance services and are keen to understand and explore how a multi-cloud unified data governance solution works. A section of learners includes users who want to compare and contrast Microsoft Purview with other competing solutions in the data governance market and try it before adopting for long-term usage.
25
+
-*Microsoft Purview Learners*: Learners who are starting fresh with Microsoft Purview governance services and are keen to understand and explore how a multicloud unified data governance solution works. A section of learners includes users who want to compare and contrast Microsoft Purview with other competing solutions in the data governance market and try it before adopting for long-term usage.
26
26
27
27
-*Microsoft Purview Innovators*: Innovators who are keen to understand existing and latest features, ideate, and conceptualize features upcoming on Microsoft Purview. They're adept at building and developing solutions for customers, and have futuristic forward-looking ideas for the next-gen cutting-edge data governance product.
Copy file name to clipboardExpand all lines: articles/purview/tutorial-metadata-policy-collections-apis.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ ms.author: arindamba
6
6
ms.service: purview
7
7
ms.subservice: purview-data-catalog
8
8
ms.topic: tutorial
9
-
ms.date: 09/24/2021
9
+
ms.date: 12/07/2022
10
10
# Customer intent: As a Microsoft Purview collection administrator, I want to manage collections and control access to each collection in the Microsoft Purview account by adding or removing users, groups, or service principals via the REST API interface.
11
11
---
12
12
13
-
# Tutorial: Use REST APIs to manage role-based access control on Microsoft Purview collections
13
+
# Tutorial: Use REST APIs to manage role-based access control on Microsoft Purview collections
14
14
15
15
In August 2021, access control in Microsoft Purview moved from Azure Identity & Access Management (IAM) (control plane) to [Microsoft Purview collections](how-to-create-and-manage-collections.md) (data plane). This change gives enterprise data curators and administrators more precise, granular access control on their data sources scanned by Microsoft Purview. The change also enables organizations to audit right access and right use of their data.
16
16
@@ -19,40 +19,41 @@ This tutorial guides you through step-by-step usage of the Microsoft Purview Met
19
19
For more information about the built-in roles in Microsoft Purview, see the [Microsoft Purview permissions guide](catalog-permissions.md#roles). The guide maps the roles to the level of access permissions that are granted to users.
20
20
21
21
## Metadata Policy API Reference summary
22
+
22
23
The following table gives an overview of the [Microsoft Purview Metadata Policy API Reference](/rest/api/purview/metadatapolicydataplane/Metadata-Policy).
23
24
24
25
> [!NOTE]
25
26
> Replace {pv-acc-name} with the name of your Microsoft Purview account before running these APIs. For instance, if your Microsoft Purview account name is *FabrikamPurviewAccount*, your API endpoints will become *FabrikamPurviewAccount.purview.azure.com*. The "api-version" parameter is subject to change. Please refer the [Microsoft Purview Metadata policy REST API documentation](/rest/api/purview/metadatapolicydataplane/Metadata-Policy) for the latest "api-version" and the API signature.
| Read All Metadata Roles| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataroles?&api-version=2021-07-01| Reads all metadata roles from your Microsoft Purview account.|
30
-
| Read Metadata Policy By Collection Name| GET| https://{pv-acc-name}.purview.azure.com /policystore/collections/{collectionName}/metadataPolicy?&api-version=2021-07-01| Reads the metadata policy by using a specified collection name (the 6-character random name that's generated by Microsoft Purview when it creates the policy).|
31
+
| Read Metadata Policy By Collection Name| GET| https://{pv-acc-name}.purview.azure.com /policystore/collections/{collectionName}/metadataPolicy?&api-version=2021-07-01| Reads the metadata policy by using a specified collection name (the six character random name that's generated by Microsoft Purview when it creates the policy).|
31
32
| Read Metadata Policy By PolicyID| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version=2021-07-01| Reads the metadata policy by using a specified policy ID. The policy ID is in GUID format.|
32
33
| Read All Metadata Policies| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies?&api-version=2021-07-01| Reads all metadata policies from your Microsoft Purview account. You can pick a certain policy to work with from the JSON output list that's generated by this API.|
33
34
| Update/PUT Metadata Policy| PUT| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version=2021-07-01| Updates the metadata policy by using a specified policy ID. The policy ID is in GUID format.|
34
35
|||
35
36
36
37
## Microsoft Purview catalog collections API reference summary
38
+
37
39
The following table gives an overview of the Microsoft Purview collections APIs. For complete documentation about each API, select the API operation in the left column.
38
40
39
41
| Operation | Description |
40
-
|:-|:- |
42
+
|---|--- |
41
43
|[Create or update collection](/rest/api/purview/accountdataplane/collections/create-or-update-collection)| Creates or updates a collection entity. |
42
44
|[Delete collection](/rest/api/purview/accountdataplane/collections/delete-collection)| Deletes a collection entity. |
43
45
|[Get collection](/rest/api/purview/accountdataplane/collections/get-collection)| Gets a collection.|
44
46
|[Get collection path](/rest/api/purview/accountdataplane/collections/get-collection-path)| Gets the parent name and display name chains that represent the collection path.|
45
47
|[List child collection names](/rest/api/purview/accountdataplane/collections/list-child-collection-names)| Lists the child collections names in the collection.|
46
48
|[List collections](/rest/api/purview/accountdataplane/collections/list-collections)| Lists the collections in the account.|
47
49
48
-
49
50
- If you're using the API, the service principal, user, or group that executes the API should have a [Collection Admin](how-to-create-and-manage-collections.md#check-permissions) role assigned in Microsoft Purview to execute this API successfully.
50
51
51
-
- For all Microsoft Purview APIs that require {collectionName}, you will need to use *"name"* (and not *"friendlyName"*). Replace {collectionName} with the actual six-character alphanumeric collection name string.
52
+
- For all Microsoft Purview APIs that require {collectionName}, you'll need to use *"name"* (and not *"friendlyName"*). Replace {collectionName} with the actual six-character alphanumeric collection name string.
52
53
> [!NOTE]
53
54
> This name is different from the friendly display name you supplied when you created the collection. If you don't have {collectionName} handy, use the [List Collections API](/rest/api/purview/accountdataplane/collections/list-collections) to select the six-character collection name from the JSON output.
54
55
55
-
Here is an example JSON file:
56
+
Here's an example JSON file:
56
57
57
58
```json
58
59
{
@@ -105,7 +106,7 @@ The output JSON will describe the roles and their associated permissions in this
105
106
The default metadata roles are listed in the following table:
106
107
107
108
| Role ID | Permissions | Role description |
108
-
|:-|:-|:- |
109
+
|---|---|--- |
109
110
| purviewmetadatarole\_builtin\_data-source-administrator| Microsoft.Purview/accounts/scan/read Microsoft.Purview/accounts/scan/write Microsoft.Purview/accounts/collection/read| Grants access to others to read, write collection, register data sources, and trigger scans.|
110
111
| purviewmetadatarole\_builtin\_collection-administrator| Microsoft.Purview/accounts/collection/read Microsoft.Purview/accounts/collection/write| Administrator-level full access to the entire collection, including add or remove users and service principal names (SPNs) from the collection, management rights, and grant or revoke access. In some cases, the Collection Administrator might be different from the creator of the collection.|
111
112
| purviewmetadatarole\_builtin\_purview-reader| Microsoft.Purview/accounts/data/read Microsoft.Purview/accounts/collection/read| Grants only read access to data handling and all metadata, including classifications, sensitivity labels, insights, and read assets in a collection, except scan bindings.|
@@ -937,7 +938,7 @@ To run the preceding command, you need only to pass the new Root Collection Admi
937
938
> [!NOTE]
938
939
> Users who call this API must have Owner or User Account and Authentication (UAA) permissions on the Microsoft Purview account to execute a write action on the account.
939
940
940
-
## Additional resources
941
+
## More resources
941
942
942
943
You may choose to execute Microsoft Purview REST APIs by using the [PowerShell utility](https://aka.ms/purview-api-ps). It can be readily installed from PowerShell Gallery. With this utility, you can execute all the same commands, but from Windows PowerShell.
0 commit comments