az iot hub message-route

Note

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

此命令组处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

管理 IoT 中心的路由。

命令

名称	说明	类型	Status
az iot hub message-route create	为IoT 中心添加路由。	Extension	Preview
az iot hub message-route delete	删除IoT 中心中的所有路由或提及的路由。	Extension	Preview
az iot hub message-route fallback	管理 IoT 中心的回退路由。	Extension	Preview
az iot hub message-route fallback set	启用或禁用IoT 中心中的回退路由。	Extension	Preview
az iot hub message-route fallback show	显示IoT 中心的回退路由。	Extension	Preview
az iot hub message-route list	获取IoT 中心中的所有路由。	Extension	Preview
az iot hub message-route show	获取有关IoT 中心中的路由的信息。	Extension	Preview
az iot hub message-route test	在IoT 中心中测试所有路由或提及的路由。	Extension	Preview
az iot hub message-route update	更新IoT 中心的路由。	Extension	Preview

az iot hub message-route create

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

为IoT 中心添加路由。

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

示例

为具有给定终结点和源类型“DeviceMessages”的 IoT 中心创建路由。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

使用内置终结点和源类型“DeviceMessages”为 IoT 中心创建路由。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

为具有给定终结点、源类型“DigitalTwinChangeEvents”和自定义条件的 IoT 中心创建禁用的路由。

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

必需参数

--en --endpoint --endpoint-name

路由终结点的名称。 对于内置终结点，请使用终结点名称“events”。

--hub-name -n

IoT 中心名称。

--rn --route --route-name

路由的名称。

--source-type --type -t

路由的源。

属性	值
接受的值:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

可选参数

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

--condition -c

评估为应用路由规则的条件。

属性	值
默认值:	true

--enabled -e

一个布尔值，指示是否启用到 IoT 中心的路由。

属性	值
默认值:	True
接受的值:	false, 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 iot hub message-route delete

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

删除IoT 中心中的所有路由或提及的路由。

az iot hub message-route delete --hub-name
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--yes {false, true}]

示例

从 IoT 中心删除路由。

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

从 IoT 中心删除源类型“DeviceMessages”的所有路由。

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

从 IoT 中心删除所有路由。

az iot hub message-route delete -n {iothub_name}

必需参数

--hub-name -n

IoT 中心名称。

可选参数

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>配置默认组。

--rn --route --route-name

路由的名称。

--source-type --type -t

路由的源。

属性	值
接受的值:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--yes -y

跳过用户提示。 指示接受操作。 主要用于自动化方案。 Default: false.

属性	值
接受的值:	false, true

全局参数

--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 iot hub message-route list

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

获取IoT 中心中的所有路由。

az iot hub message-route list --hub-name
                              [--resource-group]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

示例

从 IoT 中心获取所有路由。

az iot hub message-route list -n {iothub_name}

从 IoT 中心获取源类型“DeviceMessages”的所有路由。

az iot hub message-route list -n {iothub_name} --source DeviceMessages

必需参数

--hub-name -n

IoT 中心名称。

可选参数

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>配置默认组。

--source-type --type -t

路由的源。

属性	值
接受的值:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

全局参数

--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 iot hub message-route show

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

获取有关IoT 中心中的路由的信息。

az iot hub message-route show --hub-name
                              --rn --route --route-name
                              [--resource-group]

示例

从 IoT 中心获取路由信息。

az iot hub message-route show -n {iothub_name} --route-name {route_name}

必需参数

--hub-name -n

IoT 中心名称。

--rn --route --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 iot hub message-route test

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

在IoT 中心中测试所有路由或提及的路由。

可以提供用于测试路由的示例消息。

az iot hub message-route test --hub-name
                              [--ap --app-properties]
                              [--body]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]

示例

测试来自 IoT 中心的路由。

az iot hub message-route test -n {iothub_name} --route-name {route_name}

从 IoT 中心测试源类型“DeviceMessages”的所有路由。

az iot hub message-route test -n {iothub_name} --source DeviceMessages

使用自定义消息（包括正文、应用属性和系统属性）从 IoT 中心测试所有路由。

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

必需参数

--hub-name -n

IoT 中心名称。

可选参数

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

--ap --app-properties

路由消息的应用属性。

--body -b

路由消息的正文。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--rn --route --route-name

路由的名称。

--source-type --type -t

路由的源。

属性	值
接受的值:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

--sp --system-properties

路由消息的系统属性。

全局参数

--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 iot hub message-route update

预览

命令组“iot 中心消息路由”处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

更新IoT 中心的路由。

可以在路由上更改源、终结点、条件或启用状态。

az iot hub message-route update --hub-name
                                --rn --route --route-name
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

示例

将路由更新到给定终结点和源类型“DeviceMessages”。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

禁用路由。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

更改路由的条件。

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

必需参数

--hub-name -n

IoT 中心名称。

--rn --route --route-name

路由的名称。

可选参数

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

--condition -c

评估为应用路由规则的条件。

--en --endpoint --endpoint-name

路由终结点的名称。 对于内置终结点，请使用终结点名称“events”。

--enabled -e

一个布尔值，指示是否启用到 IoT 中心的路由。

属性	值
接受的值:	false, true

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--source-type --type -t

路由的源。

属性	值
接受的值:	deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

全局参数

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