你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az iot hub message-enrichment

管理 IoT 中心的终结点的消息扩充。

命令

名称	说明	类型	状态
az iot hub message-enrichment create	为IoT 中心中选择的终结点创建消息扩充。	核心	GA
az iot hub message-enrichment delete	在 IoT 中心（按密钥）中删除消息扩充。	核心	GA
az iot hub message-enrichment list	获取有关IoT 中心的所有消息扩充的信息。	核心	GA
az iot hub message-enrichment update	更新 IoT 中心的消息扩充（按密钥）。	核心	GA

az iot hub message-enrichment create

为IoT 中心中选择的终结点创建消息扩充。

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

示例

为IoT 中心中的“events”终结点创建 {“key”：“value”} 的消息扩充

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

必需参数

--endpoints -e

要向其应用扩充的终结点（s）。 对多个终结点使用空格分隔的列表。

--key -k

扩充的密钥。

--name -n

IoT 中心名称。

--value -v

扩充的值。

可选参数

--resource-group -g

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az iot hub message-enrichment delete

在 IoT 中心（按密钥）中删除消息扩充。

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

示例

从IoT 中心中删除包含密钥“test”的消息扩充

az iot hub message-enrichment delete --key test -n {iothub_name}

必需参数

--key -k

扩充的密钥。

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

IoT 中心名称。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az iot hub message-enrichment list

获取有关IoT 中心的所有消息扩充的信息。

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

示例

列出IoT 中心的所有消息扩充

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

IoT 中心名称。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az iot hub message-enrichment update

更新 IoT 中心的消息扩充（按密钥）。

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

示例

更新 IoT 中心的消息扩充，以应用于一组新的终结点

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

必需参数

--endpoints -e

要向其应用扩充的终结点（s）。 对多个终结点使用空格分隔的列表。

--key -k

扩充的密钥。

--value -v

扩充的值。

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

IoT 中心名称。

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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