Items - Create Digital Twin Builder Flow

Servizio:: DigitalTwinBuilderFlow

Versione API:: v1

Annotazioni

Questa API è disponibile in anteprima.

Crea un flusso di Generatore di gemelli digitali nell'area di lavoro specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Per creare un flusso di Generatore di gemelli digitali con una definizione pubblica, vedere l'articolo .

Autorizzazioni

Il chiamante deve avere un ruolo di area di lavoro collaboratore .

Ambiti delegati obbligatori

DigitalTwinBuilderFlow.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per creare un flusso di Generatore di gemelli digitali, l'area di lavoro deve essere in una capacità di Infrastruttura supportata. Per altre informazioni, vedere: tipi di licenza di Microsoft Fabric.

Identità supportate da Microsoft Entra

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

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato flusso del generatore di gemelli digitali. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
creationPayload		DigitalTwinBuilderFlowCreationPayload	Payload di creazione. Usare `definition` o `creationPayload`. Non è possibile usare entrambi contemporaneamente.
definition		DigitalTwinBuilderFlowPublicDefinition	Definizione pubblica del flusso del generatore di gemelli digitali.
description		string	Descrizione del flusso di Generatore di gemelli digitali. La lunghezza massima consentita è di 256 caratteri.

Risposte

Nome	Tipo	Descrizione
201 Created	DigitalTwinBuilderFlow	Creazione completata
202 Accepted		Richiesta accettata, provisioning del flusso di Digital Twin Builder in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato. CorruptedPayload: il payload fornito è danneggiato. WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato

Nome

Tipo

Descrizione

201 Created

DigitalTwinBuilderFlow

Creazione completata

202 Accepted

Richiesta accettata, provisioning del flusso di Digital Twin Builder in corso.

Intestazioni

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

InvalidItemType - Tipo di elemento non valido
ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato.
CorruptedPayload: il payload fornito è danneggiato.
WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato

Esempio

Create a Digital Twin Builder Flow example

Create a Digital Twin Builder Flow with public definition example

Create a Digital Twin Builder Flow example

Esempio di richiesta

HTTP

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

{
  "displayName": "DigitalTwinBuilderFlow 1",
  "description": "A Digital Twin Builder Flow description.",
  "creationPayload": {
    "digitalTwinBuilderItemReference": {
      "referenceType": "ById",
      "itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "DigitalTwinBuilderFlow 1",
  "description": "A Digital Twin Builder Flow description.",
  "type": "DigitalTwinBuilderFlow",
  "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

Create a Digital Twin Builder Flow with public definition example

Esempio di richiesta

HTTP

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

{
  "displayName": "DigitalTwinBuilderFlow 1",
  "description": "A Digital Twin Builder Flow description.",
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "displayName": "DigitalTwinBuilderFlow 1",
  "description": "A Digital Twin Builder Flow description.",
  "type": "DigitalTwinBuilderFlow",
  "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
CreateDigitalTwinBuilderFlowRequest	Creare il payload della richiesta flusso di Digital Twin Builder.
DigitalTwinBuilderFlow	Oggetto Flusso generatore di gemelli digitali.
DigitalTwinBuilderFlowCreationPayload	Payload di creazione del flusso di Digital Twin Builder.
DigitalTwinBuilderFlowProperties	Proprietà del flusso di Digital Twin Builder.
DigitalTwinBuilderFlowPublicDefinition	Oggetto definizione pubblica flusso del generatore di gemelli digitali. Per altre informazioni su come creare una definizione pubblica del flusso di Generatore di gemelli digitali, vedere questo articolo .
DigitalTwinBuilderFlowPublicDefinitionPart	Oggetto parte della definizione flusso di Generatore di gemelli digitali.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemReferenceById	Riferimento di un elemento in base all'oggetto ID.
ItemReferenceType	Tipo di riferimento Item. È possibile aggiungere altri tipi di `ItemReferenceType` nel tempo.
ItemTag	Rappresenta un tag applicato a un 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.

CreateDigitalTwinBuilderFlowRequest

Object

Creare il payload della richiesta flusso di Digital Twin Builder.

Nome	Tipo	Descrizione
creationPayload	DigitalTwinBuilderFlowCreationPayload	Payload di creazione. Usare `definition` o `creationPayload`. Non è possibile usare entrambi contemporaneamente.
definition	DigitalTwinBuilderFlowPublicDefinition	Definizione pubblica del flusso del generatore di gemelli digitali.
description	string	Descrizione del flusso di Generatore di gemelli digitali. La lunghezza massima consentita è di 256 caratteri.
displayName	string	Nome visualizzato flusso del generatore di gemelli digitali. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.

DigitalTwinBuilderFlow

Object

Oggetto Flusso generatore di gemelli digitali.

Nome	Tipo	Descrizione
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
folderId	string (uuid)	ID cartella.
id	string (uuid)	ID elemento.
properties	DigitalTwinBuilderFlowProperties	Proprietà del flusso di Digital Twin Builder.
tags	ItemTag[]	Elenco di tag applicati.
type	ItemType	Tipo di elemento.
workspaceId	string (uuid)	L’ID dell’area di lavoro.

DigitalTwinBuilderFlowCreationPayload

Object

Payload di creazione del flusso di Digital Twin Builder.

Nome	Tipo	Descrizione
digitalTwinBuilderItemReference	ItemReference: ItemReferenceById	Riferimento all'elemento generatore di gemelli digitali.

DigitalTwinBuilderFlowProperties

Object

Proprietà del flusso di Digital Twin Builder.

Nome	Tipo	Descrizione
digitalTwinBuilderItemReference	ItemReference: ItemReferenceById	Riferimento all'elemento generatore di gemelli digitali.

DigitalTwinBuilderFlowPublicDefinition

Object

Oggetto definizione pubblica flusso del generatore di gemelli digitali. Per altre informazioni su come creare una definizione pubblica del flusso di Generatore di gemelli digitali, vedere questo articolo .

Nome	Tipo	Descrizione
parts	DigitalTwinBuilderFlowPublicDefinitionPart[]	Elenco di parti di definizione.

DigitalTwinBuilderFlowPublicDefinitionPart

Object

Oggetto parte della definizione flusso di Generatore di gemelli digitali.

Nome	Tipo	Descrizione
path	string	Percorso della parte relativa alla definizione pubblica del flusso di Gemelli digitali.
payload	string	Payload della parte di definizione pubblica flusso di Gemelli digitali.
payloadType	PayloadType	Tipo di payload.

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.

ItemReferenceById

Object

Riferimento di un elemento in base all'oggetto ID.

Nome	Tipo	Descrizione
itemId	string (uuid)	ID dell'elemento.
referenceType	string: ById	Tipo di riferimento dell'elemento.
workspaceId	string (uuid)	ID dell'area di lavoro dell'elemento.

ItemReferenceType

Enumerazione

Tipo di riferimento Item. È possibile aggiungere altri tipi di ItemReferenceType nel tempo.

Valore	Descrizione
ById	L'elemento viene fatto riferimento dal relativo ID.

ItemTag

Object

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
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Processo di copia.
Dashboard	Dashboard di Power BI.
DataPipeline	Una pipeline di dati.
Dataflow	Flusso di dati.
Datamart	Datamart di PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flusso di Generatore di gemelli digitali.
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.
MirroredAzureDatabricksCatalog	Catalogo di Azure databricks con mirroring.
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.
VariableLibrary	VariabileLibrary.
Warehouse	Un magazzino.
WarehouseSnapshot	Uno snapshot del warehouse.

PayloadType

Enumerazione

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

Valore	Descrizione
InlineBase64	Inline Base 64.

Condividi tramite

Items - Create Digital Twin Builder Flow

Autorizzazioni

Ambiti delegati obbligatori

Limitazioni

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Create a Digital Twin Builder Flow example

Esempio di richiesta

Risposta di esempio

Create a Digital Twin Builder Flow with public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

CreateDigitalTwinBuilderFlowRequest

DigitalTwinBuilderFlow

DigitalTwinBuilderFlowCreationPayload

DigitalTwinBuilderFlowProperties

DigitalTwinBuilderFlowPublicDefinition

DigitalTwinBuilderFlowPublicDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemReferenceById

ItemReferenceType

ItemTag

ItemType

PayloadType