az dt route

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 该扩展将在首次运行 az dt route 命令时自动安装。 Learn more about extensions.

管理和配置事件路由。

请注意，必须先配置终结点，然后才能添加事件路由。

命令

名称	说明	类型	Status
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 route create

将事件路由添加到数字孪生实例。

az dt route create --dt-name --dtn
                   --en --endpoint-name
                   --rn --route-name
                   [--filter]
                   [--resource-group]

示例

在目标实例上为现有终结点添加事件路由，默认筛选器为“true”。

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name}

使用自定义筛选器为目标实例上的现有终结点添加事件路由。

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name} --filter "type = 'Microsoft.DigitalTwins.Twin.Create'"

必需参数

--dt-name --dtn -n

数字孪生实例名称或主机名。 如果提供了实例名称，则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名，则会跳过订阅查询，并提供的值用于后续交互。

--en --endpoint-name

Endpoint name.

--rn --route-name

事件路由名称。

可选参数

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

--filter

事件路由筛选器。

属性	值
默认值:	true

--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 route delete

从数字孪生实例中删除事件路由。

az dt route delete --dt-name --dtn
                   --rn --route-name
                   [--resource-group]

示例

从目标实例中删除事件路由。

az dt route delete -n {instance_or_hostname} --route-name {route_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称或主机名。 如果提供了实例名称，则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名，则会跳过订阅查询，并提供的值用于后续交互。

--rn --route-name

事件路由名称。

可选参数

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 route list

列出数字孪生实例的配置事件路由。

az dt route list --dt-name --dtn
                 [--resource-group]

示例

列出目标实例的配置事件路由。

az dt route list -n {instance_or_hostname}

必需参数

--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 route show

显示在数字孪生实例上配置的事件路由的详细信息。

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

示例

在目标实例上显示事件路由。

az dt route show -n {instance_or_hostname} --route-name {route_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称或主机名。 如果提供了实例名称，则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名，则会跳过订阅查询，并提供的值用于后续交互。

--rn --route-name

事件路由名称。

可选参数

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