Items - List Item Access Details

Usługa:
Admin
Wersja interfejsu API:
v1

Zwraca listę użytkowników (w tym grup i jednostek usługi) i wyświetla ich role obszaru roboczego.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.

Wymagane zakresy delegowane

Tenant.Read.All lub Tenant.ReadWrite.All

Limitations

Maksymalna liczba żądań na godzinę wynosi 200.

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users
Z parametrami opcjonalnymi: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users?type={type}

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
itemId
 path True

string (uuid)

Identyfikator elementu.
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.
type
 query

string

Typ elementu. Podczas wykonywania zapytań dotyczących następujących typów ten parametr jest wymagany:

  • Raport

  • Dashboard

  • SemanticModel

  • App

  • Dataflow

Odpowiedzi

Nazwisko Typ Opis
200 OK

ItemAccessDetailsResponse

Operacja zakończyła się pomyślnie.
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — identyfikator elementu nie istnieje.

  • InvalidItemType — typ elementu jest nieprawidłowy.

Przykłady

List of users for given item ID and type example
List of users for given item ID example

List of users for given item ID and type example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users?type=Report

Przykładowa odpowiedź

Kod stanu:
200 
{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Report",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    }
  ]
}

List of users for given item ID example

Przykładowe żądanie

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Przykładowa odpowiedź

Kod stanu:
200 
{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll",
          "viewOutput"
        ]
      }
    },
    {
      "principal": {
        "id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare",
          "Explore"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    },
    {
      "principal": {
        "id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
        "displayName": "TestSecurityGroup",
        "type": "Group",
        "groupDetails": {
          "groupType": "SecurityGroup"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": []
      }
    }
  ]
}

Definicje

Nazwisko Opis
EntireTenantPrincipal

Reprezentuje podmiot zabezpieczeń dzierżawy
ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
GroupPrincipal

Reprezentuje grupę zabezpieczeń.
GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
ItemAccessDetail

Szczegóły uprawnień elementu, takie jak odczyt i udostępnianie dalej.
ItemAccessDetails

Szczegóły dostępu użytkownika dla elementu.
ItemAccessDetailsResponse

Lista użytkowników z dostępem do danej jednostki.
ItemPermissions

Uprawnienia do elementu. Dodatkowe uprawnienia do elementów mogą być dodawane z upływem czasu.
ItemType

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PrincipalType

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
ServicePrincipalPrincipal

Reprezentuje jednostkę usługi Firmy Microsoft Entra.
ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Reprezentuje profil jednostki usługi.
UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.
UserPrincipal

Reprezentuje podmiot zabezpieczeń użytkownika firmy Microsoft Entra.

EntireTenantPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń dzierżawy

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

EntireTenant

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko Typ Opis
message

string

Czytelny dla człowieka opis znaczenia parametru.
name

string

Identyfikator parametru.
value

string

Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwisko Typ Opis
groupType

GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupPrincipal

Objekt

Reprezentuje grupę zabezpieczeń.

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails

GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

Group

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

GroupType

Wyliczenie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość Opis
Unknown

Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup

Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList

Podmiot zabezpieczeń jest listą dystrybucyjną.

ItemAccessDetail

Objekt

Szczegóły uprawnień elementu, takie jak odczyt i udostępnianie dalej.

Nazwisko Typ Opis
additionalPermissions

string[]

Uprawnienia obciążenia, takie jak readAll i viewOutput.
permissions

ItemPermissions[]

Uprawnienia do elementu, takie jak odczyt i udostępnianie dalej.
type

ItemType

Typ jednostki.

ItemAccessDetails

Objekt

Szczegóły dostępu użytkownika dla elementu.

Nazwisko Typ Opis
itemAccessDetails

ItemAccessDetail

Uprawnienia elementu dla użytkownika.
principal Principal:

Informacje dotyczące użytkownika, który ma dostęp do jednostki.

ItemAccessDetailsResponse

