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

az iot hub

管理 Azure IoT 中心。

命令

az iot hub certificate

管理 IoT 中心证书。

az iot hub certificate create

创建/上传 Azure IoT 中心证书。

az iot hub certificate delete

删除 Azure IoT 中心证书。

az iot hub certificate generate-verification-code

为 Azure IoT 中心证书生成验证代码。

az iot hub certificate list

列出 Azure IoT 中心内包含的所有证书。

az iot hub certificate show

显示有关特定 Azure IoT 中心证书的信息。

az iot hub certificate update

更新 Azure IoT 中心证书。

az iot hub certificate verify

验证 Azure IoT 中心证书。

az iot hub configuration

大规模管理 IoT 自动设备管理配置。

az iot hub configuration create

在目标 IoT 中心创建 IoT 自动设备管理配置。

az iot hub configuration delete

删除 IoT 设备配置。

az iot hub configuration list

列出 IoT 中心内 IoT 自动设备管理的配置。

az iot hub configuration show

获取 IoT 自动设备管理配置的详细信息。

az iot hub configuration show-metric

评估 IoT 设备配置中定义的目标用户或系统指标。

az iot hub configuration update

更新 IoT 自动设备管理配置的指定属性。

使用--set,后跟属性分配以更新配置。

注意:配置内容是不可变的。 可以更新的配置属性包括 "标签"、"指标"、"priority" 和 "targetCondition"。

az iot hub connection-string

管理 IoT 中心连接字符串。

az iot hub connection-string show

使用给定的策略名称和密钥显示指定的 IoT 中心的连接字符串。

az iot hub consumer-group

管理 IoT 中心的事件中心使用者组。

az iot hub consumer-group create

创建事件中心使用者组。

az iot hub consumer-group delete

删除事件中心使用者组。

az iot hub consumer-group list

列出事件中心使用者组。

az iot hub consumer-group show

获取事件中心使用者组的详细信息。

az iot hub create

创建 Azure IoT 中心。

az iot hub delete

删除 IoT 中心。

az iot hub device-identity

管理 IoT 设备。

az iot hub device-identity children

管理 IoT 设备的子设备。

az iot hub device-identity children add

将指定的以空格分隔的设备 id 列表作为指定边缘设备的子级添加。

az iot hub device-identity children list

输出已分配子设备的列表。

az iot hub device-identity children remove

从指定的边缘设备中删除作为子项的设备。

az iot hub device-identity connection-string

管理 IoT 设备的连接字符串。

az iot hub device-identity connection-string show

显示给定的 IoT 中心设备连接字符串。

az iot hub device-identity create

在 IoT 中心创建设备。

az iot hub device-identity delete

删除 IoT 中心设备。

az iot hub device-identity export

将 IoT 中心的所有设备标识导出到Azure 存储 Blob 容器。 有关内联 Blob 容器 SAS URI 输入,请查看环境的输入规则。

az iot hub device-identity import

从 Blob 将设备标识导入 IoT 中心。 有关内联 Blob 容器 SAS URI 输入,请查看环境的输入规则。

az iot hub device-identity list

列出 IoT 中心的设备。

az iot hub device-identity parent

管理 IoT 设备的父设备。

az iot hub device-identity parent set

设置指定设备的父设备。

az iot hub device-identity parent show

获取指定设备的父设备。

az iot hub device-identity renew-key

使用 sas 身份验证续订 IoT 中心设备的目标密钥。

az iot hub device-identity show

获取 IoT 中心设备的详细信息。

az iot hub device-identity update

更新 IoT 中心设备。

az iot hub devicestream

管理 IoT 中心的设备流。

az iot hub devicestream show

获取 IoT 中心的设备流终结点。

az iot hub device-twin

管理 IoT 设备孪生配置。

az iot hub device-twin replace

将设备孪生定义替换为目标 json。

az iot hub device-twin show

获取设备孪生定义。

az iot hub device-twin update

更新设备孪生所需的属性和标记。

az iot hub digital-twin

操作和与 IoT 中心设备的数字克隆交互。

az iot hub digital-twin invoke-command

调用数字克隆设备的根或组件级别命令。

az iot hub digital-twin show

显示 IoT 中心设备的数字输出。

az iot hub digital-twin update

通过 JSON 修补程序规范更新数字输出设备的读写属性。

az iot hub distributed-tracing

管理每个设备的分布式设置。

