digital-twin-builder

Manage Digital Twin Builder models

Authentication scope: fabric

list

List Digital Twin Builders in a workspace

fabio digital-twin-builder list --workspace <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID

Read-only · Returns list

show

Show details of a Digital Twin Builder

fabio digital-twin-builder show --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID

Read-only · Returns object

create

Create a new Digital Twin Builder

fabio digital-twin-builder create --workspace <value> --name <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--name	string	Yes	Display name
--description	string	No	Optional description
--sensitivity-label	string	No	Sensitivity label ID to apply on creation

Mutates state · Returns object

update

Update Digital Twin Builder properties

fabio digital-twin-builder update --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID
--name	string	No	New display name
--description	string	No	New description

Mutates state · Returns object

delete

Delete a Digital Twin Builder

fabio digital-twin-builder delete --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID
--hard-delete	bool	No	Permanently delete (cannot be recovered)
--delete-lakehouse	bool	No	Also delete the associated <name>dtdm data lakehouse (NOT removed automatically). Resolves it from the definition before deleting

Examples

fabio digital-twin-builder delete --workspace $WS --id $DTB --delete-lakehouse

Mutates state · Destructive · Returns void

get-definition

Get the definition of a Digital Twin Builder

fabio digital-twin-builder get-definition --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID
--decode	bool	No	Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

update-definition

Update the definition of a Digital Twin Builder

fabio digital-twin-builder update-definition --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID
--file	string	No	Path to definition file
--content	string	No	Inline definition content

Mutates state · Long-running operation · Returns void

show-lakehouse

Resolve the associated data lakehouse (the <name>dtdm lakehouse where the twin’s ontology/instance data lives) and its SQL analytics endpoint

fabio digital-twin-builder show-lakehouse --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID

Examples

fabio digital-twin-builder show-lakehouse --workspace $WS --id $DTB

Read-only · Returns object

query

Run a T-SQL query against the twin’s data (the associated dtdm lakehouse SQL endpoint). Query the dom domain views (recommended) or dbo base tables

fabio digital-twin-builder query --workspace <value> --id <value>

Flag	Type	Required	Description
--workspace	string	Yes	Workspace ID
--id	string	Yes	Digital Twin Builder ID
--sql	string	No	SQL query text (use @file.sql to read from a file, or omit to pipe via stdin)

Examples

fabio digital-twin-builder query --workspace $WS --id $DTB --sql "SELECT TOP 100 * FROM dom.Equipment"

Read-only · Returns list