Skip to content

Commit 8abf951

Browse files
committed
Review
1 parent 6206ef8 commit 8abf951

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

articles/purview/tutorial-metadata-policy-collections-apis.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ ms.author: arindamba
66
ms.service: purview
77
ms.subservice: purview-data-catalog
88
ms.topic: tutorial
9-
ms.date: 09/24/2021
9+
ms.date: 12/07/2022
1010
# 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.
1111
---
1212

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
1414

1515
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.
1616

@@ -19,40 +19,41 @@ This tutorial guides you through step-by-step usage of the Microsoft Purview Met
1919
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.
2020

2121
## Metadata Policy API Reference summary
22+
2223
The following table gives an overview of the [Microsoft Purview Metadata Policy API Reference](/rest/api/purview/metadatapolicydataplane/Metadata-Policy).
2324

2425
> [!NOTE]
2526
> 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.
2627
2728
| API function | REST method | API endpoint | Description |
28-
| :- | :- | :- | :- |
29+
| --- | --- | --- | --- |
2930
| 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).|
3132
| 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.|
3233
| 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.|
3334
| 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.|
3435
| | |
3536

3637
## Microsoft Purview catalog collections API reference summary
38+
3739
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.
3840

3941
| Operation | Description |
40-
| :- | :- |
42+
| --- | --- |
4143
| [Create or update collection](/rest/api/purview/accountdataplane/collections/create-or-update-collection) | Creates or updates a collection entity. |
4244
| [Delete collection](/rest/api/purview/accountdataplane/collections/delete-collection) | Deletes a collection entity. |
4345
| [Get collection](/rest/api/purview/accountdataplane/collections/get-collection) | Gets a collection.|
4446
| [Get collection path](/rest/api/purview/accountdataplane/collections/get-collection-path) | Gets the parent name and display name chains that represent the collection path.|
4547
| [List child collection names](/rest/api/purview/accountdataplane/collections/list-child-collection-names) | Lists the child collections names in the collection.|
4648
| [List collections](/rest/api/purview/accountdataplane/collections/list-collections) | Lists the collections in the account.|
4749

48-
4950
- 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.
5051

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.
5253
> [!NOTE]
5354
> 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.
5455
55-
Here is an example JSON file:
56+
Here's an example JSON file:
5657

5758
```json
5859
{
@@ -105,7 +106,7 @@ The output JSON will describe the roles and their associated permissions in this
105106
The default metadata roles are listed in the following table:
106107

107108
| Role ID | Permissions | Role description |
108-
| :- | :- | :- |
109+
| --- | --- | --- |
109110
| 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.|
110111
| 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.|
111112
| 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
937938
> [!NOTE]
938939
> 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.
939940
940-
## Additional resources
941+
## More resources
941942

942943
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.
943944

0 commit comments

Comments
 (0)