az iot hub distributed-tracing show

获取设备的分布式跟踪设置。

az iot hub distributed-tracing update

更新设备的分布式跟踪选项。

az iot hub generate-sas-token

为目标 IoT 中心、设备或模块生成 SAS 令牌。

az iot hub identity

管理中心Azure IoT标识。

az iot hub identity assign

将托管标识分配到 IoT 中心。

az iot hub identity remove

从 IoT 中心中删除托管标识。

az iot hub identity show

显示 IoT 中心的标识属性。

az iot hub invoke-device-method

调用设备方法。

az iot hub invoke-module-method

调用 Edge 模块方法。

az iot hub job

(v2) 管理 IoT 中心作业。

az iot hub job cancel

取消 IoT 中心作业。

az iot hub job create

创建和计划用于执行的 IoT 中心作业。

az iot hub job list

列出 IoT 中心的历史作业。

az iot hub job show

显示现有 IoT 中心作业的详细信息。

az iot hub list

列出 IoT 中心。

az iot hub list-skus

列出可用定价层。

az iot hub manual-failover

为 IoT 中心启动手动故障转移到地域配对的灾难恢复区域。

az iot hub message-enrichment

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

az iot hub message-enrichment create

为 IoT 中心内所选终结点创建消息扩充。

az iot hub message-enrichment delete

删除 IoT 中心内的消息扩充 (密钥) 。

az iot hub message-enrichment list

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

az iot hub message-enrichment update

按密钥设置更新 IoT 中心 (消息) 。

az iot hub module-identity

管理 IoT 设备模块。

az iot hub module-identity connection-string

管理 IoT 设备模块的连接字符串。

az iot hub module-identity connection-string show

显示目标 IoT 设备模块连接字符串。

az iot hub module-identity create

在 IoT 中心的目标 IoT 设备上创建模块。

az iot hub module-identity delete

删除 IoT 中心的设备。

az iot hub module-identity list

列出 IoT 中心 IoT 设备上的模块。

az iot hub module-identity renew-key

使用 sas 身份验证续订 IoT 中心设备模块的目标密钥。

az iot hub module-identity show

获取 IoT 中心内 IoT 设备模块的详细信息。

az iot hub module-identity update

更新 IoT 中心设备模块。

az iot hub module-twin

管理 IoT 设备模块孪生配置。

az iot hub module-twin replace

将模块孪生定义替换为目标 json。

az iot hub module-twin show

显示模块孪生定义。

az iot hub module-twin update

更新模块孪生所需的属性和标记。

az iot hub monitor-events

监视设备遥测 & 发送到 IoT 中心的消息。

az iot hub monitor-feedback

监视设备发送的反馈,以确认云到设备 (C2D) 消息。

az iot hub policy

管理 IoT 中心的共享访问策略。

az iot hub policy create

在 IoT 中心创建新的共享访问策略。

az iot hub policy delete

从 IoT 中心删除共享访问策略。

az iot hub policy list

列出 IoT 中心的共享访问策略。

az iot hub policy renew-key

重新生成 IoT 中心的共享访问策略的密钥。

az iot hub policy show

获取 IoT 中心的共享访问策略的详细信息。

az iot hub query

使用功能强大的 SQL 语言查询 IoT 中心。

az iot hub route

管理 IoT 中心的路由。

az iot hub route create

在 IoT 中心创建路由。

az iot hub route delete

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

az iot hub route list

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

az iot hub route show

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

az iot hub route test

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

az iot hub route update

在 IoT 中心更新路由。

az iot hub routing-endpoint

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

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 show

获取 IoT 中心的详细信息。

az iot hub show-connection-string

显示 IoT 中心的连接字符串。

az iot hub show-quota-metrics

获取 IoT 中心的配额指标。

az iot hub show-stats

获取 IoT 中心的统计信息。

az iot hub update

更新 IoT 中心的元数据。

az iot hub create

创建 Azure IoT 中心。

有关 Azure IoT 中心的简介,请参阅 https://docs.microsoft.com/azure/iot-hub/

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--fc]
                  [--fcs]
                  [--fcu]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

示例

在资源组的区域中,使用免费定价层 F1 创建 IoT 中心。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

使用标记,在 "westus" 区域中创建具有标准定价层 S1 和4个分区的 IoT 中心。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

使用系统分配的托管标识创建 IoT 中心,并为创建的标识将角色和作用域分配给存储帐户。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

