OneLake Data Access Security - List Data Access Roles

Referentie

Service:: Core

API-versie:: v1

Notitie

Deze API is in preview.

Hiermee wordt een lijst met OneLake-rollen geretourneerd.

Vereiste gedelegeerde bereiken

OneLake.Read.All of OneLake.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles

Met optionele parameters:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles?continuationToken={continuationToken}

URI-parameters

Name	In	Vereist	Type	Description
itemId	path	True	string uuid	De id van het fabric-item om de rollen te plaatsen.
workspaceId	path	True	string uuid	De werkruimte-id.
continuationToken	query		string	Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name	Type	Description
200 OK	DataAccessRoles	De aanvraag is voltooid. Kopteksten Etag: string
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: ItemNotFound - Geeft aan dat de server het aangevraagde item niet kan vinden.

Name

Type

Description

200 OK

DataAccessRoles

De aanvraag is voltooid.

Kopteksten

Etag: string

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

ItemNotFound - Geeft aan dat de server het aangevraagde item niet kan vinden.

Voorbeelden

List data access roles multiple pages example

List data access roles single page example

List default data access roles example

List data access roles multiple pages example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Voorbeeldrespons

Statuscode:: 200

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

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Voorbeeldrespons

Statuscode:: 200

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 default data access roles example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Voorbeeldrespons

Statuscode:: 200

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"
          }
        ]
      }
    }
  ]
}

Definities

Name	Description
AttributeName	Hiermee geeft u de naam op van het kenmerk dat wordt geëvalueerd voor toegangsmachtigingen. AttributeName kan worden `Path` of `Action`. Er kunnen in de loop van de tijd extra attributeName-typen worden toegevoegd.
DataAccessRole	Een gegevenstoegangsrol vertegenwoordigt een set machtigingen en machtigingsbereiken die bepalen welke acties de leden mogen uitvoeren voor de gegevens binnen het bereik. Rollen voor gegevenstoegang worden gebruikt om de beveiliging van gegevenstoegang te beheren en ervoor te zorgen dat alleen geautoriseerde gebruikers bepaalde gegevens kunnen bekijken, bewerken of verwijderen. Leden zijn gebruikers of groepen waaraan de rol is verleend en ze kunnen de gegevens lezen op basis van de machtigingen die aan de rol zijn toegewezen. Een lid kan bijvoorbeeld een Microsoft Entra-id-groep zijn en het machtigingsbereik kan een leesactie zijn die wordt toegepast op het opgegeven pad naar bestand, mappen of tabellen in OneLake.
DataAccessRoles
DecisionRule	Hiermee geeft u een regel op die overeenkomt met de aangevraagde actie. Bevat effect (Toestaan) en Machtiging die bepalen of een gebruiker of entiteit is gemachtigd om een specifieke actie (bijvoorbeeld lezen) uit te voeren voor een resource. Machtiging is een set bereiken, gedefinieerd door kenmerken, die moeten overeenkomen met de aangevraagde actie voor de regel die moet worden toegepast.
Effect	Het effect dat een rol heeft op toegang tot de gegevensresource. Momenteel is het enige ondersteunde effecttype `Permit`, waarmee toegang tot de resource wordt verleend. Er kunnen in de loop van de tijd extra effecttypen worden toegevoegd.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
FabricItemMember	Lid van fabricitem.
ItemAccess	Een lijst met de toegangsmachtigingen voor fabric-gebruikers die automatisch moeten worden opgenomen in de rolleden. Er kunnen in de loop van de tijd extra itemAccess-typen worden toegevoegd.
Members	Het ledenobject dat de leden van de rol bevat als matrices van verschillende lidtypen.
MicrosoftEntraMember	Microsoft Entra ID-lid dat is toegewezen aan de rol.
ObjectType	Het type Microsoft Entra ID-object. Er kunnen in de loop van de tijd extra objectType-typen worden toegevoegd.
PermissionScope	Definieert een set kenmerken (eigenschappen) die het bereik en het toegangsniveau van een resource bepalen. Wanneer `attributeName` eigenschap is ingesteld op `Path`, moet de eigenschap `attributeValueIncludedIn` de locatie opgeven van de resource die wordt geopend, zoals 'Tabellen/Tabel1'. Wanneer de eigenschap `attributeName` is ingesteld op `Action`, moet de eigenschap `attributeValueIncludedIn` opgeven welk type toegang wordt verleend, zoals `Read`.