Objekt

Lista użytkowników z dostępem do danej jednostki.

Nazwisko Typ Opis
accessDetails

ItemAccessDetails[]

Lista użytkowników z dostępem do jednostki.

ItemPermissions

Wyliczenie

Uprawnienia do elementu. Dodatkowe uprawnienia do elementów mogą być dodawane z upływem czasu.

Wartość Opis
Read

Użytkownik może odczytać metadane dotyczące elementu.
Write

Użytkownik może wykonywać operacje zapisu na elemencie.
Reshare

Użytkownik może udostępnić element innym użytkownikom.
Explore

Użytkownik może tworzyć elementy na innych elementach.
Execute

Użytkownik może wykonywać i anulować zadania elementów.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość Opis
Dashboard

Pulpit nawigacyjny usługi Power BI.
Report

Raport usługi Power BI.
SemanticModel

Model semantyczny usługi PowerBI.
PaginatedReport

Raport podzielony na strony usługi PowerBI.
Datamart

Datamart usługi Power BI.
Lakehouse

Jezioro.
Eventhouse

Magazyn zdarzeń.
Environment

Środowisko.
KQLDatabase

Baza danych KQL.
KQLQueryset

Zestaw zapytań KQL.
KQLDashboard

Pulpit nawigacyjny KQL.
DataPipeline

Potok danych.
Notebook

Zeszyt.
SparkJobDefinition

Definicja zadania platformy Spark.
MLExperiment

Eksperyment uczenia maszynowego.
MLModel

Model uczenia maszynowego.
Warehouse

Magazyn.
Eventstream

Strumień zdarzeń.
SQLEndpoint

Punkt końcowy SQL.
MirroredWarehouse

Dublowany magazyn.
MirroredDatabase

Dublowana baza danych.
Reflex

Refleks.
GraphQLApi

Interfejs API dla elementu GraphQL.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Baza danych SQLDatabase.
CopyJob

Zadanie kopiowania.
VariableLibrary

ZmiennaLibrary.
Dataflow

Przepływ danych.
ApacheAirflowJob

Zadanie ApacheAirflowJob.
WarehouseSnapshot

Migawka magazynu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog

Dublowany wykaz usługi Azure Databricks.
Map

Mapa.
AnomalyDetector

Wykrywacz anomalii.
UserDataFunction

Funkcja danych użytkownika.
GraphModel

Model programu Graph.
GraphQuerySet

Zestaw zapytań programu Graph.
SnowflakeDatabase

Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Baza danych usługi Cosmos DB.
Ontology

Ontologia.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.
PolicySet

Zestaw zasad.
AppBackend

Element AppBackend.
OrgApp

Aplikacja organizacji.
OrgAppAudience

Odbiorcy aplikacji organizacji.
DataBuildToolJob

Obiekt DataBuildToolJob.
AzureDatabricksStorage

Element magazynu oparty na usłudze OneLake dla Azure Databricks.
Plan

Plan.
Monitoring

Element monitorowania.
DeploymentPlan

Plan wdrożenia.
ShareSubscription

Subskrypcja udziału.
Share

Udział.

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość Opis
User

Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.
ServicePrincipal

Jednostka jest jednostką usługi Microsoft Entra.
Group

Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile

Jednostka jest profilem jednostki usługi.
EntireTenant

Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwisko Typ Opis
aadAppId

string (uuid)

Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Reprezentuje jednostkę usługi Firmy Microsoft Entra.

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails

ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
type string:

ServicePrincipal

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwisko Typ Opis
parentPrincipal Principal:

Jednostka nadrzędna profilu jednostki usługi.

ServicePrincipalProfilePrincipal

Objekt

Reprezentuje profil jednostki usługi.

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwisko Typ Opis
userPrincipalName

string

Główna nazwa użytkownika.

UserPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń użytkownika firmy Microsoft Entra.

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

User

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails

UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.