必需参数

--name -n

IoT 中心名称。

--resource-group -g

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

可选参数

--c2d-max-delivery-count --cdd

IoT 中心尝试将云到设备消息传递到设备的次数,介于1到100之间。

默认值: 10
--c2d-ttl --ct

在 IoT 中心过期之前,消息可用于设备使用的时间长度介于1到48小时之间。

默认值: 1
--fc --fileupload-storage-container-name

上载文件的根容器的名称。 容器不需要存在,但应使用指定的 connectionString 进行创建。

--fcs --fileupload-storage-connectionstring

要将文件上传到的 Azure 存储帐户的连接字符串。

--fcu --fileupload-storage-container-uri

要将文件上传到的 Azure 存储帐户的容器 URI。

--fd --feedback-max-delivery-count

IoT 中心尝试在反馈队列上传递消息的次数,介于1到100之间。

默认值: 10
--feedback-lock-duration --fld

反馈队列的锁定持续时间,介于5到300秒之间。

默认值: 5
--feedback-ttl --ft

IoT 中心维护云到设备消息过期或交付反馈的时间段,介于1到48小时之间。

默认值: 1
--fileupload-notification-max-delivery-count --fnd

IoT 中心尝试发送文件通知消息的次数,介于1到100之间。

默认值: 10
--fileupload-notification-ttl --fnt

在 IoT 中心过期之前,文件上传通知可用于服务的时间长度介于1到48小时之间。

默认值: 1
--fileupload-notifications --fn

一个布尔值,该值指示是否将有关已上载文件的信息记录到 messages/加盖标记/filenotifications IoT 中心终结点。

接受的值: false, true
--fileupload-sas-ttl --fst

IoT 中心生成的 SAS URI 在过期之前的有效时间,介于1到24小时之间。

默认值: 1
--fileupload-storage-auth-type --fsa

要将文件上传到的 Azure 存储帐户的身份验证类型。 可能的值为 keyBased 和 identityBased。

--fileupload-storage-identity --fsi

用于文件上传身份验证的托管标识。 使用 "[system]" 来表示系统分配的托管标识,或使用资源 ID 引用用户分配的托管标识。

--location -l

IoT 中心的位置。 默认值是目标资源组的位置。

--mi-system-assigned

为此中心启用系统分配的托管标识。

接受的值: false, true
--mi-user-assigned

为此中心启用用户分配的托管标识。 接受标识资源 Id 的空格分隔列表。

--min-tls-version --mintls

指定要为此中心支持的最低 TLS 版本。 可以设置为 "1.2",以使使用低于1.2 的 TLS 版本的客户端被拒绝。

--partition-count

适用于设备到云的消息的后备事件中心的分区数。

默认值: 4
--rd --retention-day

指定此 IoT 中心将在1到7天内维护设备到云事件的时间长度。

默认值: 1
--role

要分配给集线器系统分配的托管标识的角色。

--scopes

要为系统分配的托管标识分配角色的范围的空格分隔列表。 (--role)

--sku

Azure IoT 中心的定价层。 请注意,每个订阅中仅允许 (F1) 一个免费的 IoT 中心实例。 如果可用实例超过一个,则将引发异常。

接受的值: B1, B2, B3, F1, S1, S2, S3
默认值: S1
--subscription

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

--tags

空格分隔标记:键 [= 值] [键 [= 值] ...]。使用 "" 清除现有标记。

--unit

IoT 中心的设备。

默认值: 1

az iot hub delete

删除 IoT 中心。

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

示例

删除 IoT 中心。 (自动生成)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

可选参数

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

az iot hub generate-sas-token

为目标 IoT 中心、设备或模块生成 SAS 令牌。

对于设备 SAS 令牌,策略参数仅用于访问设备注册表。 因此,策略应具有注册表的读取访问权限。 对于 IoT 中心标记,策略是 SAS 的一部分。

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

示例

使用 iothubowner 策略和主密钥生成 IoT 中心 SAS 令牌。

az iot hub generate-sas-token -n {iothub_name}

使用 registryRead 策略和辅助密钥生成 IoT 中心 SAS 令牌。

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

使用 iothubowner 策略生成设备 SAS 令牌以访问 {iothub_name} 设备注册表。

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

