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

az iot du update

注意

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

设备更新更新管理。

命令

名称 说明 类型 状态
az iot du update calculate-hash

计算文件的 base64 哈希表示形式。

分机 GA
az iot du update delete

删除特定更新版本。

分机 GA
az iot du update file

更新文件操作。

扩展 GA
az iot du update file list

列出更新提供程序、名称和版本相关的更新文件 ID。

扩展 GA
az iot du update file show

显示与更新提供程序、名称和版本相关的特定更新文件的详细信息。

分机 GA
az iot du update import

将新的更新版本导入设备更新实例。

分机 GA
az iot du update init

用于导入清单初始化的实用工具。

分机 预览
az iot du update init v5

使用所需状态初始化 v5 导入清单。

扩展 预览版
az iot du update list

列出已导入到设备更新实例的更新。

扩展 GA
az iot du update show

显示特定的更新版本。

分机 GA
az iot du update stage

暂存要导入到目标实例的更新。

扩展 预览

az iot du update calculate-hash

计算文件的 base64 哈希表示形式。

az iot du update calculate-hash --file-path
                                [--hash-algo {sha256}]

示例

计算目标更新文件的 sha256 摘要的 base64 表示形式。

az iot du update calculate-hash --file-path /path/to/file

计算多个目标更新文件的 sha256 摘要的 base64 表示形式。

az iot du update calculate-hash --file-path /path/to/file1 --file-path /path/to/file2 --file-path /path/to/file3

必需参数

--file-path -f

用于哈希计算的目标文件的本地路径。 --file-path 可以使用 1 次或多次。

可选参数

--hash-algo

用于哈希的加密算法。

接受的值: sha256
默认值: sha256
全局参数
--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 update delete

删除特定更新版本。

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

示例

删除与更新提供程序、名称和版本相关的目标更新。

az iot du update delete -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {update_version}

必需参数

--account -n

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

--instance -i

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

--un --update-name

更新名称。

--up --update-provider

更新提供程序。

--update-version --uv

更新版本。

可选参数

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

将新的更新版本导入设备更新实例。

此命令支持此功能 --defer 。 使用此命令时,会将要发送到 Azure 的对象有效负载存储在本地缓存中。 此命令的下一个用法不会 --defer 将新请求有效负载与一起发送这些负载的缓存对象组合在一起。

成功后,将清除相应的本地缓存条目。 如果发生故障,则不会删除缓存的内容。 使用 az cache 命令独立管理本地缓存条目。

延迟支持主要用于具有多个引用步骤的更新,因此父更新和子更新可以一起提交。

az iot du update import --account
                        --instance
                        --url
                        [--defer]
                        [--file]
                        [--friendly-name]
                        [--hashes]
                        [--no-wait]
                        [--resource-group]
                        [--size]

示例

使用两个相关文件导入更新,并且没有引用步骤,显式提供清单哈希值和清单大小(以字节为单位)。

az iot du update import -n {account_name} -i {instance_name} --hashes sha256={hash_value} --size {size_in_bytes} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

使用两个相关文件导入更新,并且没有引用步骤,让 CLI 计算导入清单哈希值和大小(以字节为单位)。

az iot du update import -n {account_name} -i {instance_name} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

使用两个子更新引用步骤导入父更新,其中所有三个导入清单都有一个相关文件。 让 CLI 计算所有哈希值和大小(以字节为单位)。 此操作将依赖于“--defer”功能。

az iot du update import -n {account_name} -i {instance_name} --url {parent_manifest_location} --file filename={parent_file_name} url={parent_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child1_manifest_location} --file filename={child1_file_name} url={child1_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child2_manifest_location} --file filename={child2_file_name} url={child2_file_url}

必需参数

--account -n

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

--instance -i

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

--url

设备更新可从中下载导入清单的可路由位置,以便IoT 中心。 这通常是一个只读受 SAS 保护的 Blob URL,过期时间设置为至少 3 小时。

可选参数

--defer

暂时将对象存储在本地缓存中,而不是发送到 Azure。 使用 az cache 命令查看/清除。

--file

与导入清单元数据文件属性对应的空格分隔键=值对。 所需的密钥包括文件名和 URL。 --file 可以使用 1 次或多次。

--friendly-name

与更新定义关联的友好名称。

--hashes

空格分隔的键=值对,其中键是使用的哈希算法,值为 base64 编码的导入清单文件哈希。 至少需要 sha256 条目。 如果未提供,则通过提供的 URL 进行计算。