AttributeName

Inventarisatie

Hiermee geeft u de naam op van het kenmerk dat wordt geëvalueerd voor toegangsmachtigingen. AttributeName kan worden Path of Action. Er kunnen in de loop van de tijd extra attributeName-typen worden toegevoegd.

Waarde	Description
Action	Kenmerknaamactie
Path	Pad naar kenmerknaam

DataAccessRole

Object

Een gegevenstoegangsrol vertegenwoordigt een set machtigingen en machtigingsbereiken die bepalen welke acties de leden mogen uitvoeren voor de gegevens binnen het bereik. Rollen voor gegevenstoegang worden gebruikt om de beveiliging van gegevenstoegang te beheren en ervoor te zorgen dat alleen geautoriseerde gebruikers bepaalde gegevens kunnen bekijken, bewerken of verwijderen. Leden zijn gebruikers of groepen waaraan de rol is verleend en ze kunnen de gegevens lezen op basis van de machtigingen die aan de rol zijn toegewezen. Een lid kan bijvoorbeeld een Microsoft Entra-id-groep zijn en het machtigingsbereik kan een leesactie zijn die wordt toegepast op het opgegeven pad naar bestand, mappen of tabellen in OneLake.

Name	Type	Description
decisionRules	DecisionRule[]	De matrix met machtigingen waaruit de rol Gegevenstoegang bestaat.
id	string uuid	De unieke id voor de rol Gegevenstoegang.
members	Members	Het ledenobject dat de leden van de rol bevat als matrices van verschillende lidtypen.
name	string	De naam van de rol Gegevenstoegang.

DataAccessRoles

Object

Name	Type	Description
continuationToken	string	Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri	string	De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value	DataAccessRole[]	Een lijst met rollen die worden gebruikt om de beveiliging van gegevenstoegang te beheren en ervoor te zorgen dat alleen geautoriseerde gebruikers bepaalde gegevens kunnen bekijken. Een rol vertegenwoordigt een set machtigingen en machtigingsbereiken die bepalen welke acties de leden mogen uitvoeren voor de gegevens binnen het bereik. Leden zijn gebruikers of groepen waaraan de rol is verleend en ze kunnen de gegevens lezen op basis van de machtigingen die aan de rol zijn toegewezen. Een lid kan bijvoorbeeld een Microsoft Entra-id-groep zijn en het machtigingsbereik kan een leesactie zijn die is toegepast op het opgegeven pad naar bestand, mappen of tabellen in OneLake.

DecisionRule

Object

Hiermee geeft u een regel op die overeenkomt met de aangevraagde actie. Bevat effect (Toestaan) en Machtiging die bepalen of een gebruiker of entiteit is gemachtigd om een specifieke actie (bijvoorbeeld lezen) uit te voeren voor een resource. Machtiging is een set bereiken, gedefinieerd door kenmerken, die moeten overeenkomen met de aangevraagde actie voor de regel die moet worden toegepast.

Name	Type	Description
effect	Effect	Het effect dat een rol heeft op toegang tot de gegevensresource. Momenteel is het enige ondersteunde effecttype `Permit`, waarmee toegang tot de resource wordt verleend. Er kunnen in de loop van de tijd extra effecttypen worden toegevoegd.
permission	PermissionScope[]	De eigenschap `permission` is een matrix waarmee het bereik en het toegangsniveau voor een aangevraagde actie worden opgegeven. De matrix moet precies twee PermissionScope-objecten bevatten: `Path` en `Action`. De `scope` wordt gedefinieerd met behulp van het `PermissionScope`-object, waarbij `attributeValueIncludedIn` de locatie opgeeft van de resource die wordt geopend of het type actie dat wordt verleend. De `access` verwijst naar het toegangsniveau dat wordt verleend, zoals `Read`.

Effect

Inventarisatie

Het effect dat een rol heeft op toegang tot de gegevensresource. Momenteel is het enige ondersteunde effecttype Permit, waarmee toegang tot de resource wordt verleend. Er kunnen in de loop van de tijd extra effecttypen worden toegevoegd.

