az dt

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az dt command. Learn more about extensions.

管理 Azure 数字孪生解决方案和基础结构。

命令

名称	说明	类型	Status
az dt create	创建或更新数字孪生实例。	Extension	GA
az dt data-history	管理和配置数据历史记录。	Extension	GA
az dt data-history connection	管理和配置数据历史记录连接。	Extension	GA
az dt data-history connection create	在数字孪生实例和支持的资源之间创建数据历史记录连接。	Extension	GA
az dt data-history connection create adx	创建数字孪生实例与 Azure 数据资源管理器数据库之间的数据历史记录连接。 需要预先创建的 Azure 数据资源管理器和事件中心资源。	Extension	GA
az dt data-history connection delete	删除在数字孪生实例上配置的数据历史记录连接。	Extension	GA
az dt data-history connection list	列出在数字孪生实例上配置的所有数据历史记录连接。	Extension	GA
az dt data-history connection show	显示在数字孪生实例上配置的数据历史记录连接的详细信息。	Extension	GA
az dt data-history connection wait	等待数据历史记录连接的作完成。	Extension	GA
az dt delete	删除现有的数字孪生实例。	Extension	GA
az dt endpoint	管理和配置数字孪生实例终结点。	Extension	GA
az dt endpoint create	将出口终结点添加到数字孪生实例。	Extension	GA
az dt endpoint create eventgrid	将 EventGrid 主题终结点添加到数字孪生实例。 需要预先创建的资源。	Extension	GA
az dt endpoint create eventhub	将 EventHub 终结点添加到数字孪生实例。	Extension	GA
az dt endpoint create servicebus	将 ServiceBus 主题终结点添加到数字孪生实例。	Extension	GA
az dt endpoint delete	从数字孪生实例中删除终结点。	Extension	GA
az dt endpoint list	列出在数字孪生实例上配置的所有出口终结点。	Extension	GA
az dt endpoint show	显示在数字孪生实例上配置的终结点的详细信息。	Extension	GA
az dt endpoint wait	等待终结点作完成。	Extension	GA
az dt identity	管理数字孪生实例的标识。	Extension	GA
az dt identity assign	将托管标识分配给数字孪生实例。	Extension	GA
az dt identity remove	从数字孪生实例中删除托管标识。	Extension	GA
az dt identity show	显示数字孪生实例的标识属性。	Extension	GA
az dt job	管理和配置数字孪生实例的作业。	Extension	GA
az dt job deletion	管理和配置用于删除数字孪生实例中的模型、孪生体和关系数据的作业。	Extension	GA
az dt job deletion create	在数字孪生实例上创建和执行删除作业。	Extension	GA
az dt job deletion list	列出在数字孪生实例上执行的所有删除作业。	Extension	GA
az dt job deletion show	显示对数字孪生实例执行的删除作业的详细信息。	Extension	GA
az dt job import	管理和配置用于将模型、孪生体和关系数据导入到数字孪生实例的作业。	Extension	GA
az dt job import cancel	取消在数字孪生实例上执行的数据导入作业。	Extension	GA
az dt job import create	在数字孪生实例上创建和执行数据导入作业。	Extension	GA
az dt job import delete	删除在数字孪生实例上执行的数据导入作业。	Extension	GA
az dt job import list	列出在数字孪生实例上执行的所有数据导入作业。	Extension	GA
az dt job import show	显示在数字孪生实例上执行的数据导入作业的详细信息。	Extension	GA
az dt list	按订阅或资源组列出数字孪生实例的集合。	Extension	GA
az dt model	管理数字孪生实例上的 DTDL 模型和定义。	Extension	GA
az dt model create	上传一个或多个模型。	Extension	GA
az dt model delete	删除模型。 仅当没有其他模型引用模型时，才能删除该模型。	Extension	GA
az dt model delete-all	删除数字孪生实例中的所有模型。	Extension	GA
az dt model list	列出模型元数据、定义和依赖项。	Extension	GA
az dt model show	检索目标模型或模型定义。	Extension	GA
az dt model update	更新模型的元数据。 当前只能取消提交模型。	Extension	GA
az dt network	管理数字孪生网络配置，包括专用链接和终结点连接。	Extension	GA
az dt network private-endpoint	管理数字孪生实例专用终结点。	Extension	GA
az dt network private-endpoint connection	管理数字孪生实例专用终结点连接。	Extension	GA
az dt network private-endpoint connection delete	删除与数字孪生实例关联的专用终结点连接。	Extension	GA
az dt network private-endpoint connection list	列出与数字孪生实例关联的专用终结点连接。	Extension	GA
az dt network private-endpoint connection set	设置与数字孪生实例关联的专用终结点连接的状态。	Extension	GA
az dt network private-endpoint connection show	显示与数字孪生实例关联的专用终结点连接。	Extension	GA
az dt network private-endpoint connection wait	等待专用终结点连接上的作完成。	Extension	GA
az dt network private-link	管理数字孪生实例专用链接作。	Extension	GA
az dt network private-link list	列出与数字孪生实例关联的专用链接。	Extension	GA
az dt network private-link show	显示与实例关联的专用链接。	Extension	GA
az dt role-assignment	管理数字孪生实例的 RBAC 角色分配。	Extension	GA
az dt role-assignment create	将用户、组或服务主体分配给针对数字孪生实例的角色。	Extension	GA
az dt role-assignment delete	从数字孪生实例中删除用户、组或服务主体角色分配。	Extension	GA
az dt role-assignment list	列出数字孪生实例的现有角色分配。	Extension	GA
az dt route	管理和配置事件路由。	Extension	GA
az dt route create	将事件路由添加到数字孪生实例。	Extension	GA
az dt route delete	从数字孪生实例中删除事件路由。	Extension	GA
az dt route list	列出数字孪生实例的配置事件路由。	Extension	GA
az dt route show	显示在数字孪生实例上配置的事件路由的详细信息。	Extension	GA
az dt show	显示现有的数字孪生实例。	Extension	GA
az dt twin	管理和配置数字孪生实例的数字孪生。	Extension	GA
az dt twin component	显示和更新数字孪生实例的数字孪生组件。	Extension	GA
az dt twin component show	显示数字孪生组件的详细信息。	Extension	GA
az dt twin component update	通过 JSON 修补规范更新数字孪生组件。	Extension	GA
az dt twin create	在实例上创建数字孪生体。	Extension	GA
az dt twin delete	删除数字孪生体。 必须删除引用此孪生体的所有关系。	Extension	GA
az dt twin delete-all	删除数字孪生实例中的所有数字孪生体，包括这些孪生体的所有关系。	Extension	GA
az dt twin query	查询实例的数字孪生体。 允许遍历关系并按属性值进行筛选。	Extension	GA
az dt twin relationship	管理和配置数字孪生实例的数字孪生关系。	Extension	GA
az dt twin relationship create	在源和目标数字孪生之间创建关系。	Extension	GA
az dt twin relationship delete	删除数字孪生实例上的数字孪生关系。	Extension	GA
az dt twin relationship delete-all	删除数字孪生实例中的所有数字孪生关系，包括传入关系。	Extension	GA
az dt twin relationship list	列出数字孪生体的关系。	Extension	GA
az dt twin relationship show	显示数字孪生关系的详细信息。	Extension	GA
az dt twin relationship update	通过 JSON 修补程序规范更新两个数字孪生之间的关系的属性。	Extension	GA
az dt twin show	显示数字孪生体的详细信息。	Extension	GA
az dt twin telemetry	测试和验证数字孪生实例的事件路由和终结点。	Extension	GA
az dt twin telemetry send	代表数字孪生发送遥测数据。 如果提供了组件路径，则发出的遥测数据代表组件。	Extension	GA
az dt twin update	通过 JSON 修补规范更新实例数字孪生。	Extension	GA
az dt wait	等待数字孪生实例上的作完成。	Extension	GA