使用与注册表访问) (的 IoT 中心连接字符串生成设备 SAS 令牌

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用 IoT 中心连接字符串生成 Iot 中心 SAS 令牌

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用设备连接字符串生成设备 SAS 令牌

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用模块连接字符串生成模块 SAS 令牌

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

可选参数

--auth-type

指示操作应自动派生策略密钥还是使用当前 Azure AD 会话。 你可以使用配置默认的 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--connection-string --cs

目标连接字符串。 这会绕过 IoT 中心注册表,直接从提供的对称密钥生成 SAS 令牌,而无需进一步验证。 除 duration 之外的所有其他命令参数都将被忽略。 支持的连接字符串类型: Iot 中心、设备、模块。

--device-id -d

目标设备。

--du --duration

有效的令牌持续时间(秒)。

默认值: 3600
--hub-name -n

IoT 中心名称。

--key-type --kt

用于身份验证的共享访问策略密钥类型。

接受的值: primary, secondary
默认值: primary
--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--module-id -m

目标模块。

--pn --policy-name

具有目标 IoT 中心实体的操作权限的共享访问策略。

默认值: iothubowner
--resource-group -g

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

az iot hub invoke-device-method

调用设备方法。

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

示例

从云中调用设备上的直接方法。

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

必需参数

--device-id -d

目标设备。

--method-name --mn

用于调用的目标方法。

可选参数

--auth-type

指示操作应自动派生策略密钥还是使用当前 Azure AD 会话。 你可以使用配置默认的 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--method-payload --mp

要传递给方法的 Json 有效负载。 必须是文件路径或原始 json。

默认值: {}
--resource-group -g

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

--timeout --to

等待设备方法结果的最大秒数。

默认值: 30

az iot hub invoke-module-method

调用 Edge 模块方法。

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

示例

使用云中的模块调用边缘设备上的直接方法。

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

必需参数

--device-id -d

目标设备。

--method-name --mn

用于调用的目标方法。

--module-id -m

目标模块。

可选参数

--auth-type

指示操作应自动派生策略密钥还是使用当前 Azure AD 会话。 你可以使用配置默认的 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--method-payload --mp

要传递给方法的 Json 有效负载。 必须是文件路径或原始 json。

默认值: {}
--resource-group -g

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

--timeout --to

等待设备方法结果的最大秒数。

默认值: 30

az iot hub list

列出 IoT 中心。

az iot hub list [--query-examples]
                [--resource-group]
                [--subscription]

示例

列出订阅中的所有 IoT 中心。

az iot hub list

列出资源组 "MyGroup" 中的所有 IoT 中心

az iot hub list --resource-group MyGroup

可选参数

--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--resource-group -g

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

--subscription

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

az iot hub list-skus

列出可用定价层。

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

示例

列出可用定价层。 (自动生成)

az iot hub list-skus --name MyIoTHub

可选参数

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

az iot hub manual-failover

为 IoT 中心启动手动故障转移到地域配对的灾难恢复区域。

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

示例

启动从主要区域到次要区域的故障转移 "myhub"。

az iot hub manual-failover -n myhub

可选参数

--ids

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

--name -n

IoT 中心名称。

--no-wait

不等待长时间运行的操作完成。

--resource-group -g

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

--subscription

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

az iot hub monitor-events

监视设备遥测 & 发送到 IoT 中心的消息。

实验要求 Python 3.5 + 此命令依赖于,并且可能会在首次执行时安装依赖 Cython 包 (uamqp) 。 https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

示例

基本用法

az iot hub monitor-events -n {iothub_name}

IoT 中心连接字符串的基本用法

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

在目标设备上进行筛选时的基本用法

az iot hub monitor-events -n {iothub_name} -d {device_id}

使用 ID 中的通配符筛选目标设备时的基本用法

az iot hub monitor-events -n {iothub_name} -d Device*

使用 IoT 中心查询语言筛选设备

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

筛选设备,并指定要绑定到的事件中心使用者组。

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

(消息标头接收消息批注)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

接收消息注释 + 系统属性。 永远不会超时。

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

接收所有设备消息中的所有消息属性

az iot hub monitor-events -n {iothub_name} --props all

接收所有消息并将消息负载分析为 JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

可选参数

--cg --consumer-group -c

指定连接到事件中心终结点时要使用的使用者组。

默认值: $Default
--content-type --ct

指定消息有效负载的内容类型,以自动将输出格式设置为该类型。

--device-id -d

目标设备。

--device-query -q

指定用于筛选设备的自定义查询。

--enqueued-time --et -e

指示从分区读取消息时应使用的时间。 自 unix epoch 起,单位为毫秒。 如果未指定任何时间,则使用。

--hub-name -n

IoT 中心名称。

--interface -i

要筛选的目标接口标识符。 例如: dtmi: com: example: TemperatureController; 1。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--module-id -m

目标模块。

--properties --props -p

指示要输出的关键消息属性。 sys = 系统属性,应用 = 应用程序属性,基督 = 注释。

接受的值: all, anno, app, sys
--repair -r

重新安装与扩展版本兼容的 uamqp 依赖项。 默认值:false。

接受的值: false, true
--resource-group -g

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

--timeout --to -t

保持连接的最大秒数,不接收消息。 使用0表示无限大。

默认值: 300
--yes -y

跳过用户提示。 如果需要,则表示接受依赖安装 () 。 主要用于自动化方案。 默认值:false。

接受的值: false, true

az iot hub monitor-feedback

监视设备发送的反馈,以确认云到设备 (C2D) 消息。

实验要求 Python 3.4 + 此命令依赖于,并且可能会在首次执行时安装依赖 Cython 包 (uamqp) 。 https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

示例

基本用法

az iot hub monitor-feedback -n {iothub_name}

IoT 中心连接字符串的基本用法

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

在目标设备上进行筛选时的基本用法

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

接收具有特定 id (uuid) 的消息时退出反馈监视器

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

可选参数

--auth-type

指示操作应自动派生策略密钥还是使用当前 Azure AD 会话。 你可以使用配置默认的 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--device-id -d

目标设备。

--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--repair -r

重新安装与扩展版本兼容的 uamqp 依赖项。 默认值:false。

接受的值: false, true
--resource-group -g

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

--wait-on-msg -w

反馈监视器将被阻止,直到收到具有特定 id (uuid) 的消息。

--yes -y

跳过用户提示。 如果需要,则表示接受依赖安装 () 。 主要用于自动化方案。 默认值:false。

接受的值: false, true

az iot hub query

使用功能强大的 SQL 语言查询 IoT 中心。

使用功能强大的 SQL 的语言查询 IoT 中心,检索有关设备和模块孪生、作业和消息路由的信息。 有关更多信息,请参见https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language。

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

示例

查询 Azure IoT 中心内的所有设备克隆数据。

az iot hub query -n {iothub_name} -q "select * from devices"

查询目标设备上的所有模块上的数据。

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

必需参数

--query-command -q

要执行的用户查询。

可选参数

--auth-type

指示操作应自动派生策略密钥还是使用当前 Azure AD 会话。 你可以使用配置默认的 az configure --defaults iothub-data-auth-type=<auth-type-value>

接受的值: key, login
默认值: key
--hub-name -n

IoT 中心名称。

--login -l

此命令支持具有执行操作的权限的实体连接字符串。 使用通过 "az login" 避免会话登录。 如果提供了实体连接字符串和名称,则连接字符串优先。

--resource-group -g

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

--top

要返回的元素的最大数目。 默认情况下,查询没有上限。

az iot hub show

获取 IoT 中心的详细信息。

az iot hub show [--ids]
                [--name]
                [--query-examples]
                [--resource-group]
                [--subscription]

示例

获取 IoT 中心的详细信息。 (自动生成)

az iot hub show --name MyIoTHub

可选参数

--ids

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

--name -n

IoT 中心名称。

--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--resource-group -g

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

--subscription

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

az iot hub show-connection-string

显示 IoT 中心的连接字符串。

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

示例

使用 "默认策略" 和 "主密钥" 显示 IoT 中心的连接字符串。

az iot hub show-connection-string --name MyIotHub

使用策略 "服务" 和辅助密钥显示 IoT 中心的连接字符串。

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

显示资源组中所有 IoT 中心的连接字符串。

az iot hub show-connection-string --resource-group MyResourceGroup

显示订阅中所有 IoT 中心的连接字符串。

az iot hub show-connection-string

显示 IoT 中心的连接字符串。 (自动生成)

az iot hub show-connection-string --key primary --policy-name MyPolicy

可选参数

--all

允许显示所有共享访问策略。

--hub-name --name -n

IoT 中心名称。

--ids

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

--key

要使用的密钥。

接受的值: primary, secondary
默认值: primary
--policy-name

要使用的共享访问策略。

默认值: iothubowner
--resource-group -g

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

--subscription

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

az iot hub show-quota-metrics

获取 IoT 中心的配额指标。

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

示例

获取 IoT 中心的配额指标。 (自动生成)

az iot hub show-quota-metrics --ids {ids}

获取 IoT 中心的配额指标。 (自动生成)

az iot hub show-quota-metrics --name MyIoTHub

可选参数

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

az iot hub show-stats

获取 IoT 中心的统计信息。

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

示例

获取 IoT 中心的统计信息。 (自动生成)

az iot hub show-stats --name MyIoTHub

可选参数

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

az iot hub update

更新 IoT 中心的元数据。

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--fc]
                  [--fcs]
                  [--fcu]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

