Freigeben über


Items - Create Item

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 Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

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.

folderId

string (uuid)

Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird das Element mit dem Arbeitsbereich als Ordner erstellt.

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.

  • FolderNotFound – Der angeforderte Ordner konnte nicht gefunden werden.

  • WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

Create an item example
Create an item in folder example

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

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

Create an item in folder example

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items

{
  "displayName": "Item 1",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Beispiel für eine Antwort

{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "id": "cccccccc-2222-3333-4444-dddddddddddd"
}
Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
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.

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.

PayloadType

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

CreateItemRequest

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.

folderId

string (uuid)

Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird das Element mit dem Arbeitsbereich als Ordner erstellt.

type

ItemType

Der Elementtyp.

ErrorRelatedResource

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

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

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

Ein Elementobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.

displayName

string

Der Anzeigename des Elements.

folderId

string (uuid)

Die Ordner-ID.

id

string (uuid)

Die Element-ID.

tags

ItemTag[]

Liste der angewendeten Tags.

type

ItemType

Der Elementtyp.

workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

ItemDefinition

Ein Elementdefinitionsobjekt.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.

parts

ItemDefinitionPart[]

Eine Liste der Definitionsteile.

ItemDefinitionPart

Ein Elementdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Elementteilpfad.

payload

string

Die Nutzlast des Elementteils.

payloadType

PayloadType

Der Nutzlasttyp.

ItemTag

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

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 Notizbuch.

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.

PayloadType

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

Wert Beschreibung
InlineBase64

Inlinebasis 64.