Waarde	Description
Permit	het effecttype Toestaan

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

FabricItemMember

Object

Lid van fabricitem.

Name	Type	Description
itemAccess	ItemAccess[]	Een lijst met de toegangsmachtigingen voor fabric-gebruikers die automatisch moeten worden opgenomen in de rolleden. Er kunnen in de loop van de tijd extra itemAccess-typen worden toegevoegd.
sourcePath	string	Het pad naar het Fabric-item met de opgegeven itemtoegang.

ItemAccess

Inventarisatie

Een lijst met de toegangsmachtigingen voor fabric-gebruikers die automatisch moeten worden opgenomen in de rolleden. Er kunnen in de loop van de tijd extra itemAccess-typen worden toegevoegd.

Waarde	Description
Execute	Itemtoegang uitvoeren.
Explore	Verkennen van itemtoegang.
Read	Itemtoegang gelezen.
ReadAll	Item Access ReadAll.
Reshare	Itemtoegang opnieuw delen.
Write	Schrijfbewerking voor itemtoegang.

Members

Object

Het ledenobject dat de leden van de rol bevat als matrices van verschillende lidtypen.

Name	Type	Description
fabricItemMembers	FabricItemMember[]	Een lijst met leden met een bepaalde machtigingenset in Microsoft Fabric. Alle leden met die machtigingenset worden toegevoegd als leden van deze Gegevenstoegangsrol.
microsoftEntraMembers	MicrosoftEntraMember[]	De lijst met Microsoft Entra ID-leden.

MicrosoftEntraMember

Object

Microsoft Entra ID-lid dat is toegewezen aan de rol.

Name	Type	Description
objectId	string uuid	De object-id.
objectType	ObjectType	Het type Microsoft Entra ID-object. Er kunnen in de loop van de tijd extra objectType-typen worden toegevoegd.
tenantId	string uuid	De tenant-id.

ObjectType

Inventarisatie

Het type Microsoft Entra ID-object. Er kunnen in de loop van de tijd extra objectType-typen worden toegevoegd.

Waarde	Description
Group	Kenmerknaamgroep
ManagedIdentity	Kenmerknaam ManagedIdentity
ServicePrincipal	Kenmerknaam ServicePrincipal
User	Kenmerknaam gebruiker

PermissionScope

Object

Definieert een set kenmerken (eigenschappen) die het bereik en het toegangsniveau van een resource bepalen. Wanneer attributeName eigenschap is ingesteld op Path, moet de eigenschap attributeValueIncludedIn de locatie opgeven van de resource die wordt geopend, zoals 'Tabellen/Tabel1'. Wanneer de eigenschap attributeName is ingesteld op Action, moet de eigenschap attributeValueIncludedIn opgeven welk type toegang wordt verleend, zoals Read.

Name	Type	Description
attributeName	AttributeName	Hiermee geeft u de naam op van het kenmerk dat wordt geëvalueerd voor toegangsmachtigingen. AttributeName kan worden `Path` of `Action`. Er kunnen in de loop van de tijd extra attributeName-typen worden toegevoegd.
attributeValueIncludedIn	string[]	Hiermee geeft u een lijst met waarden voor de `attributeName` om het bereik en het toegangsniveau van een resource te definiëren. Wanneer `attributeName` is `Path`, moet `attributeValueIncludedIn` de locatie opgeven van de resource die wordt geopend, zoals Tabellen/Tabel1. Wanneer `attributeName` is `Action`, moet de `attributeValueIncludedIn` opgeven welk type toegang wordt verleend, zoals `Read`.

Delen via

OneLake Data Access Security - List Data Access Roles

Vereiste gedelegeerde bereiken

Door Microsoft Entra ondersteunde identiteiten

Interface

URI-parameters

Antwoorden

Voorbeelden

List data access roles multiple pages example

Voorbeeldaanvraag

Voorbeeldrespons

List data access roles single page example

Voorbeeldaanvraag

Voorbeeldrespons

List default data access roles example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AttributeName

DataAccessRole

DataAccessRoles

DecisionRule

Effect

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

FabricItemMember

ItemAccess

Members

MicrosoftEntraMember

ObjectType

PermissionScope

Aanvullende resources