Items - Create Digital Twin Builder

Dienst:: DigitalTwinBuilder

API-Version:: v1

Erstellt einen DigitalTwinBuilder im angegebenen Arbeitsbereich.

Note

Digital Twin Builder-Element befindet sich derzeit in der Vorschau (weitere Informationen).

Diese API unterstützt LRO-.

Informationen zum Erstellen von digitaltwinbuilder mit Definition finden Sie in der Definition von DigitalTwinBuilder.

Permissions

Der Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

DigitalTwinBuilder.ReadWrite.All oder Item.ReadWrite.All

Limitations

Um einen digitaltwinbuilder zu erstellen, muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befindet. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

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

Identity	Support
User	Yes
Service Principal und Verwaltete Identitäten	No

Interface

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

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 digitaltwinbuilder. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen, d. h. Er sollte mit dem Buchstaben beginnen, hat nur Zahlen und Buchstaben oder _ und ist kleiner als 100.
definition		DigitalTwinBuilderDefinition	Die öffentliche Definition "DigitalTwinBuilder".
description		string	Die Beschreibung des digitaltwinbuilder. Die maximale Länge beträgt 256 Zeichen.

Antworten

Name	Typ	Beschreibung
201 Created	DigitalTwinBuilder	Erfolgreich erstellt
202 Accepted		Akzeptierte, digitaltwinbuilder-Bereitstellung 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. WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Name

Typ

Beschreibung

201 Created

DigitalTwinBuilder

Erfolgreich erstellt

202 Accepted

Akzeptierte, digitaltwinbuilder-Bereitstellung 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.
WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

Create a digitaltwinbuilder example

Create a digitaltwinbuilder with public definition example

Create a digitaltwinbuilder example

Beispielanforderung

HTTP

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

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description."
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "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

Create a digitaltwinbuilder with public definition example

Beispielanforderung

HTTP

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

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047655"
}

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
CreateDigitalTwinBuilderRequest	Erstellen Sie die Nutzlast der Digitaltwinbuilder-Anforderung.
DigitalTwinBuilder	Ein digitaltwinbuilder-Objekt.
DigitalTwinBuilderDefinition	Öffentliches Definitionsobjekt "DigitalTwinBuilder".
DigitalTwinBuilderDefinitionPart	DigitalTwinBuilder-Definitionsteilobjekt.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
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.

CreateDigitalTwinBuilderRequest

Objekt

Erstellen Sie die Nutzlast der Digitaltwinbuilder-Anforderung.

Name	Typ	Beschreibung
definition	DigitalTwinBuilderDefinition	Die öffentliche Definition "DigitalTwinBuilder".
description	string	Die Beschreibung des digitaltwinbuilder. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Anzeigename des digitaltwinbuilder. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen, d. h. Er sollte mit dem Buchstaben beginnen, hat nur Zahlen und Buchstaben oder _ und ist kleiner als 100.

DigitalTwinBuilder

Objekt

Ein digitaltwinbuilder-Objekt.

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.

DigitalTwinBuilderDefinition

Objekt

Öffentliches Definitionsobjekt "DigitalTwinBuilder".

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	DigitalTwinBuilderDefinitionPart[]	Eine Liste der Definitionsteile.

DigitalTwinBuilderDefinitionPart

Objekt

DigitalTwinBuilder-Definitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Teilpfad "DigitalTwinBuilder".
payload	string	Die Nutzlast des DigitalTwinBuilder-Teils.
payloadType	PayloadType	Der Nutzlasttyp.

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.

ItemTag

Objekt

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

Enumeration

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 Notebook
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

Enumeration

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

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

Freigeben über

Items - Create Digital Twin Builder

Permissions

Erforderliche delegierte Bereiche

Limitations

Von Microsoft Entra unterstützte Identitäten

Interface

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a digitaltwinbuilder example

Beispielanforderung

Beispiel für eine Antwort

Create a digitaltwinbuilder with public definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CreateDigitalTwinBuilderRequest

DigitalTwinBuilder

DigitalTwinBuilderDefinition

DigitalTwinBuilderDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType