Items - Get Item

Usługa:: Admin

Wersja interfejsu API:: v1

Zwraca określony element Fabric lub Power BI.

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 Fabric 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.

Microsoft Entra obsługiwane tożsamości

Ten interfejs API obsługuje Microsoft identities 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}

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	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

Nazwa

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

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	Item	OK
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.

Item

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

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Report",
  "name": "Test",
  "description": "Test Jacob's Report,",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
  "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "displayName": "Jacob Hancock",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "Jacob@example.com"
    }
  },
  "defaultIdentity": {
    "id": "ff3c8689-591c-4298-a228-4ffcc77cb661",
    "displayName": "Caleb Foster",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "caleb@example.com"
    }
  }
}

Get item details by ID example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Kusto",
  "name": "Test",
  "description": "Test Jacob's notebook.",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
  "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "displayName": "Jacob Hancock",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "Jacob@example.com"
    }
  }
}

Definicje

Nazwa	Opis
EntireTenantPrincipal	Reprezentuje podmiot zabezpieczeń dzierżawy
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.
Item	Szczegóły elementu.
ItemState	Stan elementu. Dodatkowe stany elementów można dodawać w czasie.
ItemTag	Reprezentuje tag zastosowany w elemencie.
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 Microsoft Entra jednostkę usługi.
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 Microsoft Entra podmiot zabezpieczeń użytkownika.

EntireTenantPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń dzierżawy

Nazwa	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.

ErrorRelatedResource

Objekt

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

Nazwa	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.

Nazwa	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.
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.

Nazwa	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.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

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

Nazwa	Typ	Opis
groupType	GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupPrincipal

Objekt

Reprezentuje grupę zabezpieczeń.

Nazwa	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ą.

Item

Objekt

Szczegóły elementu.

Nazwa	Typ	Opis
capacityId	string (uuid)	Identyfikator pojemności obszaru roboczego.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Właściciel elementu.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tożsamość domyślna elementu.
description	string	Szczegóły elementu, w tym typ elementu i użycie elementu.
folderId	string (uuid)	Identyfikator folderu elementu.
id	string (uuid)	Identyfikator elementu.
lastUpdatedDate	string (date-time)	Data i godzina ostatniej aktualizacji.
name	string	Nazwa elementu.
state	ItemState	Stan elementu.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu. Zawiera wartości, takie jak Synapse, Notebook, Kqldatabase i SynapseWorkbook.
workspaceId	string (uuid)	Identyfikator obszaru roboczego elementu.

ItemState

Wyliczenie

Stan elementu. Dodatkowe stany elementów można dodawać w czasie.

Wartość	Opis
Active	Aktywny element.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

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.
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.

PrincipalType

Wyliczenie

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

Wartość	Opis
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń Microsoft Entra użytkownika.
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.

Nazwa	Typ	Opis
aadAppId	string (uuid)	Microsoft Entra AppId jednostki usługi.

ServicePrincipalPrincipal

Objekt

Reprezentuje Microsoft Entra jednostkę usługi.

Nazwa	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.

Nazwa	Typ	Opis
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Jednostka nadrzędna profilu jednostki usługi.

ServicePrincipalProfilePrincipal

Objekt

Reprezentuje profil jednostki usługi.

Nazwa	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.

Nazwa	Typ	Opis
userPrincipalName	string	Główna nazwa użytkownika.

UserPrincipal

Objekt

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

Nazwa	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`.