示例

添加存储容器设置

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

添加防火墙筛选规则以接受来自 IP 掩码 127.0.0.0/31 的流量。

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

更新 IoT 中心的元数据。 (自动生成)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

将 IoT 中心的单位更新为2并添加标记

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

将 IoT 中心的定价层更新为 S2

az iot hub update -n MyIotHub --sku S2

将 IoT 中心设备到云事件的保留天数更新为3天

az iot hub update -n MyIotHub --retention-day 3

更新 IoT 中心云到设备的消息传送设置

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

更新 IoT 中心反馈队列设置

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

更新 IoT 中心文件上传设置,并为用户分配用于文件上传的托管标识

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

更新 IoT 中心文件上传通知设置

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications

可选参数

--add

通过指定路径和键值对,将对象添加到对象列表中。 示例:--添加 listProperty <键 = 值、字符串或 JSON 字符串>。

--c2d-max-delivery-count --cdd

IoT 中心尝试将云到设备消息传递到设备的次数,介于1到100之间。

--c2d-ttl --ct

在 IoT 中心过期之前,消息可用于设备使用的时间长度介于1到48小时之间。

--fc --fileupload-storage-container-name

上载文件的根容器的名称。 容器不需要存在,但应使用指定的 connectionString 进行创建。

--fcs --fileupload-storage-connectionstring

