Items - Update Digital Twin Builder

Serviço:

DigitalTwinBuilder

Versão da API:

v1

Observação

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

Atualiza as propriedades do DigitalTwinBuilder especificado.

Permissões

O chamador deve ter permissões de leitura e gravação para o construtor de gêmeos digitais.

Escopos delegados necessários

DigitalTwinBuilder.ReadWrite.All ou Item.ReadWrite.All

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	Não

Interfase

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

Parâmetros de URI

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

Corpo da solicitação

Nome	Tipo	Description
description	string	A descrição do DigitalTwinBuilder. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do DigitalTwinBuilder. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

Respostas

Nome	Tipo	Description
200 OK	DigitalTwinBuilder	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - O item solicitado não foi encontrado. InvalidRequest – Solicitação de atualização inválida.

Exemplos

Update a digitaltwinbuilder example

Solicitação de exemplo

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/digitaltwinbuilders/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "DigitalTwinBuilder_New_Name",
  "description": "A new description for digitaltwinbuilder."
}

Resposta de exemplo

Código de status:

200

{
  "displayName": "DigitalTwinBuilder_New_Name",
  "description": "A new description for digitaltwinbuilder.",
  "type": "DigitalTwinBuilder",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definições

Nome	Description
DigitalTwinBuilder	Um objeto digitaltwinbuilder.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
UpdateDigitalTwinBuilderRequest	Atualizar a solicitação do DigitalTwinBuilder.

DigitalTwinBuilder

Objeto

Um objeto digitaltwinbuilder.

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.
tags	ItemTag[]	Lista de marcas aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O identificador do espaço de trabalho.

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.

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.

UpdateDigitalTwinBuilderRequest

Objeto

Atualizar a solicitação do DigitalTwinBuilder.

Nome	Tipo	Description
description	string	A descrição do DigitalTwinBuilder. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do DigitalTwinBuilder. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.