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
| 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.|
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).|
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.|
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.|
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.|
35
-
|||
30
+
| Read All Metadata Roles| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataroles?&api-version={latest-api-version}^| Reads all metadata roles from your Microsoft Purview account.|
31
+
| Read Metadata Policy By Collection Name| GET| https://{pv-acc-name}.purview.azure.com /policystore/collections/{collectionName}/metadataPolicy?&api-version={latest-api-version}^| 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).|
32
+
| Read Metadata Policy By PolicyID| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version={latest-api-version}^| Reads the metadata policy by using a specified policy ID. The policy ID is in GUID format.|
33
+
| Read All Metadata Policies| GET| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies?&api-version={latest-api-version}^| 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.|
34
+
| Update/PUT Metadata Policy| PUT| https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version={latest-api-version}^| Updates the metadata policy by using a specified policy ID. The policy ID is in GUID format.|
35
+
| ^ Refer the [Microsoft Purview Metadata Policy API Reference](/rest/api/purview/metadatapolicydataplane/Metadata-Policy) for {latest-api-version}
36
+
36
37
37
38
## Microsoft Purview catalog collections API reference summary
38
39
@@ -98,7 +99,7 @@ Use Microsoft Purview REST APIs to add or remove a user, group, or service princ
98
99
To list all the available metadata access permission roles, run the following command:
The preceding command lists all available metadata policies across the entire collections hierarchy in tree format, from the root collection at the top to all its child policies. Each child collection contains each of its next level children.
241
242
@@ -612,7 +613,7 @@ As described in the following two sections, both APIs serve the same purpose, an
612
613
### Get the metadata policy of the collection by using the collection name
1. The Microsoft Purview account name is {your_purview_account_name}. Replace it with your Microsoft Purview account name.
@@ -623,7 +624,7 @@ GET https://{your_purview_account_name}.purview.azure.com/policystore/collection
623
624
624
625
1. Replace "{collectionName}" in the API URL with the value of "referenceName": "{6-char-collection-name}". For example, if your six-character collection name is "7xkdg2," the API URL will be formatted as:
@@ -715,7 +716,7 @@ GET https://{your_purview_account_name}.purview.azure.com/policystore/collection
715
716
### Get the metadata policy of the collection by using the policy ID
716
717
717
718
```ruby
718
-
GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/{policyId}?api-version=2021-07-01
719
+
GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/{policyId}?api-version={latest-api-version}^
719
720
```
720
721
721
722
1. The Microsoft Purview account name is {your_purview_account_name}. Replace it with your Microsoft Purview account name.
@@ -726,7 +727,7 @@ GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataPo
726
727
727
728
1. Replace "{policyId}" in the API URL with the value of "id". For example, if your "{policy-guid}" is "c6639bb2-9c41-4be0-912b-775750e725de," the API URL will be formatted as:
In this section, you update the policy JSON that you obtained in the preceding step by adding or removing a user, group, or service principal from the collection. You then push it to the Microsoft Purview service by using a PUT REST method.
@@ -927,7 +928,7 @@ Whether you're adding or removing a user, group, or service principal, you'll fo
927
928
By default, the user who created the Microsoft Purview account is the Root Collection Administrator (that is, the administrator of the topmost level of the collection hierarchy). However, in some cases, an organization may want to change the Root Collection Administrator using the API.
To run the preceding command, you need only to pass the new Root Collection Administrator's object ID. As we mentioned before, the object ID can be that of any user, group, or service principal.
0 commit comments