Condividi tramite


Ottenere l'accesso autorizzato per un principale

  • Servizio:

    • Nucleo
  • Versione API:

    • v1

Recupera l'accesso ai dati consentito per una determinata entità in base ai ruoli di sicurezza di OneLake configurati nell'elemento. Questa API consolida le autorizzazioni di un soggetto autorizzato tra i ruoli, fornendo una visualizzazione delle autorizzazioni di accesso effettive.

Annotazioni

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Ambiti delegati obbligatori

OneLake.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Support
User
Principale del servizio e Identità gestite

Interfaccia

GET https://onelake.dfs.fabric.microsoft.com/v1.0/workspaces/{workspaceId}/artifacts/{artifactId}/securityPolicy/principalAccess

Parametri dell'URI

Nome In Obbligatorio Tipo Descrizione
ID articolo percorso Vero string (uuid) ID dell'elemento Fabric a cui assegnare i ruoli.

Intestazione della richiesta

Nome Obbligatorio Tipo Descrizione
If-Match corda Un valore ETag. L'ETag deve essere specificato tra virgolette. Se specificato, la chiamata avrà esito positivo solo se l'ETag della risorsa corrisponde all'ETag specificato.
If-None-Match corda Un valore ETag. L'ETag deve essere specificato tra virgolette. Se specificato, la chiamata avrà esito positivo solo se l'ETag della risorsa non corrisponde all'ETag specificato.

Corpo della richiesta

Nome Tipo Obbligatorio Descrizione
aadObjectId corda ID oggetto Entra dell'utente per verificare l'accesso.
inputPath corda "Tabelle" o "File". La risposta restituirà l'accesso dell'utente principale solo per la sezione Tabelle o File dell'elemento, in base all'input specificato.
continuationToken corda opzionale Usato per recuperare risultati continui se il set iniziale è maggiore di maxResults.
maxResults numero intero opzionale Numero massimo di elementi per pagina. Se non specificato, il valore predefinito è 500.

Responses

Nome Tipo Descrizione
200 Va bene Richiesta completata correttamente.

Intestazioni

Etag: stringa
429 - Numero eccessivo di richieste Risposta di Errore È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Nuovo tentativo dopo: integer
Altri codici di stato Risposta di Errore Codici di errore comuni:

- ItemNotFound - Indica che il server non riesce a trovare l'elemento richiesto.
- Precondizione fallita - Indica che l'ETag della risorsa corrente non corrisponde al valore specificato nell'intestazione If-Match.

Examples

Esempio di richiesta

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)
}

Risposta di esempio

  • Codice di stato:
    • 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"
    }
  ]
}

Definizioni

Nome Descrizione
Access Tipo di autorizzazione di accesso concessa. Attualmente, l'unico tipo di accesso supportato è Read. È possibile aggiungere altri tipi di accesso nel corso del tempo.
ColumnAccess Rappresenta una colonna che il soggetto principale è autorizzato ad accedere, compreso l'effetto e l'azione consentiti su quella colonna.
AzioneColonna Azione consentita su una colonna. Attualmente, l'unica azione supportata è Read. È possibile aggiungere altri tipi di azione nel tempo.
EffettoColonna Effetto applicato a una colonna. Attualmente, l'unico effetto supportato è Permit. È possibile aggiungere altri tipi di effetto nel tempo.
Effetto L'effetto che un principale ha sull'accesso alla risorsa di dati. Attualmente, l'unico tipo di effetto supportato è Permit, che concede l'accesso alla risorsa. È possibile aggiungere altri tipi di effetto nel tempo.
ErrorRelatedResource Oggetto dei dettagli della risorsa relativo all'errore.
Risposta di Errore Risposta di errore.
ErrorResponseDetails Dettagli della risposta di errore.
Voce di accesso principale (PrincipalAccessEntry) Rappresenta l'accesso effettivo di un'entità a un percorso di risorsa specifico, incluso il tipo di accesso, l'effetto e qualsiasi filtro a livello di riga o di colonna applicato.
PrincipalAccessResponse L'oggetto di risposta che contiene l'accesso effettivo per un utente principale attraverso tutte le risorse all'interno del percorso di input specificato.

Access

Enumerazione

Tipo di autorizzazione di accesso concessa. Attualmente, l'unico tipo di accesso supportato è Read. È possibile aggiungere altri tipi di accesso nel corso del tempo.

Valore Descrizione
Leggi Accesso in lettura alla risorsa.

ColumnAccess

oggetto

Rappresenta una colonna che il soggetto principale è autorizzato ad accedere, compreso l'effetto e l'azione consentiti su quella colonna.

