Condividi tramite

Items - Create Item

  • Riferimento
Servizio:
Core
Versione API:
v1

Crea un elemento nell'area di lavoro specificata.
Questa API è supportata per diversi tipi di elementi, trovare i tipi di elemento supportati in Panoramica della gestione degli elementi. È possibile usare 'API Get item definition per ottenere una definizione di elemento.

Questa API supporta operazioni con esecuzione prolungata (LRO).

Autorizzazioni

Il chiamante deve avere ruolo collaboratore o superiore dell'area di lavoro.

Ambiti delegati obbligatori

Per le API degli elementi, usare questi tipi di ambito:

  • Ambito generico: Item.ReadWrite.All
  • Ambito specifico: itemType. ReadWrite.All (ad esempio: Notebook.ReadWrite.All)

Per altre informazioni sugli ambiti, vedere l'articolo ambiti.

Limitazioni

  • Per creare un elemento non di PowerBI Fabric, l'area di lavoro deve trovarsi in una capacità di Infrastruttura supportata. Per altre informazioni, vedere tipi di licenza di Microsoft Fabric.
  • Per creare un elemento di PowerBI, l'utente deve avere la licenza appropriata. Per altre informazioni, vedere tipi di licenza di Microsoft Fabric.
  • Quando si crea un elemento, usare creationPayload o definition, ma non usare entrambi contemporaneamente.

Identità supportate da Microsoft Entra

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

Identità Appoggiare
Utente Sì
'entità servizio e identità gestite Quando il tipo di elemento nella chiamata è supportato. Controllare l'API corrispondente per il tipo di elemento che si sta chiamando per verificare se la chiamata è supportata. Ad esempio, i modelli semantici sono supportati.

Interfaccia

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items

Parametri dell'URI

Nome In Necessario Tipo Descrizione
workspaceId
 path True

string

uuid

ID dell'area di lavoro.

Corpo della richiesta

Nome Necessario Tipo Descrizione
displayName True

string

Nome visualizzato dell'elemento. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
type True

ItemType

Tipo di elemento.
creationPayload

object

Set di proprietà utilizzate per creare l'elemento. La pagina Crea elemento del tipo pertinente indica se creationPayload è supportato ed elenca le proprietà dell'elemento. Usare creationPayload o definition. Non è possibile usare entrambi contemporaneamente.
definition

ItemDefinition

Definizione dell'elemento. La pagina Crea elemento del tipo pertinente indica se la definizione è supportata e ne descrive la struttura. Usare definition o creationPayload. Non è possibile usare entrambi contemporaneamente.
description

string

Descrizione dell'elemento. La lunghezza massima è di 256 caratteri.

Risposte

Nome Tipo Descrizione
201 Created

Item

Creazione completata
202 Accepted

Richiesta accettata, provisioning degli elementi in corso

Intestazioni

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • InvalidItemType: il tipo di elemento non è valido.

  • ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato.

  • CorruptedPayload : il payload fornito è danneggiato

Esempio

Create an item example

Esempio di richiesta

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

Risposta di esempio

Codice di stato:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Codice di stato:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definizioni

Nome Descrizione
CreateItemRequest

Creare il payload della richiesta di elementi.
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
Item

Oggetto elemento.
ItemDefinition

Oggetto definizione dell'elemento.
ItemDefinitionPart

Oggetto parte di definizione dell'elemento.
ItemType

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

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

CreateItemRequest

Object

Creare il payload della richiesta di elementi.

Nome Tipo Descrizione
creationPayload

object

Set di proprietà utilizzate per creare l'elemento. La pagina Crea elemento del tipo pertinente indica se creationPayload è supportato ed elenca le proprietà dell'elemento. Usare creationPayload o definition. Non è possibile usare entrambi contemporaneamente.
definition

ItemDefinition

Definizione dell'elemento. La pagina Crea elemento del tipo pertinente indica se la definizione è supportata e ne descrive la struttura. Usare definition o creationPayload. Non è possibile usare entrambi contemporaneamente.
description

string

Descrizione dell'elemento. La lunghezza massima è di 256 caratteri.
displayName

string

Nome visualizzato dell'elemento. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
type

ItemType

Tipo di elemento.

ErrorRelatedResource

Object

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

Object

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

Object

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.

Item

Object

Oggetto elemento.

Nome Tipo Descrizione
description

string

Descrizione dell'elemento.
displayName

string

Nome visualizzato dell'elemento.
id

string

uuid

ID elemento.
type

ItemType

Tipo di elemento.
workspaceId

string

uuid

ID dell'area di lavoro.

ItemDefinition

Object

Oggetto definizione dell'elemento.

Nome Tipo Descrizione
format

string

Formato della definizione dell'elemento.
parts

ItemDefinitionPart[]

Elenco di parti di definizione.

ItemDefinitionPart

Object

Oggetto parte di definizione dell'elemento.

Nome Tipo Descrizione
path

string

Percorso della parte dell'elemento.
payload

string

Payload della parte dell'elemento.
payloadType

PayloadType

Tipo di payload.

ItemType

Enumeration

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

Valore Descrizione
Dashboard

Dashboard di Power BI.
DataPipeline

Una pipeline di dati.
Datamart

Datamart di PowerBI.
Environment

Un ambiente.
Eventhouse

Una casa eventi.
Eventstream

Flusso di eventi.
GraphQLApi

API per l'elemento GraphQL.
KQLDashboard

Dashboard KQL.
KQLDatabase

Un database KQL.
KQLQueryset

Set di query KQL.
Lakehouse

Una lakehouse.
MLExperiment

Esperimento di Machine Learning.
MLModel

Modello di Machine Learning.
MirroredDatabase

Database con mirroring.
MirroredWarehouse

Magazzino con mirroring.
MountedDataFactory

Oggetto MountedDataFactory.
Notebook

Un notebook.
PaginatedReport

Report impaginato di Power BI.
Reflex

Un riflesso.
Report

Report di Power BI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Endpoint SQL.
SemanticModel

Modello semantico di PowerBI.
SparkJobDefinition

Definizione di processo Spark.
Warehouse

Un magazzino.

PayloadType

Enumeration

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore Descrizione
InlineBase64

Inline Base 64.