--no-wait

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

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

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

--size

文件大小(字节数)。 如果未提供,则通过提供的 URL 进行计算。

全局参数
--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 update list

列出已导入到设备更新实例的更新。

列出更新提供程序时,除了公共实例查找参数之外,还需要提供 --by-provider 标志。 列出更新名称时,必须提供更新提供程序。 列出更新版本时,必须提供更新提供程序和更新名称。

az iot du update list --account
                      --instance
                      [--by-provider {false, true}]
                      [--filter]
                      [--resource-group]
                      [--search]
                      [--un]
                      [--up]

示例

列出所有更新。

az iot du update list -n {account_name} -i {instance_name}

列出满足自由文本搜索条件的所有更新,在本例中为 Contoso 的更新提供程序。

az iot du update list -n {account_name} -i {instance_name} --search 'Contoso'

列出满足 odata 筛选器的所有更新,在本例中筛选不可部署的更新。

az iot du update list -n {account_name} -i {instance_name} --filter 'isDeployable eq false'

列出所有更新提供程序。

az iot du update list -n {account_name} -i {instance_name} --by-provider

按更新提供程序列出所有更新名称。

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name}

按更新提供程序和更新名称列出所有更新版本。

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name}

必需参数

--account -n

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

--instance -i

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

可选参数

--by-provider

指示结果集应限制为更新提供程序的标志。

接受的值: false, true
--filter

限制属性值返回的更新集。 当列出没有约束的更新或按版本列出时受支持。

--resource-group -g

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

--search

请求与自由文本搜索表达式匹配的更新。 列出没有约束的更新时受支持。

--un --update-name

更新名称。

--up --update-provider

更新提供程序。

全局参数
--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 update show

显示特定的更新版本。

az iot du update show --account
                      --instance
                      --un
                      --up
                      --update-version
                      [--resource-group]

示例

显示与更新提供程序、名称和版本相关的特定更新。

az iot du update show -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {update_version}

必需参数

--account -n

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

--instance -i

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

--un --update-name

更新名称。

--up --update-provider

更新提供程序。

--update-version --uv

更新版本。

可选参数

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

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

暂存要导入到目标实例的更新。

暂存更新是指加速将更新导入到目标实例的先决条件步骤。 对于给定的导入清单,该过程将确定相关文件,将其推送到所需的存储容器,生成 SAS URI 并涵盖成功导入的其他准备步骤。

此命令取决于基于约定的更新文件组织。 目标清单的所有更新文件应位于导入清单所在的同一目录中。

基于密钥的访问用于上传 Blob 项目,并生成具有读取访问权限的 3 小时 SAS URI。

如果 --then-import 提供了标志,该命令将导入暂存更新。 否则,此操作的结果是一个导入命令,可在以后运行以实现相同的结果。

此命令将清除并刷新目标实例的任何本地缓存条目。

az iot du update stage --account
                       --instance
                       --manifest-path
                       --storage-account
                       --storage-container
                       [--friendly-name]
                       [--overwrite {false, true}]
                       [--resource-group]
                       [--storage-subscription]
                       [--then-import {false, true}]

示例

暂存独立更新。 更新文件应与清单位于同一目录中。 稍后可以执行生成的导入命令,以在 SAS 令牌过期之前启动暂存更新的导入。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json

暂存独立更新。 暂存后,使用所需的友好名称将更新导入实例。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json --then-import --friendly-name myAptUpdate

暂存多引用更新。 更新文件将上传到驻留在更新帐户的其他订阅中的存储 Blob 容器。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --storage-subscription {storage_account_subscription} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json

暂存多引用更新,覆盖现有 Blob(如果存在)。 暂存后,将更新导入实例。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json --then-import --overwrite

必需参数

--account -n

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

--instance -i

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

--manifest-path

应暂存的导入清单的本地文件路径。 可以使用 1 次或多次。

--storage-account

用于暂存导入清单项目的所需存储帐户名称。

--storage-container

用于暂存导入清单项目的所需存储容器名称。

可选参数

--friendly-name

与更新定义关联的友好名称。

--overwrite

指示是否存在冲突时是否应覆盖现有 Blob 的标志。

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

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

--storage-subscription

用于暂存导入清单项目的所需存储帐户订阅。 适用于不同订阅中的存储和设备更新帐户。

--then-import

指示是否应在暂存后导入更新的标志。

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