Nome Tipo Descrizione
nome corda Il nome con distinzione tra maiuscole e minuscole della colonna a cui è consentito l'accesso all'entità.
columnEffect EffettoColonna Effetto applicato alla colonna. Attualmente, l'unico valore supportato è Permit. È possibile aggiungere altri tipi di effetto nel tempo.
columnAction ColumnAction[] Matrice di azioni consentite nella colonna. Attualmente, l'unico valore supportato è Read. È possibile aggiungere altri tipi di azione nel tempo.

AzioneColonna

Enumerazione

Azione consentita su una colonna. Attualmente, l'unica azione supportata è Read. È possibile aggiungere altri tipi di azione nel tempo.

Valore Descrizione
Leggi Leggere l'azione sulla colonna.

EffettoColonna

Enumerazione

Effetto applicato a una colonna. Attualmente, l'unico effetto supportato è Permit. È possibile aggiungere altri tipi di effetto nel tempo.

Valore Descrizione
Permit Tipo di effetto colonna Permit.

Effetto

Enumerazione

L'effetto che un principale ha sull'accesso alla risorsa dati. Attualmente, l'unico tipo di effetto supportato è Permit, che concede l'accesso alla risorsa. È possibile aggiungere altri tipi di effetto nel tempo.

Valore Descrizione
Permit Tipo di effetto Permesso.

RisorsaCorrelataAllErrore

oggetto

Oggetto dettagli della risorsa correlata all'errore.

Nome Tipo Descrizione
resourceId corda ID risorsa coinvolto nell'errore.
tipo di risorsa corda Tipo della risorsa coinvolta nell'errore.

Risposta di Errore

oggetto

Risposta di errore.

Nome Tipo Descrizione
codice di errore corda Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message corda Rappresentazione leggibile dell'errore.
maggioriDettagli ErrorResponseDetails[] Elenco di dettagli aggiuntivi sull'errore.
risorsaCorrelata ErrorRelatedResource Dettagli della risorsa correlati all'errore.
ID richiesta string (uuid) ID della richiesta associata all'errore.

ErrorResponseDetails

oggetto

Dettagli della risposta di errore.

Nome Tipo Descrizione
codice di errore corda Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message corda Rappresentazione leggibile dell'errore.
risorsaCorrelata ErrorRelatedResource Dettagli della risorsa correlati all'errore.

Voce di accesso principale (PrincipalAccessEntry)

oggetto

Rappresenta l'accesso effettivo di un'entità a un percorso di risorsa specifico, incluso il tipo di accesso, l'effetto e qualsiasi filtro a livello di riga o di colonna applicato.

Nome Tipo Descrizione
percorso corda Percorso della risorsa a cui l'entità ha accesso, ad esempio Tables/dbo/Customers.
accesso Access[] Matrice di autorizzazioni di accesso concesse all'entità per questa risorsa.
columns ColumnAccess[] L'array di colonne a cui il principale è autorizzato ad accedere. Ogni voce specifica il nome della colonna, l'effetto e le azioni consentite. Se questa proprietà viene omessa, non viene applicata alcuna sicurezza a livello di colonna e tutte le colonne sono consentite.
rows corda Espressione T-SQL che rappresenta il filtro di sicurezza a livello di riga applicato all'accesso del principale. Solo le righe corrispondenti a questa condizione sono visibili all'utente. Questa proprietà viene omessa se non viene applicato alcun filtro a livello di riga.
effetto Effetto L'effetto che il responsabile ha sull'accesso alla risorsa dati. Attualmente, l'unico tipo di effetto supportato è Permit, che concede l'accesso alla risorsa. È possibile aggiungere altri tipi di effetto nel tempo.

PrincipalAccessResponse

oggetto

L'oggetto di risposta che contiene l'accesso effettivo per un utente principale attraverso tutte le risorse all'interno del percorso di input specificato.

Nome Tipo Descrizione
identityETag corda Valore ETag che rappresenta lo stato corrente dell'identità e delle appartenenze ai gruppi dell'entità. Cambia quando vengono aggiornate le appartenenze ai gruppi o le proprietà di identità dell'entità.
metadataETag corda Valore ETag che rappresenta lo stato corrente dei metadati di sicurezza per l'elemento. Cambia quando i ruoli o i criteri di sicurezza dell'elemento vengono aggiornati.
Valore PrincipalAccessEntry[] Array di voci di accesso che rappresentano l'accesso effettivo del principale attraverso le risorse all'interno del percorso di input specificato.