Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Hinweis
Microsoft Purview Data Catalog (klassisch), Data Health Insights (klassisch) und Purview-Workflow (klassisch) nehmen keine neuen Kunden mehr an, und diese Dienste, zuvor Azure Purview, befinden sich jetzt im Kundensupportmodus.
Im August 2021 wurde die Zugriffssteuerung in Microsoft Purview von Azure Identity & Access Management (IAM) (Steuerungsebene) in Microsoft Purview-Sammlungen (Datenebene) verschoben. Diese Änderung ermöglicht den Kuratoren und Administratoren von Unternehmensdaten eine präzisere und präzisere Zugriffskontrolle auf ihre Datenquellen, die von Microsoft Purview gescannt wurden. Die Änderung ermöglicht es Organisationen auch, den richtigen Zugriff und die richtige Verwendung ihrer Daten zu überwachen.
Dieses Lernprogramm führt Sie Schritt für Schritt durch die Verwendung der Microsoft Purview-Metadatenrichtlinien-APIs, die Ihnen helfen, Benutzer, Gruppen oder Dienstprinzipale zu einer Sammlung hinzuzufügen und ihre Rollen innerhalb dieser Sammlung zu verwalten oder zu entfernen. REST-APIs sind eine alternative Methode zur Verwendung des Azure-Portals oder des Microsoft Purview-Governanceportals, um die gleiche präzise rollenbasierte Zugriffssteuerung zu erreichen.
Weitere Informationen zu den integrierten Rollen in Microsoft Purview finden Sie im Leitfaden zu Microsoft Purview-Berechtigungen. Das Handbuch ordnet die Rollen der Zugriffsebene zu, die Benutzern gewährt wird.
Zusammenfassung der Referenz zur Metadatenrichtlinien-API
Die folgende Tabelle enthält eine Übersicht über die API-Referenz für Microsoft Purview-Metadatenrichtlinien.
Hinweis
Ersetzen Sie {pv-acc-name} durch den Namen Ihres Microsoft Purview-Kontos, bevor Sie diese APIs ausführen. Wenn Ihr Microsoft Purview-Kontoname instance FabrikamPurviewAccount lautet, werden Ihre API-Endpunkte FabrikamPurviewAccount.purview.azure.com. Der Parameter "api-version" kann sich ändern. Die neueste "API-Version" und die API-Signatur finden Sie in der Dokumentation der Microsoft Purview-Metadatenrichtlinie .
| API-Funktion | REST-Methode | API-Endpunkt | Beschreibung |
|---|---|---|---|
| Alle Metadatenrollen lesen | GET | https://{pv-acc-name}.purview.azure.com /policystore/metadataroles?&api-version=2021-07-01 | Liest alle Metadatenrollen aus Ihrem Microsoft Purview-Konto. |
| Metadatenrichtlinie nach Sammlungsname lesen | GET | https://{pv-acc-name}.purview.azure.com /policystore/collections/{collectionName}/metadataPolicy?&api-version=2021-07-01 | Liest die Metadatenrichtlinie unter Verwendung eines angegebenen Sammlungsnamens (der zufällige Name aus sechs Zeichen, der von Microsoft Purview beim Erstellen der Richtlinie generiert wird). |
| Metadatenrichtlinie nach PolicyID lesen | GET | https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version=2021-07-01 | Liest die Metadatenrichtlinie unter Verwendung einer angegebenen Richtlinien-ID. Die Richtlinien-ID hat das GUID-Format. |
| Alle Metadatenrichtlinien lesen | GET | https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies?&api-version=2021-07-01 | Liest alle Metadatenrichtlinien aus Ihrem Microsoft Purview-Konto. Sie können eine bestimmte Richtlinie aus der JSON-Ausgabeliste auswählen, die von dieser API generiert wird. |
| Richtlinie zum Aktualisieren/Einfügen von Metadaten | PUT | https://{pv-acc-name}.purview.azure.com /policystore/metadataPolicies/{policyId}?&api-version=2021-07-01 | Updates der Metadatenrichtlinie mithilfe einer angegebenen Richtlinien-ID. Die Richtlinien-ID hat das GUID-Format. |
Zusammenfassung der Referenz zur Microsoft Purview-Katalogsammlungen
Die folgende Tabelle enthält eine Übersicht über die Microsoft Purview-Sammlungs-APIs. Um eine vollständige Dokumentation zu jeder API zu erhalten, wählen Sie den API-Vorgang in der linken Spalte aus.
| Vorgang | Beschreibung |
|---|---|
| Sammlung erstellen oder aktualisieren | Erstellt oder aktualisiert eine Sammlungsentität. |
| Sammlung löschen | Löscht eine Sammlungsentität. |
| Sammlung abrufen | Ruft eine Sammlung ab. |
| Abrufen des Sammlungspfads | Ruft den übergeordneten Namen und die Anzeigenamenketten ab, die den Sammlungspfad darstellen. |
| Auflisten der Namen untergeordneter Sammlungen | Listet die Namen der untergeordneten Sammlungen in der Sammlung auf. |
| Auflisten von Sammlungen | Listet die Sammlungen im Konto auf. |
Wenn Sie die API verwenden, sollte dem Dienstprinzipal, Benutzer oder der Gruppe, der bzw. der die API ausführt, eine Sammlungs-Admin-Rolle in Microsoft Purview zugewiesen sein, damit diese API erfolgreich ausgeführt werden kann.
Für alle Microsoft Purview-APIs, die {collectionName} erfordern, müssen Sie "name" (und nicht "friendlyName") verwenden. Ersetzen Sie {collectionName} durch die tatsächliche sechsstellige alphanumerische Zeichenfolge für den Sammlungsnamen.
Hinweis
Dieser Name unterscheidet sich von dem Anzeigenamen, den Sie beim Erstellen der Sammlung angegeben haben. Wenn Sie {collectionName} nicht zur Hand haben, verwenden Sie die List Collections-API , um den sechsstelligen Sammlungsnamen aus der JSON-Ausgabe auszuwählen.
Hier ist eine JSON-Beispieldatei:
{
"name": "74dhe7",
"friendlyName": "Friendly Name",
"parentCollection": {
"type": "CollectionReference",
"referenceName": "{your_purview_account_name}"
},
"systemData": {
"createdBy": "{guid}",
"createdByType": "Application",
"createdAt": "2021-08-26T21:21:51.2646627Z",
"lastModifiedBy": "7f8d47e2-330c-42f0-8744-fcfb1ecb3ea0",
"lastModifiedByType": "Application",
"lastModifiedAt": "2021-08-26T21:21:51.2646628Z"
},
"collectionProvisioningState": "Succeeded"
}
Richtlinien-JSON-Beschreibung
Hier sind einige der wichtigen Bezeichner in der JSON-Ausgabe, die von den Sammlungs-APIs empfangen wird:
Name: Der Name der Richtlinie.
ID: Der eindeutige Bezeichner für die Richtlinie.
Version: Die neueste Versionsnummer der Richtlinie.
Wichtig
Die Versionsnummer wird bei jedem Aufruf der Update-Metadata-Policy-API erhöht. Stellen Sie sicher, dass Sie die neueste Kopie der Richtlinie abrufen, indem Sie die Get-Policy-by-Policy-ID-API aufrufen. Führen Sie diese Aktualisierung jedes Mal durch, bevor Sie die Update Policy (PUT)-API aufrufen, damit Sie immer über die neueste Version der JSON-Datei verfügen.
DecisionRules: Listen Sie die Regeln und Auswirkungen dieser Richtlinie auf. Bei Metadatenrichtlinien ist der Effekt immer "Zulassen".
Hinzufügen oder Entfernen von Benutzern aus einer Sammlung oder Rolle
Verwenden Sie Microsoft Purview-REST-APIs, um einen Benutzer, eine Gruppe oder einen Dienstprinzipal zu einer Sammlung oder Rolle hinzuzufügen oder daraus zu entfernen. Eine detaillierte API-Verwendung wird zusammen mit JSON-Beispielausgaben bereitgestellt. Es wird dringend empfohlen, die Anweisungen in den nächsten Abschnitten der Reihe nach zu befolgen, um die Microsoft Purview-Metadatenrichtlinien-APIs optimal zu verstehen.
Abrufen aller Metadatenrollen
Um alle verfügbaren Rollen für die Zugriffsberechtigung für Metadaten aufzulisten, führen Sie je nach verwendetem Portal einen der folgenden Befehle aus:
Klassisches Microsoft Purview-Governanceportal:
GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataroles?api-version=2021-07-01
Neues Microsoft Purview-Portal:
GET https://api.purview-service.microsoft.com/policystore/metadataroles?api-version=2021-07-01
Der JSON-Ausgabecode beschreibt die Rollen und die zugehörigen Berechtigungen in diesem Format.
In der folgenden Tabelle sind die Standard-Metadatenrollen aufgeführt:
| Rollen-ID | Berechtigungen | Rollenbeschreibung |
|---|---|---|
| purviewmetadatarole_builtin_data-source-administrator | Microsoft.Purview/accounts/scan/read Microsoft.Purview/accounts/scan/write Microsoft.Purview/accounts/collection/read | Gewährt anderen Benutzern Zugriff zum Lesen, Schreiben, Registrieren von Datenquellen und Auslösen von Scans. |
| purviewmetadatarole_builtin_collection-Administrator | Microsoft.Purview/accounts/collection/read Microsoft.Purview/accounts/collection/write | Vollzugriff auf Administratorebene auf die gesamte Sammlung, einschließlich Hinzufügen oder Entfernen von Benutzern und Dienstprinzipalnamen (Service Principal Names, SPNs) aus der Sammlung, Verwaltungsrechten und Gewähren oder Widerrufen des Zugriffs. In einigen Fällen kann sich der Sammlungsadministrator vom Ersteller der Sammlung unterscheiden. |
| purviewmetadatarole_builtin_purview-Reader | Microsoft.Purview/accounts/data/read Microsoft.Purview/accounts/collection/read | Gewährt nur Lesezugriff auf die Datenverarbeitung und alle Metadaten, einschließlich Klassifizierungen, Vertraulichkeitsbezeichnungen, Erkenntnisse und Leseressourcen in einer Sammlung, mit Ausnahme von Scanbindungen. |
| purviewmetadatarole_builtin_data-Kurator | Microsoft.Purview/accounts/data/read Microsoft.Purview/accounts/data/write Microsoft.Purview/accounts/collection/read | Gewährt Vollzugriff auf die Datenverarbeitung und alle Metadaten, einschließlich Klassifizierungen, Vertraulichkeitsbezeichnungen, Erkenntnisse und Leseressourcen in einer Sammlung, mit Ausnahme von Scanbindungen. |
| purviewmetadatarole_builtin_data-share-Mitwirkender | Microsoft.Purview/accounts/share/read Microsoft.Purview/accounts/share/write | Gewährt Zugriff auf Datenfreigaben als Mitwirkender. |
{
"values": [
{
"id": "purviewmetadatarole_builtin_data-curator",
"name": "data-curator",
"type": "Microsoft.Purview/role",
"properties": {
"provisioningState": "Provisioned",
"roleType": "BuiltIn",
"friendlyName": "Data Curator",
"cnfCondition": [
[
{
"attributeName": "request.azure.dataAction",
"attributeValueIncludedIn": [
"Microsoft.Purview/accounts/data/read",
"Microsoft.Purview/accounts/data/write",
"Microsoft.Purview/accounts/collection/read"
]
}
]
],
"version": 1
}
},
{
"id": "purviewmetadatarole_builtin_data-source-administrator",
"name": "data-source-administrator",
"type": "Microsoft.Purview/role",
"properties": {
"provisioningState": "Provisioned",
"roleType": "BuiltIn",
"friendlyName": "Data Source Administrator",
"cnfCondition": [
[
{
"attributeName": "request.azure.dataAction",
"attributeValueIncludedIn": [
"Microsoft.Purview/accounts/scan/read",
"Microsoft.Purview/accounts/scan/write",
"Microsoft.Purview/accounts/collection/read"
]
}
]
],
"version": 1
}
},
{
"id": "purviewmetadatarole_builtin_collection-administrator",
"name": "collection-administrator",
"type": "Microsoft.Purview/role",
"properties": {
"provisioningState": "Provisioned",
"roleType": "BuiltIn",
"friendlyName": "Collection Administrator",
"cnfCondition": [
[
{
"attributeName": "request.azure.dataAction",
"attributeValueIncludedIn": [
"Microsoft.Purview/accounts/collection/read",
"Microsoft.Purview/accounts/collection/write"
]
}
]
],
"version": 1
}
},
{
"id": "purviewmetadatarole_builtin_purview-reader",
"name": "purview-reader",
"type": "Microsoft.Purview/role",
"properties": {
"provisioningState": "Provisioned",
"roleType": "BuiltIn",
"friendlyName": "Microsoft Purview Reader",
"cnfCondition": [
[
{
"attributeName": "request.azure.dataAction",
"attributeValueIncludedIn": [
"Microsoft.Purview/accounts/data/read",
"Microsoft.Purview/accounts/collection/read"
]
}
]
],
"version": 1
}
},
{
"id": "purviewmetadatarole_builtin_data-share-contributor",
"name": "data-share-contributor",
"type": "Microsoft.Purview/role",
"properties": {
"provisioningState": "Provisioned",
"roleType": "BuiltIn",
"friendlyName": "Data share contributor",
"cnfCondition": [
[
{
"attributeName": "request.azure.dataAction",
"attributeValueIncludedIn": [
"Microsoft.Purview/accounts/share/read",
"Microsoft.Purview/accounts/share/write"
]
}
]
],
"version": 1
}
}
]
}
Abrufen aller Metadatenrichtlinien
Klassisches Microsoft Purview-Governanceportal:
GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies?api-version=2021-07-01
Neues Microsoft Purview-Portal:
GET https://api.purview-service.microsoft.com/policystore/metadataPolicies?api-version=2021-07-01
Der vorhergehende Befehl listet alle verfügbaren Metadatenrichtlinien in der gesamten Sammlungshierarchie im Strukturformat auf, von der Stammsammlung oben bis zu allen untergeordneten Richtlinien. Jede untergeordnete Sammlung enthält jedes der nächsthöheren untergeordneten Elemente.
Beispiel:
{
"values": [
{
"name": "policy_FabrikamPurview",
"id": "9b2f1cb9-584c-4a16-811e-9232884b5cac",
"version": 30,
"properties": {
"description": "",
"decisionRules": [
{
"kind": "decisionrule",
"effect": "Permit",
"dnfCondition": [
[
{
"attributeName": "resource.purview.collection",
"attributeValueIncludes": "fabrikampurview"
},
{
"fromRule": "permission:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:fabrikampurview"
}
]
]
}
],
"attributeRules": [
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview",
"name": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0",
"04314867-60a4-4e5a-ae16-8e5856f415d9",
"8988fe5c-5736-4179-9435-0a64c273b90b",
"6d563253-1d5b-48f2-baaa-5489f22ddce9",
"26f98046-5b02-4fa9-b709-e0519c658891",
"73fc02dc-becd-468b-a2a3-82238e722dae"
]
},
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
},
{
"attributeName": "principal.microsoft.groups",
"attributeValueIncludedIn": [
"ffd851fa-86ec-431b-95ea-8b84d5012383",
"cf84b126-4384-4952-91f1-7f705b25e569",
"5046aba1-5b81-411c-8fec-b84600f3f08b",
"b055a5c6-a04e-4d1a-8524-001ad81bfb28",
"cc194892-92fa-4ce3-96ae-1f98bef8211c"
]
}
]
]
},
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_data-curator:fabrikampurview",
"name": "purviewmetadatarole_builtin_data-curator:fabrikampurview",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0",
"649f56ab-2dd2-40de-a731-3d3f28e7af92",
"c29a5809-f9ec-49fd-b762-2d4d64abb93e",
"04314867-60a4-4e5a-ae16-8e5856f415d9",
"73fc02dc-becd-468b-a2a3-82238e722dae",
"517a27d2-39ba-4c91-a032-dd9ecf8ad6f1",
"6d563253-1d5b-48f2-baaa-5489f22ddce9"
]
},
{
"fromRule": "purviewmetadatarole_builtin_data-curator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-curator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_data-curator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-curator"
},
{
"attributeName": "principal.microsoft.groups",
"attributeValueIncludedIn": [
"b055a5c6-a04e-4d1a-8524-001ad81bfb28",
"cc194892-92fa-4ce3-96ae-1f98bef8211c",
"5046aba1-5b81-411c-8fec-b84600f3f08b"
]
}
]
]
},
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_data-source-administrator:fabrikampurview",
"name": "purviewmetadatarole_builtin_data-source-administrator:fabrikampurview",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0",
"04314867-60a4-4e5a-ae16-8e5856f415d9",
"517a27d2-39ba-4c91-a032-dd9ecf8ad6f1",
"6d563253-1d5b-48f2-baaa-5489f22ddce9"
]
},
{
"fromRule": "purviewmetadatarole_builtin_data-source-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-source-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_data-source-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-source-administrator"
},
{
"attributeName": "principal.microsoft.groups",
"attributeValueIncludedIn": [
"b055a5c6-a04e-4d1a-8524-001ad81bfb28",
"cc194892-92fa-4ce3-96ae-1f98bef8211c",
"d34eb741-be5e-4098-90d7-eca8d4a5153f",
"664ec992-9af0-4773-88f2-dc39edc46f6f",
"5046aba1-5b81-411c-8fec-b84600f3f08b"
]
}
]
]
},
{
"kind": "attributerule",
"id": "permission:fabrikampurview",
"name": "permission:fabrikampurview",
"dnfCondition": [
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_purview-reader:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_purview-reader:fabrikampurview"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_data-curator:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-curator:fabrikampurview"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_data-source-administrator:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_data-source-administrator:fabrikampurview"
}
]
]
}
],
"collection": {
"type": "CollectionReference",
"referenceName": "fabrikampurview"
}
}
},
{
"name": "policy_b2zpf1",
"id": "12b0bb28-2acc-413e-8fe1-179ff9cc54c3",
"version": 0,
"properties": {
"description": "",
"decisionRules": [
{
"kind": "decisionrule",
"effect": "Permit",
"dnfCondition": [
[
{
"attributeName": "resource.purview.collection",
"attributeValueIncludes": "b2zpf1"
},
{
"fromRule": "permission:b2zpf1",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:b2zpf1"
}
]
]
}
],
"attributeRules": [
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_collection-administrator:b2zpf1",
"name": "purviewmetadatarole_builtin_collection-administrator:b2zpf1",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0"
]
},
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:ukx7pq",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:ukx7pq"
}
]
]
},
{
"kind": "attributerule",
"id": "permission:b2zpf1",
"name": "permission:b2zpf1",
"dnfCondition": [
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:b2zpf1",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:b2zpf1"
}
],
[
{
"fromRule": "permission:ukx7pq",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:ukx7pq"
}
]
]
}
],
"collection": {
"type": "CollectionReference",
"referenceName": "b2zpf1"
},
"parentCollectionName": "ukx7pq"
}
},
{
"name": "policy_7wte2n",
"id": "a72084e4-ccab-4aec-a364-08ab001e4999",
"version": 0,
"properties": {
"description": "",
"decisionRules": [
{
"kind": "decisionrule",
"effect": "Permit",
"dnfCondition": [
[
{
"attributeName": "resource.purview.collection",
"attributeValueIncludes": "7wte2n"
},
{
"fromRule": "permission:7wte2n",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:7wte2n"
}
]
]
}
],
"attributeRules": [
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_collection-administrator:7wte2n",
"name": "purviewmetadatarole_builtin_collection-administrator:7wte2n",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0"
]
},
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:ukx7pq",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:ukx7pq"
}
]
]
},
{
"kind": "attributerule",
"id": "permission:7wte2n",
"name": "permission:7wte2n",
"dnfCondition": [
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:7wte2n",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:7wte2n"
}
],
[
{
"fromRule": "permission:ukx7pq",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:ukx7pq"
}
]
]
}
],
"collection": {
"type": "CollectionReference",
"referenceName": "7wte2n"
},
"parentCollectionName": "ukx7pq"
}
}
]
}
Abrufen der ausgewählten Metadatenrichtlinie
Sie können eine von zwei APIs verwenden, um die JSON-Struktur einer bestimmten Metadatenrichtlinie abzurufen, indem Sie entweder {collectionName} oder {PolicyID} angeben.
Wie in den folgenden beiden Abschnitten beschrieben, dienen beide APIs demselben Zweck, und die JSON-Ausgaben beider sind genau gleich.
Rufen Sie die Metadatenrichtlinie der Sammlung mithilfe des Sammlungsnamens ab
Klassisches Microsoft Purview-Governanceportal:
GET https://{your_purview_account_name}.purview.azure.com/policystore/collections/{collectionName}/metadataPolicy?api-version=2021-07-01
Neues Microsoft Purview-Portal:
GET https://api.purview-service.microsoft.com/policystore/collections/{collectionName}/metadataPolicy?api-version=2021-07-01
Der Microsoft Purview-Kontoname lautet {your_purview_account_name}. Ersetzen Sie ihn durch den Namen Ihres Microsoft Purview-Kontos.
Suchen Sie in der JSON-Ausgabe der vorherigen API "Get All Metadata Policies" nach dem folgenden Abschnitt:
{ "type": "CollectionReference", "referenceName": "7xkdg2"}
Ersetzen Sie "{collectionName}" in der API-URL durch den Wert "referenceName": "{6-char-collection-name}". Wenn Ihr sechsstelliger Sammlungsname beispielsweise "7xkdg2" lautet, wird die API-URL wie folgt formatiert:
https://{your_purview_account_name}.purview.azure.com/policystore/collections/7xkdg2/metadataPolicy?api-version=2021-07-01Führen Sie die folgende API aus:
{ "name": "policy_qu45fs", "id": "aaaabbbb-0000-cccc-1111-dddd2222eeee", "version": 0, "properties": { "description": "", "decisionRules": [ { "kind": "decisionrule", "effect": "Permit", "dnfCondition": [ [ { "attributeName": "resource.purview.collection", "attributeValueIncludes": "qu45fs" }, { "fromRule": "permission:qu45fs", "attributeName": "derived.purview.permission", "attributeValueIncludes": "permission:qu45fs" } ] ] } ], "attributeRules": [ { "kind": "attributerule", "id": "purviewmetadatarole_builtin_collection-administrator:qu45fs", "name": "purviewmetadatarole_builtin_collection-administrator:qu45fs", "dnfCondition": [ [ { "attributeName": "principal.microsoft.id", "attributeValueIncludedIn": [ "2f656762-e440-4b62-9eb6-a991d17d64b0" ] }, { "fromRule": "purviewmetadatarole_builtin_collection-administrator", "attributeName": "derived.purview.role", "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator" } ], [ { "fromRule": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview", "attributeName": "derived.purview.permission", "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview" } ] ] }, { "kind": "attributerule", "id": "permission:qu45fs", "name": "permission:qu45fs", "dnfCondition": [ [ { "fromRule": "purviewmetadatarole_builtin_collection-administrator:qu45fs", "attributeName": "derived.purview.permission", "attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:qu45fs" } ], [ { "fromRule": "permission:fabrikampurview", "attributeName": "derived.purview.permission", "attributeValueIncludes": "permission:fabrikampurview" } ] ] } ], "collection": { "type": "CollectionReference", "referenceName": "qu45fs" }, "parentCollectionName": "fabrikampurview" } }
Rufen Sie die Metadatenrichtlinie der Sammlung mithilfe der Richtlinien-ID ab
Klassisches Microsoft Purview-Governanceportal:
GET https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/{policyId}?api-version=2021-07-01
Neues Microsoft Purview-Portal:
GET https://api.purview-service.microsoft.com/policystore/metadataPolicies/{policyId}?api-version=2021-07-01
Der Microsoft Purview-Kontoname lautet {your_purview_account_name}. Ersetzen Sie ihn durch den Namen Ihres Microsoft Purview-Kontos.
Suchen Sie in der JSON-Ausgabe der vorherigen API "Get All Metadata Policies" nach dem folgenden Abschnitt:
{.... "name": "policy_qu45fs", "id": "{policy-guid}", "version": N ....}
Ersetzen Sie "{policyId}" in der API-URL durch den Wert "id". Wenn Ihre "{policy-guid}" beispielsweise "aaaabbbb-0000-cccc-1111-dddd2222eeee" lautet, wird die API-URL wie folgt formatiert:
https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/aaaabbbb-0000-cccc-1111-dddd2222eeee?api-version=2021-07-01
Führen Sie nun die folgende API aus:
Hinweis
Die Ausgabe dieses API-Aufrufs und die des vorherigen API-Aufrufs sind identisch. Wie bereits erwähnt, können Sie eine der beiden Optionen auswählen.
{
"name": "policy_qu45fs",
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"version": 0,
"properties": {
"description": "",
"decisionRules": [
{
"kind": "decisionrule",
"effect": "Permit",
"dnfCondition": [
[
{
"attributeName": "resource.purview.collection",
"attributeValueIncludes": "qu45fs"
},
{
"fromRule": "permission:qu45fs",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:qu45fs"
}
]
]
}
],
"attributeRules": [
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"name": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0"
]
},
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview"
}
]
]
},
{
"kind": "attributerule",
"id": "permission:qu45fs",
"name": "permission:qu45fs",
"dnfCondition": [
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:qu45fs"
}
],
[
{
"fromRule": "permission:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:fabrikampurview"
}
]
]
}
],
"collection": {
"type": "CollectionReference",
"referenceName": "qu45fs"
},
"parentCollectionName": "fabrikampurview"
}
}
Aktualisieren der Sammlungsrichtlinie
PUT https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/{policyId}?api-version=2021-07-01
In diesem Abschnitt aktualisieren Sie den Richtlinien-JSON-Code, den Sie im vorherigen Schritt abgerufen haben, indem Sie einen Benutzer, eine Gruppe oder einen Dienstprinzipal zur Sammlung hinzufügen oder daraus entfernen. Anschließend übertragen Sie es mithilfe einer PUT-REST-Methode an den Microsoft Purview-Dienst.
Unabhängig davon, ob Sie einen Benutzer, eine Gruppe oder einen Dienstprinzipal hinzufügen oder entfernen, verwenden Sie denselben API-Prozess.
Geben Sie die Benutzer-, Gruppen- oder Dienstprinzipalobjekt-ID {guid} im "attributeValueIncludedIn"-Array des JSON an.
Durchsuchen Sie die JSON-Ausgabe der Get-Policy-by-ID-API nach dem Array "attributeValueIncludedIn" im vorherigen Schritt, und fügen Sie die Benutzer-, Gruppen- oder Dienstprinzipalobjekt-ID im Array hinzu oder entfernen Sie sie. Wenn Sie nicht sicher sind, wie Sie die Objekt-ID des Benutzers, der Gruppe oder des Dienstprinzipals abrufen, lesen Sie Get-MgUser.
Es gibt mehrere Abschnitte in der JSON-Zuordnung für jede der vier Rollen. Verwenden Sie für die Berechtigungsrolle "Sammlungsadministrator" den Abschnitt mit der ID "purviewmetadatarole_builtin_collection-administrator". Verwenden Sie ebenfalls den entsprechenden Abschnitt für die anderen Rollen.
Um den Vorgang zum Hinzufügen/Entfernen besser zu verstehen, untersuchen Sie sorgfältig den Unterschied zwischen der JSON-Ausgabe der vorherigen API und der folgenden Ausgabe. Im JSON nach der folgenden Ausgabe haben wir die Benutzer-ID "aaaabbbb-0000-cccc-1111-dddd2222eeee" als Sammlungsadministrator hinzugefügt.
{
"name": "policy_qu45fs",
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"version": 0,
"properties": {
"description": "",
"decisionRules": [
{
"kind": "decisionrule",
"effect": "Permit",
"dnfCondition": [
[
{
"attributeName": "resource.purview.collection",
"attributeValueIncludes": "qu45fs"
},
{
"fromRule": "permission:qu45fs",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:qu45fs"
}
]
]
}
],
"attributeRules": [
{
"kind": "attributerule",
"id": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"name": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"dnfCondition": [
[
{
"attributeName": "principal.microsoft.id",
"attributeValueIncludedIn": [
"2f656762-e440-4b62-9eb6-a991d17d64b0",
"00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
]
},
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator",
"attributeName": "derived.purview.role",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator"
}
],
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:fabrikampurview"
}
]
]
},
{
"kind": "attributerule",
"id": "permission:qu45fs",
"name": "permission:qu45fs",
"dnfCondition": [
[
{
"fromRule": "purviewmetadatarole_builtin_collection-administrator:qu45fs",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "purviewmetadatarole_builtin_collection-administrator:qu45fs"
}
],
[
{
"fromRule": "permission:fabrikampurview",
"attributeName": "derived.purview.permission",
"attributeValueIncludes": "permission:fabrikampurview"
}
]
]
}
],
"collection": {
"type": "CollectionReference",
"referenceName": "qu45fs"
},
"parentCollectionName": "fabrikampurview"
}
}
Hinzufügen der Rolle "Stammsammlungsadministrator"
Standardmäßig ist der Benutzer, der das Microsoft Purview-Konto erstellt hat, der Stammsammlungsadministrator (d. h. der Administrator der obersten Ebene der Sammlungshierarchie). In einigen Fällen möchte eine organization jedoch den Stammsammlungsadministrator mithilfe der API ändern.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin?api-version=2021-07-01
Zum Ausführen des vorherigen Befehls müssen Sie nur die Objekt-ID des neuen Root Collection-Administrators übergeben. Wie bereits erwähnt, kann die Objekt-ID die eines beliebigen Benutzers, einer Gruppe oder eines Dienstprinzipals sein.
{"objectId": "{guid}"}
Hinweis
Benutzer, die diese API aufrufen, müssen über Besitzer- oder Benutzerkonto- und Authentifizierungsberechtigungen (UAA) für das Microsoft Purview-Konto verfügen, um eine Schreibaktion für das Konto ausführen zu können.
Weitere Ressourcen
Sie können die Microsoft Purview-REST-APIs auch mithilfe des Hilfsprogramms PowerShell ausführen. Es kann direkt aus dem PowerShell-Katalog installiert werden. Mit diesem Hilfsprogramm können Sie dieselben Befehle, jedoch über Windows PowerShell, ausführen.