az dt create

创建或更新数字孪生实例。

az dt create --dt-name --dtn
             --resource-group
             [--assign-identity {false, true}]
             [--location]
             [--mi-system-assigned {false, true}]
             [--mi-user-assigned]
             [--no-wait]
             [--pna --public-network-access {Disabled, Enabled}]
             [--role]
             [--scopes]
             [--tags]

示例

使用资源组位置在目标资源组中创建实例。

az dt create -n {instance_name} -g {resouce_group}

在目标资源组中创建具有指定位置和标记的实例。

az dt create -n {instance_name} -g {resouce_group} -l westus --tags a=b c=d

使用系统托管标识在目标资源组中创建实例。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned

使用用户托管标识在目标资源组中创建实例。

az dt create -n {instance_name} -g {resouce_group} --mi-user-assigned {resource_id}

使用系统托管标识和多个用户托管标识在目标资源组中创建实例。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --mi-user-assigned {resource_id} {resource_id}

使用系统托管标识在目标资源组中创建实例，然后将标识分配给具有参与者角色的一个或多个范围（空格分隔）。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic"

使用系统托管标识在目标资源组中创建实例，然后将标识分配给具有自定义指定角色的一个或多个范围。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic" --role MyCustomRole

使用新标记值更新目标资源组中的实例，并禁用公共网络访问。

az dt create -n {instance_name} -g {resouce_group} --tags env=prod --public-network-access Disabled

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--assign-identity

已放弃

参数“assign_identity”已弃用，将在将来的版本中删除。 请改用“--mi-system-assigned”。

将系统生成的标识分配给数字孪生实例。

属性	值
Parameter group:	Managed Service Identity Arguments
接受的值:	false, true

--location -l

数字孪生实例位置。 如果未提供任何位置，则使用资源组位置。可以使用 az configure --defaults location={name}配置默认位置。

--mi-system-assigned

将系统生成的标识分配给此数字孪生实例。

属性	值
Parameter group:	Managed Service Identity Arguments
接受的值:	false, true

--mi-user-assigned

要添加到数字孪生实例的空间分隔用户标识资源 ID。

属性	值
Parameter group:	Managed Service Identity Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--pna --public-network-access

确定是否可以从公用网络访问数字孪生实例。

属性	值
Parameter group:	Network Arguments
默认值:	Enabled
接受的值:	Disabled, Enabled

--role

系统分配的标识将具有的角色名称或 ID。

属性	值
Parameter group:	Managed Service Identity Arguments
默认值:	Contributor

--scopes

系统分配的标识可以访问的空间分隔范围。 不能与 --no-wait 一起使用。

属性	值
Parameter group:	Managed Service Identity Arguments

--tags

数字孪生实例标记。 采用以下格式的键值对中的属性包：a=b c=d。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt delete

删除现有的数字孪生实例。

az dt delete --dt-name --dtn
             [--no-wait]
             [--resource-group]
             [--yes]

示例

使用确认提示以阻止方式删除任意实例。

az dt delete -n {instance_name}

删除没有阻止或提示的任意实例。

az dt delete -n {instance_name} -y --no-wait

必需参数

--dt-name --dtn -n

数字孪生实例名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt list

按订阅或资源组列出数字孪生实例的集合。

az dt list [--resource-group]

示例

列出当前订阅中的所有实例。

az dt list

以表格式列出目标资源组中的所有实例和输出。

az dt list -g {resource_group} --output table

列出满足条件的订阅中的所有实例。

az dt list --query "[?contains(name, 'Production')]"

对满足条件的实例进行计数。

az dt list --query "length([?contains(name, 'Production')])"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt show

显示现有的数字孪生实例。

az dt show --dt-name --dtn
           [--resource-group]

示例

显示实例。

az dt show -n {instance_name}

显示实例和项目特定属性。

az dt show -n {instance_name} --query "{Endpoint:hostName, Location:location}"

必需参数

--dt-name --dtn -n

数字孪生实例名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt wait

等待数字孪生实例上的作完成。

az dt wait --dt-name --dtn
           [--created]
           [--custom]
           [--deleted]
           [--exists]
           [--interval]
           [--resource-group]
           [--timeout]

示例

等到创建任意实例。

az dt wait -n {instance_name} --created

等到删除现有实例。

az dt wait -n {instance_name} --deleted

等到现有实例的 publicNetworkAccess 属性设置为“已启用”

az dt wait -n {instance_name} --custom "publicNetworkAccess=='Enabled'"

必需参数

--dt-name --dtn -n

数字孪生实例名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--interval

轮询间隔（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False