OneLake Data Access Security - List Data Access Roles
Gibt eine Liste von OneLake-Rollen zurück.
Note
Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.
Erforderliche delegierte Bereiche
OneLake.Read.All oder OneLake.ReadWrite.All
Von Microsoft Entra unterstützte Identitäten
Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.
| Identity | Support |
|---|---|
| User | Yes |
| Service Principal und Verwaltete Identitäten | Yes |
Interface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles?continuationToken={continuationToken}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
Die ID des Fabric-Elements, um die Rollen zu platzieren. |
|
workspace
|
path | True |
string (uuid) |
Die Arbeitsbereichs-ID. |
|
continuation
|
query |
string |
Ein Token zum Abrufen der nächsten Seite mit Ergebnissen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung wurde erfolgreich abgeschlossen. Header Etag: string |
|
| Other Status Codes |
Häufige Fehlercodes:
|
Beispiele
| List data access roles multiple pages example |
| List data access roles single page example |
| List data access roles with constraints example |
| List default data access roles example |
List data access roles multiple pages example
Beispielanforderung
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles
Beispiel für eine Antwort
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
"value": [
{
"name": "default_role_1",
"decisionRules": [
{
"effect": "Permit",
"permission": [
{
"attributeName": "Path",
"attributeValueIncludedIn": [
"*"
]
},
{
"attributeName": "Action",
"attributeValueIncludedIn": [
"Read"
]
}
]
}
],
"members": {
"fabricItemMembers": [
{
"itemAccess": [
"ReadAll"
],
"sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
}
],
"continuationToken": "LDEsMTAwMDAwLDA%3D",
"continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles?continuationToken=LDEsMTAwMDAwLDA%3D"
}
List data access roles single page example
Beispielanforderung
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles
Beispiel für eine Antwort
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
"value": [
{
"name": "default_role_1",
"decisionRules": [
{
"effect": "Permit",
"permission": [
{
"attributeName": "Path",
"attributeValueIncludedIn": [
"*"
]
},
{
"attributeName": "Action",
"attributeValueIncludedIn": [
"Read"
]
}
]
}
],
"members": {
"fabricItemMembers": [
{
"itemAccess": [
"ReadAll"
],
"sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
}
]
}
List data access roles with constraints example
Beispielanforderung
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles
Beispiel für eine Antwort
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
"value": [
{
"name": "DefaultReader",
"decisionRules": [
{
"effect": "Permit",
"permission": [
{
"attributeName": "Path",
"attributeValueIncludedIn": [
"*"
]
},
{
"attributeName": "Action",
"attributeValueIncludedIn": [
"Read"
]
}
],
"constraints": {
"columns": [
{
"tablePath": "/Tables/industrytable",
"columnNames": [
"Industry"
],
"columnEffect": "Permit",
"columnAction": [
"Read"
]
}
],
"rows": [
{
"tablePath": "/Tables/industrytable",
"value": "select * from Industrytable where Industry=\"Green\""
}
]
}
}
],
"members": {
"fabricItemMembers": [
{
"itemAccess": [
"ReadAll"
],
"sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
}
]
}
List default data access roles example
Beispielanforderung
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles
Beispiel für eine Antwort
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
"value": [
{
"name": "DefaultReader",
"decisionRules": [
{
"effect": "Permit",
"permission": [
{
"attributeName": "Path",
"attributeValueIncludedIn": [
"*"
]
},
{
"attributeName": "Action",
"attributeValueIncludedIn": [
"Read"
]
}
]
}
],
"members": {
"fabricItemMembers": [
{
"itemAccess": [
"ReadAll"
],
"sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Attribute |
Gibt den Namen des Attributs an, das für Zugriffsberechtigungen ausgewertet wird. Attributname kann |
|
Column |
Das Array von Aktionen, die auf die ColumnNames angewendet werden. Dadurch wird bestimmt, welche Aktionen ein Benutzer für Spalten ausführen kann. Die zulässigen Werte sind: Lesezugriff. Zusätzliche columnAction-Typen können im Laufe der Zeit hinzugefügt werden. |
|
Column |
ColumnConstraint gibt eine Einschränkung an, die die Berechtigungen und Sichtbarkeit bestimmt, die ein Benutzer für Spalten innerhalb einer Tabelle hat. |
|
Column |
Der Effekt, der den ColumnNames zugewiesen wurde. Der einzige zulässige Wert ist Permit. Zusätzliche ColumnEffect-Typen können im Laufe der Zeit hinzugefügt werden. |
| Constraints |
Einschränkungen wie Sicherheit auf Zeilen- oder Spaltenebene, die als Teil dieser Rolle auf Tabellen angewendet werden. Wenn sie nicht enthalten ist, gelten keine Einschränkungen für Tabellen in der Rolle. |
|
Data |
Eine Datenzugriffsrolle stellt eine Reihe von Berechtigungen und Berechtigungsbereichen dar, die definieren, welche Aktionen ihre Mitglieder für die Daten im Bereich ausführen dürfen. Datenzugriffsrollen werden verwendet, um die Datensicherheit zu verwalten und sicherzustellen, dass nur autorisierte Benutzer bestimmte Daten anzeigen, bearbeiten oder löschen können. Mitglieder sind Benutzer oder Gruppen, denen die Rolle gewährt wurde, und sie können die Daten basierend auf den Berechtigungen lesen, die der Rolle zugewiesen sind. Ein Mitglied kann z. B. eine Microsoft Entra-ID-Gruppe und ein Berechtigungsbereich sein, eine Leseaktion, die auf den angegebenen Pfad zu Datei, Ordnern oder Tabellen in OneLake angewendet wird. |
|
Data |
|
|
Decision |
Gibt eine Regel für den Abgleich der angeforderten Aktion an. Enthält Effekt (Permit) und Permission, die bestimmen, ob ein Benutzer oder eine Entität berechtigt ist, eine bestimmte Aktion (z. B. lesen) für eine Ressource auszuführen. Berechtigung ist eine Reihe von Bereichen, die durch Attribute definiert werden, die mit der angeforderten Aktion übereinstimmen müssen, damit die Regel angewendet werden kann. |
| Effect |
Der Effekt, den eine Rolle auf den Zugriff auf die Datenressource hat. Derzeit ist der einzige unterstützte Effekttyp |
|
Error |
Das Fehlerbezogene Ressourcendetails-Objekt. |
|
Error |
Die Fehlerantwort. |
|
Error |
Die Fehlerantwortdetails. |
|
Fabric |
Fabric-Elementelement. |
|
Item |
Eine Liste, die die Zugriffsberechtigungen für Fabric-Benutzer angibt, die automatisch in die Rollenmitglieder aufgenommen werden müssen. Zusätzliche ItemAccess-Typen können im Laufe der Zeit hinzugefügt werden. |
| Members |
Das Memberobjekt, das die Elemente der Rolle als Arrays verschiedener Membertypen enthält. |
|
Microsoft |
Microsoft Entra ID-Mitglied, das der Rolle zugewiesen ist. |
|
Object |
Der Typ des Microsoft Entra ID-Objekts. Zusätzliche objectType-Typen können im Laufe der Zeit hinzugefügt werden. |
|
Permission |
Definiert einen Satz von Attributen (Eigenschaften), die den Umfang und die Zugriffsebene für eine Ressource bestimmen. Wenn |
|
Row |
RowConstraint gibt eine Einschränkung an, die die Zeilen in einer Tabelle bestimmt, die Benutzer sehen können. Rollen, die mit RowConstraints definiert sind, verwenden T-SQL, um ein Prädikat zu definieren, das Daten in einer Tabelle filtert. Zeilen, die die Bedingungen des Prädikats nicht erfüllen, werden herausgefiltert, sodass eine Teilmenge der ursprünglichen Zeilen übrig bleibt. RowConstraints können auch verwendet werden, um dynamische und tabellenübergreifende Varianten von RLS mithilfe von T-SQL anzugeben. |
AttributeName
Gibt den Namen des Attributs an, das für Zugriffsberechtigungen ausgewertet wird. Attributname kann Path oder Actionwerden. Zusätzliche Attributname-Typen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Path |
Attributname Pfad |
| Action |
Attributname-Aktion |
ColumnAction
Das Array von Aktionen, die auf die ColumnNames angewendet werden. Dadurch wird bestimmt, welche Aktionen ein Benutzer für Spalten ausführen kann. Die zulässigen Werte sind: Lesezugriff. Zusätzliche columnAction-Typen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Read |
Der ColumnAction-Wert "Read" |
ColumnConstraint
ColumnConstraint gibt eine Einschränkung an, die die Berechtigungen und Sichtbarkeit bestimmt, die ein Benutzer für Spalten innerhalb einer Tabelle hat.
| Name | Typ | Beschreibung |
|---|---|---|
| columnAction |
Das Array von Aktionen, die auf die ColumnNames angewendet werden. Dadurch wird bestimmt, welche Aktionen ein Benutzer für Spalten ausführen kann. Die zulässigen Werte sind: Lesezugriff. Zusätzliche columnAction-Typen können im Laufe der Zeit hinzugefügt werden. |
|
| columnEffect |
Der Effekt, der den ColumnNames zugewiesen wurde. Der einzige zulässige Wert ist Permit. Zusätzliche ColumnEffect-Typen können im Laufe der Zeit hinzugefügt werden. |
|
| columnNames |
string[] |
Ein Array von Spaltennamen mit Groß-/Kleinschreibung. Jeder Wert ist ein Spaltenname aus der in |
| tablePath |
string |
Ein relativer Dateipfad, der angibt, für welche Tabelle die Spalteneinschränkung gilt. Dies sollte in Form von |
ColumnEffect
Der Effekt, der den ColumnNames zugewiesen wurde. Der einzige zulässige Wert ist Permit. Zusätzliche ColumnEffect-Typen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Permit |
Der ColumnEffect-Typ "Permit" |
Constraints
Einschränkungen wie Sicherheit auf Zeilen- oder Spaltenebene, die als Teil dieser Rolle auf Tabellen angewendet werden. Wenn sie nicht enthalten ist, gelten keine Einschränkungen für Tabellen in der Rolle.
| Name | Typ | Beschreibung |
|---|---|---|
| columns |
Das Array von Spalteneinschränkungen, die auf eine oder mehrere Tabellen in der Datenzugriffsrolle angewendet werden. |
|
| rows |
Das Array von Zeileneinschränkungen, die auf eine oder mehrere Tabellen in der Datenzugriffsrolle angewendet werden. |
DataAccessRole
Eine Datenzugriffsrolle stellt eine Reihe von Berechtigungen und Berechtigungsbereichen dar, die definieren, welche Aktionen ihre Mitglieder für die Daten im Bereich ausführen dürfen. Datenzugriffsrollen werden verwendet, um die Datensicherheit zu verwalten und sicherzustellen, dass nur autorisierte Benutzer bestimmte Daten anzeigen, bearbeiten oder löschen können. Mitglieder sind Benutzer oder Gruppen, denen die Rolle gewährt wurde, und sie können die Daten basierend auf den Berechtigungen lesen, die der Rolle zugewiesen sind. Ein Mitglied kann z. B. eine Microsoft Entra-ID-Gruppe und ein Berechtigungsbereich sein, eine Leseaktion, die auf den angegebenen Pfad zu Datei, Ordnern oder Tabellen in OneLake angewendet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| decisionRules |
Das Array der Berechtigungen, aus denen die Datenzugriffsrolle besteht. |
|
| id |
string (uuid) |
Die eindeutige ID für die Datenzugriffsrolle. |
| members |
Das Memberobjekt, das die Elemente der Rolle als Arrays verschiedener Membertypen enthält. |
|
| name |
string |
Der Name der Datenzugriffsrolle. |
DataAccessRoles
| Name | Typ | Beschreibung |
|---|---|---|
| continuationToken |
string |
Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt. |
| continuationUri |
string |
Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt. |
| value |
Eine Liste der Rollen, die zum Verwalten der Datensicherheit verwendet werden und sicherstellen, dass nur autorisierte Benutzer bestimmte Daten anzeigen können. Eine Rolle stellt eine Reihe von Berechtigungen und Berechtigungsbereichen dar, die definieren, welche Aktionen ihre Mitglieder für die Daten im Bereich ausführen dürfen. Mitglieder sind Benutzer oder Gruppen, denen die Rolle gewährt wurde, und sie können die Daten basierend auf den Berechtigungen lesen, die der Rolle zugewiesen sind. Ein Mitglied kann z. B. eine Microsoft Entra-ID-Gruppe sein, und der Berechtigungsbereich kann eine Leseaktion sein, die auf den angegebenen Pfad zu Datei, Ordnern oder Tabellen in OneLake angewendet wird. |
DecisionRule
Gibt eine Regel für den Abgleich der angeforderten Aktion an. Enthält Effekt (Permit) und Permission, die bestimmen, ob ein Benutzer oder eine Entität berechtigt ist, eine bestimmte Aktion (z. B. lesen) für eine Ressource auszuführen. Berechtigung ist eine Reihe von Bereichen, die durch Attribute definiert werden, die mit der angeforderten Aktion übereinstimmen müssen, damit die Regel angewendet werden kann.
| Name | Typ | Beschreibung |
|---|---|---|
| constraints |
Einschränkungen wie Sicherheit auf Zeilen- oder Spaltenebene, die als Teil dieser Rolle auf Tabellen angewendet werden. Wenn sie nicht enthalten ist, gelten keine Einschränkungen für Tabellen in der Rolle. |
|
| effect |
Der Effekt, den eine Rolle auf den Zugriff auf die Datenressource hat. Derzeit ist der einzige unterstützte Effekttyp |
|
| permission |
Die |
Effect
Der Effekt, den eine Rolle auf den Zugriff auf die Datenressource hat. Derzeit ist der einzige unterstützte Effekttyp Permit, der Zugriff auf die Ressource gewährt. Zusätzliche Effekttypen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Permit |
der Effekttyp "Permit" |
ErrorRelatedResource
Das Fehlerbezogene Ressourcendetails-Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| resourceId |
string |
Die Ressourcen-ID, die an dem Fehler beteiligt ist. |
| resourceType |
string |
Der Typ der Ressource, die an dem Fehler beteiligt ist. |
ErrorResponse
Die Fehlerantwort.
| Name | Typ | Beschreibung |
|---|---|---|
| errorCode |
string |
Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht. |
| message |
string |
Eine lesbare Darstellung des Fehlers. |
| moreDetails |
Liste der zusätzlichen Fehlerdetails. |
|
| relatedResource |
Die fehlerbezogenen Ressourcendetails. |
|
| requestId |
string |
ID der Anforderung, die dem Fehler zugeordnet ist. |
ErrorResponseDetails
Die Fehlerantwortdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| errorCode |
string |
Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht. |
| message |
string |
Eine lesbare Darstellung des Fehlers. |
| relatedResource |
Die fehlerbezogenen Ressourcendetails. |
FabricItemMember
Fabric-Elementelement.
| Name | Typ | Beschreibung |
|---|---|---|
| itemAccess |
Eine Liste, die die Zugriffsberechtigungen für Fabric-Benutzer angibt, die automatisch in die Rollenmitglieder aufgenommen werden müssen. Zusätzliche ItemAccess-Typen können im Laufe der Zeit hinzugefügt werden. |
|
| sourcePath |
string pattern: ^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?/[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$ |
Der Pfad zu Fabric-Element mit dem angegebenen Elementzugriff. |
ItemAccess
Eine Liste, die die Zugriffsberechtigungen für Fabric-Benutzer angibt, die automatisch in die Rollenmitglieder aufgenommen werden müssen. Zusätzliche ItemAccess-Typen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Read |
Elementzugriff lesen. |
| Write |
Access-Elementschreibzugriff. |
| Reshare |
Elementzugriff erneut freigeben. |
| Explore |
Elementzugriff erkunden. |
| Execute |
Elementzugriff wird ausgeführt. |
| ReadAll |
Elementzugriff ReadAll. |
Members
Das Memberobjekt, das die Elemente der Rolle als Arrays verschiedener Membertypen enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| fabricItemMembers |
Eine Liste der Mitglieder, die über einen bestimmten Berechtigungssatz in Microsoft Fabric verfügen. Alle Mitglieder mit diesem Berechtigungssatz werden als Mitglieder dieser Datenzugriffsrolle hinzugefügt. |
|
| microsoftEntraMembers |
Die Liste der Microsoft Entra-ID-Mitglieder. |
MicrosoftEntraMember
Microsoft Entra ID-Mitglied, das der Rolle zugewiesen ist.
| Name | Typ | Beschreibung |
|---|---|---|
| objectId |
string (uuid) |
Die Objekt-ID. |
| objectType |
Der Typ des Microsoft Entra ID-Objekts. Zusätzliche objectType-Typen können im Laufe der Zeit hinzugefügt werden. |
|
| tenantId |
string (uuid) |
Die Mandanten-ID. |
ObjectType
Der Typ des Microsoft Entra ID-Objekts. Zusätzliche objectType-Typen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| Group |
AttributnameGruppe |
| User |
Attributname Benutzer |
| ServicePrincipal |
Attributname ServicePrincipal |
| ManagedIdentity |
Attributname ManagedIdentity |
PermissionScope
Definiert einen Satz von Attributen (Eigenschaften), die den Umfang und die Zugriffsebene für eine Ressource bestimmen. Wenn attributeName Eigenschaft auf Pathfestgelegt ist, muss die attributeValueIncludedIn Eigenschaft den Speicherort der Ressource angeben, auf die zugegriffen wird, z. B. "Tables/Table1". Wenn die attributeName-Eigenschaft auf Actionfestgelegt ist, muss die attributeValueIncludedIn-Eigenschaft den Typ des gewährten Zugriffs angeben, z. B. Read.
| Name | Typ | Beschreibung |
|---|---|---|
| attributeName |
Gibt den Namen des Attributs an, das für Zugriffsberechtigungen ausgewertet wird. Attributname kann |
|
| attributeValueIncludedIn |
string[] |
Gibt eine Liste der Werte für die |
RowConstraint
RowConstraint gibt eine Einschränkung an, die die Zeilen in einer Tabelle bestimmt, die Benutzer sehen können. Rollen, die mit RowConstraints definiert sind, verwenden T-SQL, um ein Prädikat zu definieren, das Daten in einer Tabelle filtert. Zeilen, die die Bedingungen des Prädikats nicht erfüllen, werden herausgefiltert, sodass eine Teilmenge der ursprünglichen Zeilen übrig bleibt. RowConstraints können auch verwendet werden, um dynamische und tabellenübergreifende Varianten von RLS mithilfe von T-SQL anzugeben.
| Name | Typ | Beschreibung |
|---|---|---|
| tablePath |
string |
Ein relativer Dateipfad, der angibt, für welche Tabelle die Zeileneinschränkung gilt. Dies sollte in Form von |
| value |
string |
Ein T-SQL-Ausdruck, der verwendet wird, um zu bewerten, welche Zeilen die Rollenmitglieder sehen können. Nur eine Teilmenge von T-SQL kann als Prädikat verwendet werden. |