Freigeben über

Items - Create Item

  • Referenz
Dienst:
Core
API-Version:
v1

Erstellt ein Element im angegebenen Arbeitsbereich.
Diese API wird für eine Reihe von Elementtypen unterstützt, finden Sie die unterstützten Elementtypen in Elementverwaltungsübersicht. Sie können Elementdefinitions-API zum Abrufen einer Elementdefinition verwenden.

Diese API unterstützt LRO-.

Erlaubnisse

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Verwenden Sie für Element-APIs die folgenden Bereichstypen:

  • Allgemeiner Bereich: Item.ReadWrite.All
  • Bestimmter Bereich: itemType-. ReadWrite.All (z. B.: Notebook.ReadWrite.All)

weitere Informationen zu Bereichen finden Sie im Artikel Bereiche.

Begrenzungen

  • Um ein Nicht-PowerBI Fabric-Element zu erstellen, muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befindet. Weitere Informationen finden Sie unter Microsoft Fabric-Lizenztypen.
  • Um ein PowerBI-Element zu erstellen, muss der Benutzer über die entsprechende Lizenz verfügen. Weitere Informationen finden Sie unter Microsoft Fabric-Lizenztypen.
  • Verwenden Sie beim Erstellen eines Elements entweder creationPayload oder definition, verwenden Sie jedoch nicht beide gleichzeitig.

Von Microsoft Entra unterstützte Identitäten

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

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Wenn der Elementtyp im Anruf unterstützt wird. Überprüfen Sie die entsprechende API für den elementtyp, den Sie aufrufen, um festzustellen, ob Ihr Aufruf unterstützt wird. So werden z. B. semantische Modelle unterstützt.

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string

uuid

Die Arbeitsbereichs-ID.

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

Der Anzeigename des Elements. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
type True

ItemType

Der Elementtyp.
creationPayload

object

Eine Reihe von Eigenschaften, die zum Erstellen des Elements verwendet werden. Die Seite "Element erstellen" des relevanten Typs gibt an, ob creationPayload unterstützt wird, und listet die Eigenschaften des Elements auf. Verwenden Sie creationPayload oder definition. Sie können beide nicht gleichzeitig verwenden.
definition

ItemDefinition

Die Elementdefinition. Die Seite "Element erstellen" des relevanten Typs gibt an, ob die Definition unterstützt wird, und zeigt die Struktur an. Verwenden Sie definition oder creationPayload. Sie können beide nicht gleichzeitig verwenden.
description

string

Die Elementbeschreibung. Die maximale Länge beträgt 256 Zeichen.

Antworten

Name Typ Beschreibung
201 Created

Item

Erfolgreich erstellt
202 Accepted

Akzeptierte Anforderung, Bereitstellung von Elementen in Bearbeitung

Header

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

ErrorResponse

Häufige Fehlercodes:

  • InvalidItemType – Elementtyp ist ungültig.

  • ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Create an item example

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Statuscode:
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

Definitionen

Name Beschreibung
CreateItemRequest

Elementanforderungsnutzlast erstellen.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Item

Ein Elementobjekt.
ItemDefinition

Ein Elementdefinitionsobjekt.
ItemDefinitionPart

Ein Elementdefinitionsteilobjekt.
ItemType

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

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

CreateItemRequest

Objekt

Elementanforderungsnutzlast erstellen.

Name Typ Beschreibung
creationPayload

object

Eine Reihe von Eigenschaften, die zum Erstellen des Elements verwendet werden. Die Seite "Element erstellen" des relevanten Typs gibt an, ob creationPayload unterstützt wird, und listet die Eigenschaften des Elements auf. Verwenden Sie creationPayload oder definition. Sie können beide nicht gleichzeitig verwenden.
definition

ItemDefinition

Die Elementdefinition. Die Seite "Element erstellen" des relevanten Typs gibt an, ob die Definition unterstützt wird, und zeigt die Struktur an. Verwenden Sie definition oder creationPayload. Sie können beide nicht gleichzeitig verwenden.
description

string

Die Elementbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Elements. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
type

ItemType

Der Elementtyp.

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.

Item

Objekt

Ein Elementobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
id

string

uuid

Die Element-ID.
type

ItemType

Der Elementtyp.
workspaceId

string

uuid

Die Arbeitsbereichs-ID.

ItemDefinition

Objekt

Ein Elementdefinitionsobjekt.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

ItemDefinitionPart[]

Eine Liste der Definitionsteile.

ItemDefinitionPart

Objekt

Ein Elementdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Elementteilpfad.
payload

string

Die Nutzlast des Elementteils.
payloadType

PayloadType

Der Nutzlasttyp.

ItemType

Enumeration

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

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
DataPipeline

Eine Datenpipeline.
Datamart

PowerBI datamart.
Environment

Eine Umgebung.
Eventhouse

Ein Eventhouse.
Eventstream

Ein Ereignisstream.
GraphQLApi

Eine API für GraphQL-Element.
KQLDashboard

Ein KQL-Dashboard.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
Lakehouse

Ein Seehaus.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
MirroredDatabase

Eine gespiegelte Datenbank.
MirroredWarehouse

Ein gespiegeltes Lager.
MountedDataFactory

Eine MountedDataFactory.
Notebook

Ein Notizbuch.
PaginatedReport

PowerBI-Paginated-Bericht.
Reflex

Ein Reflex.
Report

PowerBI-Bericht.
SQLDatabase

Eine SQLDatabase.
SQLEndpoint

Ein SQL-Endpunkt.
SemanticModel

PowerBI-Semantikmodell.
SparkJobDefinition

Eine Sparkauftragsdefinition.
Warehouse

Ein Lagerhaus.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.