Items - Get Item

Dienst:: Admin

API-Version:: v1

Gibt das angegebene Fabric- oder PowerBI-Element zurück.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Permissions

Der Aufrufer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.

Erforderliche delegierte Bereiche

Tenant.Read.All oder Tenant.ReadWrite.All

Limitations

Maximal 200 Anforderungen pro Stunde.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity	Support
User	Yes
Service Principal und Verwaltete Identitäten	Yes

Interface

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
type	query		string	Der Typ des Elements. Bei der Abfrage nach den folgenden Typen ist dieser Parameter erforderlich: Report Dashboard SemanticModel App Dataflow

Name

Erforderlich

Typ

Beschreibung

itemId

path

True

string (uuid)

Die Element-ID

workspaceId

path

True

string (uuid)

Die Arbeitsbereichs-ID.

type

query

string

Der Typ des Elements. Bei der Abfrage nach den folgenden Typen ist dieser Parameter erforderlich:

Report
Dashboard
SemanticModel
App
Dataflow

Antworten

Name	Typ	Beschreibung
200 OK	Item	OK
Other Status Codes	ErrorResponse	Häufige Fehlercodes: ItemNotFound – Element-ID ist nicht vorhanden. InvalidItemType – Elementtyp ist ungültig.

Name

Typ

Beschreibung

200 OK

Item

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

ItemNotFound – Element-ID ist nicht vorhanden.
InvalidItemType – Elementtyp ist ungültig.

Beispiele

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  }
}

Get item details by ID example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  }
}

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.
Item	Elementdetails.
ItemState	Der Elementstatus. Zusätzliche Elementzustände können im Laufe der Zeit hinzugefügt werden.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
Principal	Stellt eine Identität oder eine Microsoft Entra-Gruppe dar.
PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GroupDetails

Objekt

Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp Groupist.

Name	Typ	Beschreibung
groupType	GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

GroupType

Enumeration

Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Unknown	Der Prinzipalgruppentyp ist unbekannt.
SecurityGroup	Prinzipal ist eine Sicherheitsgruppe.
DistributionList	Prinzipal ist eine Verteilerliste.

Item

Objekt

Elementdetails.

Name	Typ	Beschreibung
capacityId	string (uuid)	Die Kapazitäts-ID des Arbeitsbereichs.
creatorPrincipal	Principal	Der Besitzer des Elements.
description	string	Elementdetails, einschließlich Elementtyp und Elementverwendung.
folderId	string (uuid)	Die Ordner-ID des Elements.
id	string (uuid)	Die Element-ID.
lastUpdatedDate	string (date-time)	Datum und Uhrzeit der letzten Aktualisierung.
name	string	Der Elementname.
state	ItemState	Der Elementstatus.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp. Enthält Werte wie Synapse, Notebook, Kqldatabase und SynapseWorkbook.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID des Elements.

ItemState

Enumeration

Der Elementstatus. Zusätzliche Elementzustände können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Active	Ein aktives Element.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notebook
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Ereignisstream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.
Ontology	Eine Ontologie.
EventSchemaSet	Ein EventSchemaSet.

Principal

Objekt

Stellt eine Identität oder eine Microsoft Entra-Gruppe dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
groupDetails	GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalDetails	ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
type	PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
userDetails	UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

PrincipalType

Enumeration

Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Wert	Beschreibung
User	Prinzipal ist ein Microsoft Entra-Benutzerprinzipal.
ServicePrincipal	Prinzipal ist ein Microsoft Entra-Dienstprinzipal.
Group	Prinzipal ist eine Sicherheitsgruppe.
ServicePrincipalProfile	Prinzipal ist ein Dienstprinzipalprofil.
EntireTenant	Prinzipal stellt alle Mandantenbenutzer dar.

ServicePrincipalDetails

Objekt

Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp ServicePrincipalist.

Name	Typ	Beschreibung
aadAppId	string (uuid)	Die Microsoft Entra AppId des Dienstprinzipals.

ServicePrincipalProfileDetails

Objekt

Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp ServicePrincipalProfileist.

Name	Typ	Beschreibung
parentPrincipal	Principal	Der übergeordnete Prinzipal des Dienstprinzipals.

UserDetails

Objekt

Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp Userist.

Name	Typ	Beschreibung
userPrincipalName	string	Der Benutzerprinzipalname.

Freigeben über

Items - Get Item

Permissions

Erforderliche delegierte Bereiche

Limitations

Von Microsoft Entra unterstützte Identitäten

Interface

URI-Parameter

Antworten

Beispiele

Get item details by ID and type example

Beispielanforderung

Beispiel für eine Antwort

Get item details by ID example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails