Items - Create Digital Twin Builder

服务:: DigitalTwinBuilder

API 版本:: v1

在指定的工作区中创建 DigitalTwinBuilder。

Note

数字孪生生成器项目前以预览版提供（了解详细信息）。

此 API 支持长时间运行的作（LRO）。

若要使用定义创建 digitaltwinbuilder，请参阅 DigitalTwinBuilder 定义。

Permissions

调用方必须具有 参与者 工作区角色。

所需的委派范围

DigitalTwinBuilder.ReadWrite.All 或 Item.ReadWrite.All

Limitations

若要创建 digitaltwinbuilder，工作区必须具有受支持的 Fabric 容量。有关详细信息，请参阅：Microsoft Fabric 许可证类型。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	No

Interface

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
displayName	True	string	digitaltwinbuilder 显示名称。显示名称必须遵循项类型的命名规则，即它应以字母开头，只有数字和字母或 _ 且小于 100。
definition		DigitalTwinBuilderDefinition	DigitalTwinBuilder 公共定义。
description		string	digitaltwinbuilder 说明。最大长度为 256 个字符。

响应

名称	类型	说明
201 Created	DigitalTwinBuilder	已成功创建
202 Accepted		请求已接受，digitaltwinbuilder 预配正在进行标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效 ItemDisplayNameAlreadyInUse - 项显示名称已被使用。 CorruptedPayload - 提供的有效负载已损坏。 WorkspaceItemsLimitExceeded - 超出工作区项限制。

名称

类型

说明

201 Created

DigitalTwinBuilder

已成功创建

202 Accepted

请求已接受，digitaltwinbuilder 预配正在进行

标头

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

Other Status Codes

ErrorResponse

常见错误代码：

InvalidItemType - 项类型无效
ItemDisplayNameAlreadyInUse - 项显示名称已被使用。
CorruptedPayload - 提供的有效负载已损坏。
WorkspaceItemsLimitExceeded - 超出工作区项限制。

示例

Create a digitaltwinbuilder example

Create a digitaltwinbuilder with public definition example

Create a digitaltwinbuilder example

示例请求

HTTP

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

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

示例响应

状态代码:: 201

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

状态代码:: 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

示例请求

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

示例响应

状态代码:: 201

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

状态代码:: 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

定义

名称	说明
CreateDigitalTwinBuilderRequest	创建 digitaltwinbuilder 请求有效负载。
DigitalTwinBuilder	digitaltwinbuilder 对象。
DigitalTwinBuilderDefinition	DigitalTwinBuilder 公共定义对象。
DigitalTwinBuilderDefinitionPart	DigitalTwinBuilder 定义部件对象。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemTag	表示应用于项的标记。
ItemType	项类型。可能会随着时间的推移添加其他项类型。
PayloadType	定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。

CreateDigitalTwinBuilderRequest

对象

创建 digitaltwinbuilder 请求有效负载。

名称	类型	说明
definition	DigitalTwinBuilderDefinition	DigitalTwinBuilder 公共定义。
description	string	digitaltwinbuilder 说明。最大长度为 256 个字符。
displayName	string	digitaltwinbuilder 显示名称。显示名称必须遵循项类型的命名规则，即它应以字母开头，只有数字和字母或 _ 且小于 100。

DigitalTwinBuilder

对象

digitaltwinbuilder 对象。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
folderId	string (uuid)	文件夹 ID。
id	string (uuid)	项 ID。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项目类型。
workspaceId	string (uuid)	工作区 ID。

DigitalTwinBuilderDefinition

对象

DigitalTwinBuilder 公共定义对象。

名称	类型	说明
format	string	项定义的格式。
parts	DigitalTwinBuilderDefinitionPart[]	定义部件的列表。

DigitalTwinBuilderDefinitionPart

对象

DigitalTwinBuilder 定义部件对象。

名称	类型	说明
path	string	DigitalTwinBuilder 部件路径。
payload	string	DigitalTwinBuilder 部件有效负载。
payloadType	PayloadType	有效负载类型。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemTag

对象

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项类型。可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
Report	PowerBI 报表。
SemanticModel	PowerBI 语义模型。
PaginatedReport	PowerBI 分页报表。
Datamart	PowerBI Datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	环境。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
KQLDashboard	KQL 仪表板。
DataPipeline	数据管道。
Notebook	笔记本。
SparkJobDefinition	spark 作业定义。
MLExperiment	机器学习试验。
MLModel	机器学习模型。
Warehouse	仓库。
Eventstream	事件流。
SQLEndpoint	SQL 终结点。
MirroredWarehouse	镜像仓库。
MirroredDatabase	镜像数据库。
Reflex	反射。
GraphQLApi	GraphQL 项的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	复制作业。
VariableLibrary	VariableLibrary。
Dataflow	数据流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	仓库快照。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
Map	地图。
AnomalyDetector	异常检测器。
UserDataFunction	用户数据函数。
GraphModel	GraphModel。
GraphQuerySet	图形查询集。
SnowflakeDatabase	用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB 数据库。

PayloadType

枚举

定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。

值	说明
InlineBase64	内联基线 64。

通过

Items - Create Digital Twin Builder

Permissions

所需的委派范围

Limitations

Microsoft Entra 支持的标识

Interface

URI 参数

请求正文

响应

示例

Create a digitaltwinbuilder example

示例请求

示例响应

Create a digitaltwinbuilder with public definition example

示例请求

示例响应

定义

CreateDigitalTwinBuilderRequest

DigitalTwinBuilder

DigitalTwinBuilderDefinition

DigitalTwinBuilderDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType