你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az dt model
注意
此参考是 Azure CLI(版本 2.46.0 或更高版本)的 azure-iot 扩展的一部分。 该扩展将在首次运行 az dt model 命令时自动安装。 详细了解扩展。
管理数字孪生实例上的 DTDL 模型和定义。
命令
名称 | 说明 | 类型 | 状态 |
---|---|---|---|
az dt model create |
上传一个或多个模型。 |
扩展 | GA |
az dt model delete |
删除模型。 仅当没有其他模型引用模型时,才能删除该模型。 |
扩展 | GA |
az dt model delete-all |
删除数字孪生实例中的所有模型。 |
扩展 | GA |
az dt model list |
列出模型元数据、定义和依赖项。 |
扩展 | GA |
az dt model show |
检索目标模型或模型定义。 |
扩展 | GA |
az dt model update |
更新模型的元数据。 当前只能取消提交模型。 |
扩展 | GA |
az dt model create
上传一个或多个模型。
--models 可以是内联 json 或文件路径。 输入模型集的大小(本体学)受 DT 实例可以存储的最大模型数的约束(默认值为 10000 模型)。
az dt model create --dt-name
[--failure-policy {None, Rollback}]
[--fd]
[--max-models-per-batch]
[--models]
[--resource-group]
示例
从目标目录批量上传所有.json或 .dtdl 模型文件。 模型处理是递归的。
az dt model create -n {instance_or_hostname} --from-directory {directory_path}
上传模型 json 内联或从文件路径。
az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
可选参数
指示在处理模型批处理时出错时发生的故障策略。 在“回滚”模式下,以前批处理中创建的所有模型一次删除一个。 选择为“无”时,不会从 DT 实例中删除之前批处理中创建的模型。
将从中分析目录 JSON 模型文件。 请注意:当目录包含 250 个或更小的模型时,模型是原子创建的,因此,如果出现错误,则不会创建任何模型。当目录具有超过 250 个模型(API 限制)时,输入模型集会分块并成批创建。 如果处理批处理时出错,行为由 --failure-policy 参数确定。
创建 250 多个模型时,每个批的最大模型大小。减少此数字以防止 DTDLParser 错误。
内联模型 JSON 或模型 JSON 的文件路径。 注意:模型 JSON 包含 250 个或更小的模型时,会以原子方式创建模型,因此,如果出现错误,则不会创建任何模型。当模型 JSON 超过 250 个模型(API 限制)时,输入模型集会分块并成批创建。 如果处理批处理时出错,行为由 --failure-policy 参数确定。
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az dt model delete
删除模型。 仅当没有其他模型引用模型时,才能删除该模型。
az dt model delete --dt-name
--dtmi
[--resource-group]
示例
删除目标模型。
az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
数字孪生模型 ID。示例:dtmi:com:example:Room;2。
可选参数
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az dt model delete-all
删除数字孪生实例中的所有模型。
孪生配置不受影响,但在没有模型定义的情况下可能会中断。
az dt model delete-all --dt-name
[--resource-group]
[--yes]
示例
删除所有模型。
az dt model delete-all -n {instance_or_hostname}
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
可选参数
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az dt model list
列出模型元数据、定义和依赖项。
az dt model list --dt-name
[--def {false, true}]
[--dependencies-for]
[--resource-group]
示例
列出模型元数据
az dt model list -n {instance_or_hostname}
列出模型定义
az dt model list -n {instance_or_hostname} --definition
列出特定预先存在的模型的依赖项。 空格分隔 dtmi 值。
az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
可选参数
该操作将检索模型定义。
将检索其依赖项的模型集。 如果省略,将检索所有模型。 格式是空格分隔的列表。
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az dt model show
检索目标模型或模型定义。
az dt model show --dt-name
--dtmi
[--def {false, true}]
[--resource-group]
示例
显示模型元数据
az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"
显示模型元数据和定义
az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
数字孪生模型 ID。示例:dtmi:com:example:Room;2。
可选参数
该操作将检索模型定义。
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az dt model update
更新模型的元数据。 当前只能取消提交模型。
az dt model update --dt-name
--dtmi
[--decommission {false, true}]
[--resource-group]
示例
取消提交目标模型
az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission
必需参数
数字孪生实例名称或主机名。 如果提供了实例名称,则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名,则会跳过订阅查询,并提供的值用于后续交互。
数字孪生模型 ID。示例:dtmi:com:example:Room;2。
可选参数
指示解除目标模型的授权意向。
数字孪生实例资源组。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。