要将文件上传到的 Azure 存储帐户的连接字符串。

--fcu --fileupload-storage-container-uri

要将文件上传到的 Azure 存储帐户的容器 URI。

--fd --feedback-max-delivery-count

IoT 中心尝试在反馈队列上传递消息的次数,介于1到100之间。

--feedback-lock-duration --fld

反馈队列的锁定持续时间,介于5到300秒之间。

--feedback-ttl --ft

IoT 中心维护云到设备消息过期或交付反馈的时间段,介于1到48小时之间。

--fileupload-notification-max-delivery-count --fnd

IoT 中心尝试发送文件通知消息的次数,介于1到100之间。

--fileupload-notification-ttl --fnt

在 IoT 中心过期之前,文件上传通知可用于服务的时间长度介于1到48小时之间。

--fileupload-notifications --fn

一个布尔值,该值指示是否将有关已上载文件的信息记录到 messages/加盖标记/filenotifications IoT 中心终结点。

接受的值: false, true
--fileupload-sas-ttl --fst

IoT 中心生成的 SAS URI 在过期之前的有效时间,介于1到24小时之间。

--fileupload-storage-auth-type --fsa

要将文件上传到的 Azure 存储帐户的身份验证类型。 可能的值为 keyBased 和 identityBased。

--fileupload-storage-identity --fsi

用于文件上传身份验证的托管标识。 使用 "[system]" 来表示系统分配的托管标识,或使用资源 ID 引用用户分配的托管标识。

--force-string

使用 "set" 或 "add" 时,保留字符串文本,而不是尝试转换为 JSON。

--ids

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

--name -n

IoT 中心名称。

--rd --retention-day

指定此 IoT 中心将在1到7天内维护设备到云事件的时间长度。

--remove

从列表中删除属性或元素。 示例:--remove property. list 或--Remove propertyToRemove。

--resource-group -g

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

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1. property2 =.

--sku

Azure IoT 中心的定价层。 请注意,每个订阅中仅允许 (F1) 一个免费的 IoT 中心实例。 如果可用实例超过一个,则将引发异常。

接受的值: B1, B2, B3, F1, S1, S2, S3
--subscription

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

--tags

空格分隔标记:键 [= 值] [键 [= 值] ...]。使用 "" 清除现有标记。

--unit

IoT 中心的设备。