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

az iot du instance

注意

此参考是 Azure CLI(版本 2.46.0 或更高版本)的 azure-iot 扩展的一部分。 该扩展将在首次运行 az iot du instance 命令时自动安装。 详细了解扩展。

设备更新实例管理。

命令

名称 说明 类型 Status
az iot du instance create

创建设备更新实例。

扩展 GA
az iot du instance delete

删除设备更新实例。

扩展 GA
az iot du instance list

列出设备更新实例。

扩展 GA
az iot du instance show

显示设备更新实例。

扩展 GA
az iot du instance update

更新设备更新实例。

扩展 GA
az iot du instance wait

阻止,直到满足所需的实例资源状态。

扩展 GA

az iot du instance create

创建设备更新实例。

此命令还可用于更新现有实例的状态。

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

示例

创建配置最少的实例。

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

创建启用了诊断的实例,与用户提供的存储帐户配对。 包括标记。

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

必需参数

--account -n

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

--instance -i

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

--iothub-ids

空间分隔IoT 中心资源 ID。

可选参数

--diagnostics-storage-id

用户提供的存储帐户资源 ID 用于诊断日志收集。

--enable-diagnostics

启用诊断日志收集。

接受的值: false, true
--no-wait

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

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

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

--tags

资源标记。 采用以下格式的键值对中的属性包:a=b c=d。

全局参数
--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 du instance delete

删除设备更新实例。

az iot du instance delete --account
                          --instance
                          [--no-wait]
                          [--resource-group]
                          [--yes {false, true}]

示例

删除与目标帐户关联的实例。

az iot du instance delete -n {account_name} -i {instance_name}

删除与目标帐户关联的实例,并跳过确认提示。

az iot du instance delete -n {account_name} -i {instance_name} -y

必需参数

--account -n

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

--instance -i

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

可选参数

--no-wait

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

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

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

--yes -y

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

接受的值: false, true
全局参数
--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 du instance list

列出设备更新实例。

az iot du instance list --account
                        [--resource-group]

示例

列出与目标帐户关联的实例。

az iot du instance list -n {account_name}

必需参数

--account -n

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

可选参数

--resource-group -g

设备更新帐户资源组名称。 可以使用 az config set defaults.adu_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 du instance show

显示设备更新实例。

az iot du instance show --account
                        --instance
                        [--resource-group]

示例

显示与目标帐户关联的实例的详细信息。

az iot du instance show -n {account_name} -i {instance_name}

必需参数

--account -n

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

--instance -i

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

可选参数

--resource-group -g

设备更新帐户资源组名称。 可以使用 az config set defaults.adu_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 du instance update

更新设备更新实例。

目前可以更新以下实例属性 - iotHubs、enableDiagnostics、diagnosticStorageProperties 和标记。

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

示例

设置特定的实例标记属性。

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

启用诊断并配置用于日志收集的存储帐户。

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

必需参数

--account -n

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

--instance -i

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

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>

默认值: []
--force-string

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

默认值: False
--no-wait

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

默认值: False
--remove

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

默认值: []
--resource-group -g

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

--set

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

默认值: []
全局参数
--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 du instance wait

阻止,直到满足所需的实例资源状态。

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

示例

在删除目标实例之前阻止。

az iot du instance wait -n {account_name} -i {instance_name} --deleted

必需参数

--account -n

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

--instance -i

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--interval

轮询间隔(以秒为单位)。

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

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

--timeout

最大等待(以秒为单位)。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--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 获取完整的调试日志。