Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Tjänst:
- Kärna
API-version:
- v1
Hämtar den tillåtna dataåtkomsten för en given användare enligt OneLake-säkerhetsrollerna som har konfigurerats för objektet. Det här API:et konsoliderar en användares eller grupps behörigheter över olika roller, vilket ger en vy av "effektiv åtkomst" över deras behörigheter.
Anmärkning
Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.
Obligatoriska delegerade omfång
OneLake.ReadWrite.All
Identiteter som stöds av Microsoft Entra
Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.
| Identitet | Support |
|---|---|
| User | Ja |
| Tjänsthuvudnamn och hanterade identiteter | Ja |
Gränssnitt
GET https://onelake.dfs.fabric.microsoft.com/v1.0/workspaces/{workspaceId}/artifacts/{artifactId}/securityPolicy/principalAccess
URI parametrar
| Namn | I | Obligatoriskt | Type | Beskrivning |
|---|---|---|---|---|
| Artikel-ID | path | Sann | sträng (uuid) | ID:t för Fabric-objektet för att tilldela rollerna. |
Begärandehuvud
| Namn | Obligatoriskt | Type | Beskrivning |
|---|---|---|---|
| If-Match | snöre | Ett ETag-värde. ETag måste anges inom citattecken. Om det tillhandahålls lyckas anropet endast om resursens ETag matchar den angivna ETag. | |
| If-None-Match | snöre | Ett ETag-värde. ETag måste anges inom citattecken. Om det tillhandahålls lyckas anropet endast om resursens ETag inte matchar den angivna ETag. |
Begärans brödtext
| Namn | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
| aadObjectId | snöre | Ja | Entra-objekt-ID:t för den användare vars åtkomst ska kontrolleras. |
| inputPath | snöre | Ja | Antingen "Tabeller" eller "Filer". Svaret kommer att returnera huvudaktörens åtkomst för antingen avsnittet Tabeller eller Filer i objektet, beroende på vilket indata som angavs. |
| continuationToken | snöre | optional | Används för att hämta fortsatta resultat om den första uppsättningen är mer än maxResults. |
| maximalt antal resultat | heltal | optional | Maximalt antal objekt per sida. Om det inte anges är standardvärdet 500. |
Responses
| Namn | Type | Beskrivning |
|---|---|---|
| 200 Okej | Begäran har slutförts. Headers Etag: sträng |
|
| 429 För många förfrågningar | Felmeddelande | Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.Headers Försök igen: heltal |
| Andra statuskoder | Felmeddelande | Vanliga felkoder: - ItemNotFound – anger att servern inte kan hitta det begärda objektet. – PreconditionFailed -Indikerar att den aktuella resursen ETag inte matchar värdet som anges i If-Match-huvud. |
Exempel
Exempelbegäran
HTTP
GET https://onelake.dfs.fabric.microsoft.com/v1.0/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/artifacts/25bac802-080d-4f73-8a42-1b406eb1fceb/securityPolicy/principalAccess
{
"aadObjectId": "CA81C0F4-5C79-4907-BD0A-B4D576AEA59B",
"inputPath": "Tables",
"continuationToken": "(token, optional)",
"maxResults": (optional)
}
Exempelsvar
- Statuskod:
- 200
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
"identityETag": "3fc4dc476ded773e4cf43936190bf20fa9480a077b25edc0b4bbe247112542f6",
"metadataETag": "\"eyJhciI6IlwiMHg4REU3NjQ2MzA2QTIxNjhcIiIsInNjIjoiXCIweDhERTcwQzdBNjlENzk1Q1wiIiwiaXIiOiJcIjB4OERFNjhEREMyNjhBM0U0XCIiLCJkciI6IlwiNWM0YmFhZWIwYTE2MzYxZjkzNThjMzNjMDllYmM2ODJhZjQ1NmIxMDZlNTRmN2E1MzRhNjk5NzA1MjgzMTU5Yy1mODUxMjc0MDBjYjY0YzFkYTA2NjFlZWIyNzg4ZTNhZDc1N2Y3MTZhZWIyYTk0OTA4NGUxOGI2MWUyYWNjNzAxXCIifQ==\"",
"value": [
{
"path": "Tables/dbo/Customers",
"access": [
"Read"
],
"rows": "SELECT * FROM [dbo].[Customers] WHERE [customerId] = '123' UNION SELECT * FROM [dbo].[Customers] WHERE [customerID] = 'ALFKI'",
"effect": "Permit"
},
{
"path": "Tables/dbo/Employees",
"access": [
"Read"
],
"rows": "SELECT * FROM [dbo].[Employees] WHERE [address] = '123'",
"effect": "Permit"
},
{
"path": "Tables/dbo/EmployeeTerritories",
"access": [
"Read"
],
"effect": "Permit"
}
]
}
Definitions
| Namn | Beskrivning |
|---|---|
| Åtkomst | Den typ av åtkomstbehörighet som beviljas. För närvarande är Readden enda åtkomsttyp som stöds . Ytterligare åtkomsttyper kan läggas till över tid. |
| Kolumnåtkomst | Representerar en kolumn som huvudmannen har tillstånd att komma åt, inklusive den beviljade effekten och åtgärden för kolumnen. |
| KolumnÅtgärd | Åtgärden som är tillåten på en kolumn. För närvarande är Readden enda åtgärden som stöds . Ytterligare åtgärdstyper kan läggas till över tid. |
| KolonnEffekt | Effekten som tillämpas på en kolumn. För närvarande är Permitden enda effekt som stöds . Ytterligare effekttyper kan läggas till över tid. |
| Effekt | Påverkan som en huvudman har på åtkomsten till dataresursen. För närvarande är den enda effekttypen som stöds Permit, vilket ger åtkomst till resursen. Ytterligare effekttyper kan läggas till över tid. |
| Felrelaterad Resurs | Det felrelaterade resursinformationsobjektet. |
| Felmeddelande | Felsvaret. |
| Felresponsdetaljer | Detaljer om felsvaret. |
| Principal Åtkomstpost | Representerar den effektiva åtkomsten som en principal har till en specifik resurssökväg, inklusive åtkomsttyp, resultat och eventuell filtrering på radnivå eller kolumnnivå som tillämpas. |
| PrincipalAccessResponse | Svarsobjektet som innehåller den effektiva åtkomsten för en behörig användare för alla resurser inom den angivna indatasökvägen. |
Åtkomst
Uppräkning
Den typ av åtkomstbehörighet som beviljas. För närvarande är Readden enda åtkomsttyp som stöds . Ytterligare åtkomsttyper kan läggas till över tid.
| Värde | Beskrivning |
|---|---|
| Läs | Läsåtkomst till resursen. |
Kolumnåtkomst
Objekt
Representerar en kolumn som huvudmannen har tillstånd att komma åt, inklusive den beviljade effekten och åtgärden för kolumnen.
| Namn | Type | Beskrivning |
|---|---|---|
| Namn | snöre | Det skiftlägeskänsliga namnet på kolumnen som huvudkontot har åtkomst till. |
| kolonnEffekt | KolonnEffekt | Den effekt som tillämpas på kolumnen. För närvarande är Permitdet enda värde som stöds . Ytterligare effekttyper kan läggas till över tid. |
| kolumnåtgärd | ColumnAction[] | Matrisen med åtgärder som tillåts i kolumnen. För närvarande är Readdet enda värde som stöds . Ytterligare åtgärdstyper kan läggas till över tid. |
KolumnÅtgärd
Uppräkning
Åtgärden som är tillåten på en kolumn. För närvarande är Readden enda åtgärden som stöds . Ytterligare åtgärdstyper kan läggas till över tid.
| Värde | Beskrivning |
|---|---|
| Läs | Läsåtgärd i kolumnen. |
KolonnEffekt
Uppräkning
Effekten som tillämpas på en kolumn. För närvarande är Permitden enda effekt som stöds . Ytterligare effekttyper kan läggas till över tid.
| Värde | Beskrivning |
|---|---|
| Permit | Kolumneffekttypen Tillåt. |
Effekt
Uppräkning
Effekten som en huvudman har på åtkomst till dataresursen. För närvarande är den enda effekttypen som stöds Permit, vilket ger åtkomst till resursen. Ytterligare effekttyper kan läggas till över tid.
| Värde | Beskrivning |
|---|---|
| Permit | Effekttyp Behörighet. |
ErrorRelatedResource
Objekt
Det felrelaterade resursinformationsobjektet.
| Namn | Type | Beskrivning |
|---|---|---|
| resurs-ID | snöre | Resurs-ID:t som är inblandat i felet. |
| resourceType | snöre | Typen av resurs som är inblandad i felet. |
Felmeddelande
Objekt
Felmeddelande.
| Namn | Type | Beskrivning |
|---|---|---|
| felkod | snöre | En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare. |
| meddelande | snöre | En mänsklig läsbar representation av felet. |
| mer information | ErrorResponseDetails[] | Lista över ytterligare felinformation. |
| relateradResurs | ErrorRelatedResource | Detaljer om resursen relaterad till felet. |
| begäranId | sträng (uuid) | ID för den begäran som är associerad med felet. |
Felresponsdetaljer
Objekt
Detaljer om felsvaret.
| Namn | Type | Beskrivning |
|---|---|---|
| felkod | snöre | En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare. |
| meddelande | snöre | En mänsklig läsbar representation av felet. |
| relaterad resurs | ErrorRelatedResource | Felrelaterade resursdetaljer. |
Principal Åtkomstpost
Objekt
Representerar den effektiva åtkomsten som en principal har till en specifik resurssökväg, inklusive åtkomsttyp, resultat och eventuell filtrering på radnivå eller kolumnnivå som tillämpas.
| Namn | Type | Beskrivning |
|---|---|---|
| path | snöre | Sökvägen till den resurs som huvudansvariga har åtkomst till, till exempel Tables/dbo/Customers. |
| tillträde | Åtkomst[] | Mängden med åtkomstbehörigheter som beviljats till principen för den här resursen. |
| columns | KolumnÅtkomst[] | Arrayen av kolumner som huvudmannen har behörighet att komma åt. Varje post anger kolumnnamnet, effekten och de tillåtna åtgärderna. Om den här egenskapen utelämnas gäller ingen säkerhet på kolumnnivå och alla kolumner tillåts. |
| rows | snöre | Ett T-SQL-uttryck som representerar säkerhetsfiltret på radnivå som tillämpas på huvudkontots åtkomst. Endast rader som matchar det här predikatet är synliga för principalen. Den här egenskapen utelämnas om ingen filtrering på radnivå gäller. |
| effekt | Effekt | Den effekt som huvudpersonen har på åtkomst till dataresursen. För närvarande är den enda effekttypen som stöds Permit, vilket ger åtkomst till resursen. Ytterligare effekttyper kan läggas till över tid. |
PrincipalAccessResponse
Objekt
Svarsobjektet som innehåller den effektiva åtkomsten för en behörig användare för alla resurser inom den angivna indatasökvägen.
| Namn | Type | Beskrivning |
|---|---|---|
| identityETag | snöre | Ett ETag-värde som representerar det aktuella tillståndet för huvudkontots identitets- och gruppmedlemskap. Ändras när huvudprincipalen gruppmedlemskap eller identitetsegenskaper uppdateras. |
| metadata-eTag | snöre | Ett ETag-värde som representerar det aktuella tillståndet för säkerhetsmetadata för objektet. Ändringar när säkerhetsroller eller principer för objektet uppdateras. |
| value | PrincipalAccessEntry[] | En uppsättning med åtkomstposter som representerar den effektiva åtkomst som huvudpersonen har över resurser inom den angivna indatasökvägen. |