Condividi tramite


Items - Get Item

Restituisce l'elemento Fabric o PowerBI specificato.

Note

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.

Permissions

Il chiamante deve essere un amministratore di Fabric o eseguire l'autenticazione usando un'entità servizio.

Ambiti delegati obbligatori

Tenant.Read.All o Tenant.ReadWrite.All

Limitations

Massimo 200 richieste all'ora.

Identità supportate da Microsoft Entra

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

Identity Support
User Yes
Principale del servizio e Identità gestite Yes

Interface

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
itemId
path True

string (uuid)

ID elemento

workspaceId
path True

string (uuid)

ID dell'area di lavoro.

type
query

string

Tipo dell'elemento. Quando si eseguono query per i tipi seguenti, questo parametro è obbligatorio:

  • Report

  • Dashboard

  • SemanticModel

  • App

  • Dataflow

Risposte

Nome Tipo Descrizione
200 OK

Item

OK

Other Status Codes

ErrorResponse

Codici di errore comuni:

  • ItemNotFound: l'ID dell'elemento non esiste.

  • InvalidItemType: il tipo di elemento non è valido.

Esempio

Get item details by ID and type example
Get item details by ID example

Get item details by ID and type example

Esempio di richiesta

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

Risposta di esempio

{
  "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

Esempio di richiesta

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

Risposta di esempio

{
  "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"
    }
  }
}

Definizioni

Nome Descrizione
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.

ErrorResponse

Risposta di errore.

ErrorResponseDetails

Dettagli della risposta di errore.

GroupDetails

Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.

GroupType

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Item

Dettagli dell'elemento.

ItemState

Stato dell'elemento. È possibile aggiungere altri stati di elemento nel tempo.

ItemTag

Rappresenta un tag applicato a un elemento.

ItemType

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Principal

Rappresenta un'identità o un gruppo Microsoft Entra.

PrincipalType

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ServicePrincipalDetails

Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.

ServicePrincipalProfileDetails

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.

UserDetails

Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.

ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.

resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.

message

string

Rappresentazione leggibile dell'errore.

moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.

relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

requestId

string

ID della richiesta associata all'errore.

ErrorResponseDetails

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.

message

string

Rappresentazione leggibile dell'errore.

relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

GroupDetails

Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.

Nome Tipo Descrizione
groupType

GroupType

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

GroupType

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Valore Descrizione
Unknown

Il tipo di gruppo principale è sconosciuto.

SecurityGroup

Principal è un gruppo di sicurezza.

DistributionList

Principal è una lista di distribuzione.

Item

Dettagli dell'elemento.

Nome Tipo Descrizione
capacityId

string (uuid)

ID di capacità dell'area di lavoro.

creatorPrincipal

Principal

Proprietario dell'elemento.

description

string

Dettagli dell'elemento, inclusi il tipo di elemento e l'utilizzo dell'elemento.

folderId

string (uuid)

ID cartella dell'elemento.

id

string (uuid)

ID elemento.

lastUpdatedDate

string (date-time)

Data e ora dell'ultimo aggiornamento.

name

string

Nome dell'elemento.

state

ItemState

Stato dell'elemento.

tags

ItemTag[]

Elenco di tag applicati.

type

ItemType

Tipo di elemento. Include valori come Synapse, Notebook, Kqldatabase e SynapseWorkbook.

workspaceId

string (uuid)

ID dell'area di lavoro dell'elemento.

ItemState

Stato dell'elemento. È possibile aggiungere altri stati di elemento nel tempo.

Valore Descrizione
Active

Elemento attivo.

ItemTag

Rappresenta un tag applicato a un elemento.

Nome Tipo Descrizione
displayName

string

Nome del tag.

id

string (uuid)

ID tag.

ItemType

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore Descrizione
Dashboard

Dashboard di Power BI.

Report

Report di Power BI.

SemanticModel

Modello semantico di PowerBI.

PaginatedReport

Report impaginato di Power BI.

Datamart

Datamart di PowerBI.

Lakehouse

Una lakehouse.

Eventhouse

Una casa eventi.

Environment

Un ambiente.

KQLDatabase

Un database KQL.

KQLQueryset

Set di query KQL.

KQLDashboard

Dashboard KQL.

DataPipeline

Una pipeline di dati.

Notebook

Un notebook.

SparkJobDefinition

Definizione di processo Spark.

MLExperiment

Esperimento di Machine Learning.

MLModel

Modello di Machine Learning.

Warehouse

Un magazzino.

Eventstream

Flusso di eventi.

SQLEndpoint

Endpoint SQL.

MirroredWarehouse

Magazzino con mirroring.

MirroredDatabase

Database con mirroring.

Reflex

Un riflesso.

GraphQLApi

API per l'elemento GraphQL.

MountedDataFactory

Oggetto MountedDataFactory.

SQLDatabase

A SQLDatabase.

CopyJob

Processo di copia.

VariableLibrary

VariabileLibrary.

Dataflow

Flusso di dati.

ApacheAirflowJob

An ApacheAirflowJob.

WarehouseSnapshot

Uno snapshot del warehouse.

DigitalTwinBuilder

A DigitalTwinBuilder.

DigitalTwinBuilderFlow

Flusso di Generatore di gemelli digitali.

MirroredAzureDatabricksCatalog

Catalogo di Azure databricks con mirroring.

Map

Una mappa.

AnomalyDetector

Rilevamento anomalie.

UserDataFunction

Funzione dati utente.

GraphModel

A GraphModel.

GraphQuerySet

Oggetto Graph QuerySet.

SnowflakeDatabase

Un database Snowflake per archiviare le tabelle Iceberg create dall'account Snowflake.

OperationsAgent

Oggetto OperationsAgent.

CosmosDBDatabase

Un database Cosmos DB.

Ontology

Ontologia.

EventSchemaSet

An EventSchemaSet.

Principal

Rappresenta un'identità o un gruppo Microsoft Entra.

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.

groupDetails

GroupDetails

Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.

id

string (uuid)

ID dell'entità.

servicePrincipalDetails

ServicePrincipalDetails

Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.

type

PrincipalType

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

userDetails

UserDetails

Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.

PrincipalType

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

Valore Descrizione
User

Principal è un'entità utente di Microsoft Entra.

ServicePrincipal

Principal è un'entità servizio Microsoft Entra.

Group

Principal è un gruppo di sicurezza.

ServicePrincipalProfile

Principal è un profilo dell'entità servizio.

EntireTenant

Principal rappresenta tutti gli utenti tenant.

ServicePrincipalDetails

Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.

Nome Tipo Descrizione
aadAppId

string (uuid)

Microsoft Entra AppId dell'entità servizio.

ServicePrincipalProfileDetails

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.

Nome Tipo Descrizione
parentPrincipal

Principal

Entità padre del profilo dell'entità servizio.

UserDetails

Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.

Nome Tipo Descrizione
userPrincipalName

string

Nome dell'entità utente.