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

az iot du device deployment

Note

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

设备部署管理。

部署将针对目标设备组应用所需的兼容更新，从而跨组内的设备类分发更新。可以选择配置云发起的回滚策略。

命令

名称	说明	类型	Status
az iot du device deployment cancel	取消设备类子组部署。	Extension	GA
az iot du device deployment create	为设备组创建部署。部署将针对目标组中的每个设备类子组进行多转换。	Extension	GA
az iot du device deployment delete	按设备组或设备类子组删除部署。	Extension	GA
az iot du device deployment list	列出设备组或设备类子组的部署。	Extension	GA
az iot du device deployment list-devices	列出设备类子组部署中的设备及其状态。可用于获取失败的设备列表。	Extension	GA
az iot du device deployment retry	重试设备类子组部署。	Extension	GA
az iot du device deployment show	显示设备组或设备类子组的部署，包括状态，其中详细说明了部署中有多少设备正在进行、已完成或失败。	Extension	GA

az iot du device deployment cancel

取消设备类子组部署。

az iot du device deployment cancel --account
                                   --cid --class-id
                                   --deployment-id --did
                                   --gid --group-id
                                   --instance
                                   [--resource-group]

示例

取消目标设备类子组部署。

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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 config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

全局参数

--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 du device deployment create

为设备组创建部署。部署将针对目标组中的每个设备类子组进行多转换。

az iot du device deployment create --account
                                   --deployment-id --did
                                   --gid --group-id
                                   --instance
                                   --un --update-name
                                   --up --update-provider
                                   --update-version --uv
                                   [--failed-count --fc]
                                   [--failed-percentage --fp]
                                   [--rbun --rollback-update-name]
                                   [--rbup --rollback-update-provider]
                                   [--rbuv --rollback-update-version]
                                   [--resource-group]
                                   [--start-time]

示例

创建计划立即启动的设备组部署（相对于 UTC 时间）。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

创建计划以在符合 iso-8601 的日期/时间开始的设备组部署。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

创建计划以使用定义的云发起的回滚策略立即启动的设备组部署。满足失败计数或失败百分比目标时，将启动云回滚。

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

--un --update-name

更新名称。

属性	值
Parameter group:	Update Id Arguments

--up --update-provider

更新提供程序。

属性	值
Parameter group:	Update Id Arguments

--update-version --uv

更新版本。

属性	值
Parameter group:	Update Id Arguments

可选参数

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

--failed-count --fc

整数表示在发生云初始化回滚之前部署中失败的设备数。定义回滚策略时是必需的。

属性	值
Parameter group:	Update Rollback Policy Arguments

--failed-percentage --fp

整数，表示在发生云初始化回滚之前部署中失败设备的百分比。定义回滚策略时是必需的。

属性	值
Parameter group:	Update Rollback Policy Arguments

--rbun --rollback-update-name

回滚更新名称。

属性	值
Parameter group:	Update Rollback Policy Arguments

--rbup --rollback-update-provider

回滚更新提供程序。

属性	值
Parameter group:	Update Rollback Policy Arguments

--rbuv --rollback-update-version

回滚更新版本。

属性	值
Parameter group:	Update Rollback Policy Arguments

--resource-group -g

设备更新帐户资源组名称。可以使用 az config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

--start-time

符合 iso-8601 的部署开始时间。如果未提供任何值，将使用 UTC“now”的相应值。

全局参数

--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 du device deployment delete

按设备组或设备类子组删除部署。

az iot du device deployment delete --account
                                   --deployment-id --did
                                   --gid --group-id
                                   --instance
                                   [--cid --class-id]
                                   [--resource-group]
                                   [--yes {false, true}]

示例

删除目标设备组部署。

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}

删除目标设备类子组部署。

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--resource-group -g

设备更新帐户资源组名称。可以使用 az config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

--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 du device deployment list

列出设备组或设备类子组的部署。

az iot du device deployment list --account
                                 --gid --group-id
                                 --instance
                                 [--cid --class-id]
                                 [--order-by]
                                 [--resource-group]

示例

列出设备组的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}

通过 startDateTime 降序列出设备组排序结果的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

列出设备类子组的部署。

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--order-by

对返回的部署集进行排序。可以按 startDateTime [desc/asc] 排序。

--resource-group -g

设备更新帐户资源组名称。可以使用 az config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

全局参数

--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 du device deployment list-devices

列出设备类子组部署中的设备及其状态。可用于获取失败的设备列表。

az iot du device deployment list-devices --account
                                         --cid --class-id
                                         --deployment-id --did
                                         --gid --group-id
                                         --instance
                                         [--filter]
                                         [--resource-group]

示例

列出设备类子组部署中的设备。

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

按 deviceId 和 deviceState 列出设备类子组部署筛选中的设备。

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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

--filter

限制返回的部署设备状态集。可以筛选 deviceId 和 moduleId 和/或 deviceState。

--resource-group -g

设备更新帐户资源组名称。可以使用 az config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

全局参数

--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 du device deployment retry

重试设备类子组部署。

az iot du device deployment retry --account
                                  --cid --class-id
                                  --deployment-id --did
                                  --gid --group-id
                                  --instance
                                  [--resource-group]

示例

重试目标设备类子组部署。

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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 config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

全局参数

--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 du device deployment show

显示设备组或设备类子组的部署，包括状态，其中详细说明了部署中有多少设备正在进行、已完成或失败。

az iot du device deployment show --account
                                 --deployment-id --did
                                 --gid --group-id
                                 --instance
                                 [--cid --class-id]
                                 [--resource-group]
                                 [--status {false, true}]

示例

显示设备组的部署。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}

显示设备组部署的状态。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status

显示设备类子组的部署。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

显示设备类子组部署的状态。

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

必需参数

--account -n

设备更新帐户名称。可以使用 az config set defaults.adu_account={name}配置默认帐户名称。

属性	值
Parameter group:	Account Identifier Arguments

--deployment-id --did

调用方提供的部署 ID。这不能超过 73 个字符，必须为所有小写字符，不能包含&、、、^、[]{}|<正斜杠、反斜杠或双引号。 >

--gid --group-id

设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的，或者为没有标记的设备创建$default。

--instance -i

设备更新实例名称。可以使用 az config set defaults.adu_instance={name}配置默认实例名称。

属性	值
Parameter group:	Account Identifier Arguments

可选参数

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

--cid --class-id

设备类 ID。这是从 IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。它是十六进制编码的 SHA1 哈希。

--resource-group -g

设备更新帐户资源组名称。可以使用 az config set defaults.adu_group={name}配置默认组。

属性	值
Parameter group:	Account Identifier Arguments

--status

获取部署的状态，包括部署中有多少设备正在进行、已完成或失败的细分。

属性	值
接受的值:	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 du device deployment

命令

az iot du device deployment cancel

示例

必需参数

可选参数

az iot du device deployment create

示例

必需参数

可选参数

az iot du device deployment delete

示例

必需参数

可选参数

az iot du device deployment list

示例

必需参数

可选参数

az iot du device deployment list-devices

示例

必需参数

可选参数

az iot du device deployment retry

示例

必需参数

可选参数

az iot du device deployment show

示例

必需参数

可选参数

反馈