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

az iot hub routing-endpoint

此命令组已弃用,将在将来的版本中删除。 请改用“IoT 扩展(azure-iot)消息终结点命令组(az iot hub message-endpoint)。”

管理 IoT 中心的自定义终结点。

命令

名称 说明 类型 Status
az iot hub routing-endpoint create

将终结点添加到IoT 中心。

核心 已放弃
az iot hub routing-endpoint delete

删除IoT 中心的所有或提及终结点。

核心 已放弃
az iot hub routing-endpoint list

获取有关IoT 中心的所有终结点的信息。

核心 已放弃
az iot hub routing-endpoint show

获取有关IoT 中心提及终结点的信息。

核心 已放弃

az iot hub routing-endpoint create

已放弃

此命令已隐式弃用,因为命令组“iot 中心路由终结点”已弃用,将在将来的版本中删除。 请改用“IoT 扩展(azure-iot)消息终结点命令组(az iot hub message-endpoint)。”

将终结点添加到IoT 中心。

在IoT 中心中创建新的自定义终结点。

az iot hub routing-endpoint create --endpoint-name
                                   --endpoint-resource-group
                                   --endpoint-subscription-id
                                   --endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}
                                   --hub-name
                                   [--auth-type {identityBased, keyBased}]
                                   [--batch-frequency]
                                   [--chunk-size]
                                   [--connection-string]
                                   [--container]
                                   [--encoding {avro, json}]
                                   [--endpoint-uri]
                                   [--entity-path]
                                   [--ff]
                                   [--identity]
                                   [--resource-group]

示例

将 EventHub 类型的新终结点“E2”添加到“MyIotHub”IoT 中心。

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString}

将存储 Azure 类型的新终结点“S1”添加到终结点资源组“MyEndpointResourceGroup”中的“MyIotHub”IoT 中心。

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name S1 --endpoint-type azurestoragecontainer --endpoint-resource-group MyEndpointResourceGroup \
--endpoint-subscription-id {SubscriptionId} --connection-string {ConnectionString} \
--container-name {ContainerName} --batch-frequency 100 --chunk-size 100 \
--ff {iothub}-{partition}-{YYYY}-{MM}-{DD}-{HH}-{mm}

添加名为“EventHubIdentity”的新基于标识的 EventHub 终结点,并使用用户分配的托管标识进行身份验证

az iot hub routing-endpoint create --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name EventHubIdentity --endpoint-type eventhub --endpoint-resource-group {ResourceGroup} --endpoint-subscription-id {SubscriptionId} --auth-type identityBased --identity {userIdentityResourceId} --endpoint-uri {EventHubEndpointUri} --entity-path {EntityPath}

必需参数

--endpoint-name --name -n

路由终结点的名称。

--endpoint-resource-group --erg -r

终结点的资源组会重新调整。

--endpoint-subscription-id -s

Endpoint 资源的 SubscriptionId。

--endpoint-type --type -t

路由终结点的类型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中心名称。

可选参数

--auth-type

终结点的身份验证类型。 默认值为 keyBased。

接受的值: identityBased, keyBased
--batch-frequency -b

请求批处理频率(以秒为单位)。 在将数据写入 Blob 之前可以经过的最长时间(介于 60 到 720 秒之间)。

默认值: 300
--chunk-size -w

请求区块大小(MB)。 Blob 的最大大小,介于 10 到 500 MB 之间。

默认值: 300
--connection-string -c

路由终结点的连接字符串。

--container --container-name

存储容器的名称。

--encoding

容器的编码格式。 默认值为 AVRO。 请注意,此字段仅适用于 Blob 容器终结点。

接受的值: avro, json
--endpoint-uri

终结点资源的 URI。

--entity-path

终结点资源的实体路径。

--ff --file-name-format

Blob 的文件名格式。 文件名格式必须包含 {iothub}、{partition}、{YYYY}、{MM}、{DD}、{HH} 和 {mm} 字段。 所有参数都是必需参数,但可以使用或不带分隔符重新排序。

默认值: {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}
--identity

使用系统分配的或用户分配的托管标识进行终结点身份验证。 使用“[system]”来引用系统分配的标识或资源 ID 来引用用户分配的标识。 如果在不使用此参数的情况下使用 --auth-type,则假定系统分配的托管标识。

--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 routing-endpoint delete

已放弃

此命令已隐式弃用,因为命令组“iot 中心路由终结点”已弃用,将在将来的版本中删除。 请改用“IoT 扩展(azure-iot)消息终结点命令组(az iot hub message-endpoint)。”

删除IoT 中心的所有或提及终结点。

删除IoT 中心的终结点。 建议先删除到终结点的任何路由,然后再删除终结点。

az iot hub routing-endpoint delete [--endpoint-name]
                                   [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]

示例

从“MyIotHub”中删除终结点“E2”IoT 中心。

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-name E2

从“MyIotHub”中删除类型为“EventHub”的所有终结点IoT 中心。

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

从“MyIotHub”中删除所有终结点IoT 中心。

az iot hub routing-endpoint delete --resource-group MyResourceGroup --hub-name MyIotHub

可选参数

--endpoint-name --name -n

路由终结点的名称。

--endpoint-type --type -t

路由终结点的类型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中心名称。

--ids

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

--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 routing-endpoint list

已放弃

此命令已隐式弃用,因为命令组“iot 中心路由终结点”已弃用,将在将来的版本中删除。 请改用“IoT 扩展(azure-iot)消息终结点命令组(az iot hub message-endpoint)。”

获取有关IoT 中心的所有终结点的信息。

获取有关IoT 中心中所有终结点的信息。 还可以指定要获取 informaiton 的终结点类型。

az iot hub routing-endpoint list [--endpoint-type {azurestoragecontainer, eventhub, servicebusqueue, servicebustopic}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

示例

从“MyIotHub”IoT 中心获取所有终结点。

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub

从“MyIotHub”IoT 中心获取类型为“EventHub”的所有终结点。

az iot hub routing-endpoint list -g MyResourceGroup --hub-name MyIotHub --endpoint-type eventhub

可选参数

--endpoint-type --type -t

路由终结点的类型。

接受的值: azurestoragecontainer, eventhub, servicebusqueue, servicebustopic
--hub-name

IoT 中心名称。

--ids

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

--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 routing-endpoint show

已放弃

此命令已隐式弃用,因为命令组“iot 中心路由终结点”已弃用,将在将来的版本中删除。 请改用“IoT 扩展(azure-iot)消息终结点命令组(az iot hub message-endpoint)。”

获取有关IoT 中心提及终结点的信息。

获取有关IoT 中心中特定终结点的信息。

az iot hub routing-endpoint show --endpoint-name
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

示例

从“MyIotHub”IoT 中心获取终结点信息。

az iot hub routing-endpoint show --resource-group MyResourceGroup --hub-name MyIotHub \
--endpoint-name {endpointName}

必需参数

--endpoint-name --name -n

路由终结点的名称。

可选参数

--hub-name

IoT 中心名称。

--ids

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

--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 获取完整的调试日志。