Items - List Items

Servizio:: Admin

Versione API:: v1

Restituisce un elenco di elementi attivi di Fabric e PowerBI.

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.

Questa API supporta paginazione. È possibile restituire un massimo di 10.000 record per ogni richiesta. Con il token continuo fornito nella risposta, è possibile ottenere i 10.000 record successivi.

Ordine pagina:

Elementi dell'infrastruttura
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

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/items

Con parametri facoltativi:

GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

Parametri dell'URI

Nome	In	Tipo	Descrizione
capacityId	query	string (uuid)	ID di capacità dell'area di lavoro.
continuationToken	query	string	Token continuo usato per ottenere gli elementi della pagina successiva.
state	query	string	Stato dell'elemento. Gli stati supportati sono attivi.
type	query	string	Tipo di elemento.
workspaceId	query	string (uuid)	ID dell'area di lavoro.

Risposte

Nome	Tipo	Descrizione
200 OK	Items	Operazione riuscita.
Other Status Codes	ErrorResponse	Codici di errore comuni: ItemNotFound: l'ID dell'elemento non esiste. InvalidItemType: il tipo di elemento non è valido. InvalidItemState: lo stato dell'elemento non è valido.

Nome

Tipo

Descrizione

200 OK

Items

Operazione riuscita.

Other Status Codes

ErrorResponse

Codici di errore comuni:

ItemNotFound: l'ID dell'elemento non esiste.
InvalidItemType: il tipo di elemento non è valido.
InvalidItemState: lo stato dell'elemento non è valido.

Esempio

Get a list of items using type query parameter example

Get all items in the tenant example

Get list of datamarts using type query parameter example

Get a list of items using type query parameter example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

Risposta di esempio

Codice di stato:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Report",
      "name": "Test Report",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "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"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items

Risposta di esempio

Codice di stato:: 200

{
  "itemEntities": [
    {
      "id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "Notebook",
      "name": "Test",
      "description": "Test notebook.",
      "state": "Active",
      "lastUpdatedDate": "2022-04-29T17:47:29.98673",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    },
    {
      "id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "KQLDatabase",
      "name": "TestKusto",
      "description": "Test KQL database.",
      "state": "Active",
      "lastUpdatedDate": "2022-06-30T17:47:29.98673",
      "workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Get list of datamarts using type query parameter example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

Risposta di esempio

Codice di stato:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Lakehouse",
      "name": "Lakehouse 2022-03-16T21:42:38.442Z",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "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"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

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.
Items	Elenco di elementi.
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

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

Oggetto

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

Oggetto

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

Oggetto

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

Enumerazione

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

Oggetto

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.

Items

Oggetto

Elenco di elementi.

Nome	Tipo	Descrizione
continuationToken	string	Token per il batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
continuationUri	string	URI del batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
itemEntities	Item[]	Elenco di elementi per un determinato tenant.

ItemState

Enumerazione

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

Valore	Descrizione
Active	Elemento attivo.

ItemTag

Oggetto

Rappresenta un tag applicato a un elemento.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

ItemType

Enumerazione

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

Oggetto

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

Enumerazione

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

Oggetto

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

Nome	Tipo	Descrizione
aadAppId	string (uuid)	Microsoft Entra AppId dell'entità servizio.

ServicePrincipalProfileDetails

Oggetto

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

Oggetto

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

Nome	Tipo	Descrizione
userPrincipalName	string	Nome dell'entità utente.

Condividi tramite

Items - List Items

Permissions

Ambiti delegati obbligatori

Limitations

Identità supportate da Microsoft Entra

Interface

Parametri dell'URI

Risposte

Esempio

Get a list of items using type query parameter example

Esempio di richiesta

Risposta di esempio

Get all items in the tenant example

Esempio di richiesta

Risposta di esempio

Get list of datamarts using type query parameter example

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails