Items - Create Digital Twin Builder Flow

Serviço:: DigitalTwinBuilderFlow

Versão da API:: v1

Observação

Esta API está na versão prévia.

Cria um Fluxo do Construtor de Gêmeos Digitais no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Para criar o Digital Twin Builder Flow com uma definição pública, consulte o artigo.

Permissões

O chamador deve ter uma função de workspace de colaborador .

Escopos delegados necessários

DigitalTwinBuilderFlow.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um Fluxo do Construtor de Gêmeos Digitais, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte: tipos de licença do Microsoft Fabric.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição fluxo do Construtor de Gêmeos Digitais. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
creationPayload		DigitalTwinBuilderFlowCreationPayload	O conteúdo da criação. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
definition		DigitalTwinBuilderFlowPublicDefinition	A definição pública do Fluxo do Construtor de Gêmeos Digitais.
description		string	A descrição do Fluxo do Construtor de Gêmeos Digitais. O comprimento máximo é de 256 caracteres.

Respostas

Nome	Tipo	Description
201 Created	DigitalTwinBuilderFlow	Criado com êxito
202 Accepted		Solicitação aceita, provisionamento do Fluxo do Construtor de Gêmeos Digitais em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType – O tipo de item é inválido ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado. CorruptedPayload – O conteúdo fornecido está corrompido. WorkspaceItemsLimitExceeded - Limite de item do workspace excedido

Nome

Tipo

Description

201 Created

DigitalTwinBuilderFlow

Criado com êxito

202 Accepted

Solicitação aceita, provisionamento do Fluxo do Construtor de Gêmeos Digitais em andamento.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType – O tipo de item é inválido
ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado.
CorruptedPayload – O conteúdo fornecido está corrompido.
WorkspaceItemsLimitExceeded - Limite de item do workspace excedido

Exemplos

Create a Digital Twin Builder Flow example

Create a Digital Twin Builder Flow with public definition example

Create a Digital Twin Builder Flow example

Solicitação de exemplo

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"
    }
  }
}

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Solicitação de exemplo

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"
      }
    ]
  }
}

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Definições

Nome	Description
CreateDigitalTwinBuilderFlowRequest	Criar conteúdo de solicitação do Digital Twin Builder Flow.
DigitalTwinBuilderFlow	Um objeto Fluxo do Construtor de Gêmeos Digitais.
DigitalTwinBuilderFlowCreationPayload	O conteúdo de criação do Fluxo do Construtor de Gêmeos Digitais.
DigitalTwinBuilderFlowProperties	As propriedades do Fluxo do Construtor de Gêmeos Digitais.
DigitalTwinBuilderFlowPublicDefinition	O objeto de definição pública do Fluxo do Construtor de Gêmeos Digitais. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública do Fluxo do Construtor de Gêmeos Digitais.
DigitalTwinBuilderFlowPublicDefinitionPart	Objeto de parte de definição do Fluxo do Construtor de Gêmeos Digital.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemReferenceById	Uma referência de item por objeto ID.
ItemReferenceType	O tipo de referência item. Tipos de `ItemReferenceType` adicionais podem ser adicionados ao longo do tempo.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

CreateDigitalTwinBuilderFlowRequest

Objeto

Criar conteúdo de solicitação do Digital Twin Builder Flow.

Nome	Tipo	Description
creationPayload	DigitalTwinBuilderFlowCreationPayload	O conteúdo da criação. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
definition	DigitalTwinBuilderFlowPublicDefinition	A definição pública do Fluxo do Construtor de Gêmeos Digitais.
description	string	A descrição do Fluxo do Construtor de Gêmeos Digitais. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição fluxo do Construtor de Gêmeos Digitais. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

DigitalTwinBuilderFlow

Objeto

Um objeto Fluxo do Construtor de Gêmeos Digitais.

Nome	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	A ID da pasta.
id	string (uuid)	A ID do item.
properties	DigitalTwinBuilderFlowProperties	As propriedades do Fluxo do Construtor de Gêmeos Digitais.
tags	ItemTag[]	Lista de marcas aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O identificador do espaço de trabalho.

DigitalTwinBuilderFlowCreationPayload

Objeto

O conteúdo de criação do Fluxo do Construtor de Gêmeos Digitais.

Nome	Tipo	Description
digitalTwinBuilderItemReference	ItemReference: ItemReferenceById	A referência de item do Construtor de Gêmeos Digitais.

DigitalTwinBuilderFlowProperties

Objeto

As propriedades do Fluxo do Construtor de Gêmeos Digitais.

Nome	Tipo	Description
digitalTwinBuilderItemReference	ItemReference: ItemReferenceById	A referência de item do Construtor de Gêmeos Digitais.

DigitalTwinBuilderFlowPublicDefinition

Objeto

O objeto de definição pública do Fluxo do Construtor de Gêmeos Digitais. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública do Fluxo do Construtor de Gêmeos Digitais.

Nome	Tipo	Description
parts	DigitalTwinBuilderFlowPublicDefinitionPart[]	Uma lista de partes de definição.

DigitalTwinBuilderFlowPublicDefinitionPart

Objeto

Objeto de parte de definição do Fluxo do Construtor de Gêmeos Digital.

Nome	Tipo	Description
path	string	O caminho da parte de definição pública do Fluxo do Construtor de Gêmeos Digitais.
payload	string	O conteúdo da parte de definição pública do Digital Twin Builder Flow.
payloadType	PayloadType	O tipo de conteúdo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

ItemReferenceById

Objeto

Uma referência de item por objeto ID.

Nome	Tipo	Description
itemId	string (uuid)	O ID do item.
referenceType	string: ById	O tipo de referência de item.
workspaceId	string (uuid)	A ID do workspace do item.

ItemReferenceType

Enumeração

O tipo de referência item. Tipos de ItemReferenceType adicionais podem ser adicionados ao longo do tempo.

Valor	Description
ById	O item é referenciado por sua ID.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
ApacheAirflowJob	Um ApacheAirflowJob.
CopyJob	Um trabalho de cópia.
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Dataflow	Um fluxo de dados.
Datamart	Datamart do PowerBI.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um notebook.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
VariableLibrary	Um VariableLibrary.
Warehouse	Um armazém.
WarehouseSnapshot	Um instantâneo do Warehouse.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

Compartilhar via

Items - Create Digital Twin Builder Flow

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a Digital Twin Builder Flow example

Solicitação de exemplo

Resposta de exemplo

Create a Digital Twin Builder Flow with public definition example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateDigitalTwinBuilderFlowRequest

DigitalTwinBuilderFlow

DigitalTwinBuilderFlowCreationPayload

DigitalTwinBuilderFlowProperties

DigitalTwinBuilderFlowPublicDefinition

DigitalTwinBuilderFlowPublicDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemReferenceById

ItemReferenceType

ItemTag

ItemType

PayloadType