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

az iot hub state

注意

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

此命令组是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

管理IoT 中心的状态。

有关详细信息，请参阅 aka.ms/aziotcli-iot-hub-state。

命令

名称	说明	类型	Status
az iot hub state export	将IoT 中心的状态导出到文件。	扩展	实验
az iot hub state import	将中心状态从文件导入到IoT 中心。	扩展	实验
az iot hub state migrate	在不保存到文件的情况下，将一个中心的状态迁移到另一个中心。	扩展	实验

az iot hub state export

实验

命令组“iot 中心状态”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

将IoT 中心的状态导出到文件。

默认情况下，导出的状态将包括：中心、中心配置的 arm 模板（包括 ADM 配置和边缘部署）、设备信息（包括设备标识、设备孪生、模块标识和模块孪生）。

有关详细信息，请参阅 aka.ms/aziotcli-iot-hub-state。

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

示例

将指定中心支持的状态导出到指定文件。

az iot hub state export -n {iothub_name} -f {state_filename}

将指定中心支持的状态导出到指定文件，覆盖文件内容。

az iot hub state export -n {iothub_name} -f {state_filename} -r

仅将指定中心的设备和配置导出到指定的文件。

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

必需参数

--state-file -f

将存储状态信息的文件的路径。

可选参数

--aspects

中心方面（空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。 如果身份验证类型为登录，并且提供资源主机名，则除非需要，否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

默认值: key

--hub-name -n

IoT 中心名称或主机名。 如果未提供 --login，则为必需。

--login -l

此命令支持具有执行操作权限的实体连接字符串。 用于避免通过“az login”进行会话登录。 如果同时提供实体连接字符串和名称，则连接字符串优先。 如果未提供 --hub-name，则为必需。

--replace -r

如果设置了此标志，则该命令将覆盖输出文件的内容。

默认值: False

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

实验

命令组“iot 中心状态”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

将中心状态从文件导入到IoT 中心。

如果指定了臂方面，则中心将在不存在时创建。

默认情况下，导入的状态将包括：中心、中心配置的 arm 模板（包括 ADM 配置和边缘部署）、设备信息（包括设备标识、设备孪生、模块标识和模块孪生）。

对于具有系统分配的标识身份验证的导入终结点，指定的中心必须具有正确的权限。 否则命令将失败。

导入过程中将忽略专用终结点。

有关详细信息，请参阅 aka.ms/aziotcli-iot-hub-state。

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

示例

将支持的状态从指定的文件导入到指定的中心。

az iot hub state import -n {iothub_name} -f {state_filename}

将受支持的状态从指定文件导入到指定的中心，覆盖中心以前的状态。 在上传新状态之前，将删除所有证书、配置和设备。

az iot hub state import -n {iothub_name} -f {state_filename} -r

仅将 arm 模板从指定文件导入到指定的中心。 请注意，如果中心不存在，则会创建一个新中心。 该文件可能包含设备和配置，但将被忽略。

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

仅将设备和配置从指定文件导入到指定的中心。 请注意，如果它不存在，则不会创建新中心，并且命令将失败。 该文件可能包含 arm 模板，但将被忽略。

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

必需参数

--state-file -f

将存储状态信息的文件的路径。

可选参数

--aspects

中心方面（空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。 如果身份验证类型为登录，并且提供资源主机名，则除非需要，否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

默认值: key

--hub-name -n

IoT 中心名称或主机名。 如果未提供 --login，则为必需。

--login -l

此命令支持具有执行操作权限的实体连接字符串。 用于避免通过“az login”进行会话登录。 如果同时提供实体连接字符串和名称，则连接字符串优先。 如果未提供 --hub-name，则为必需。

--replace -r

如果设置了此标志，则该命令将删除目标中心的当前设备、配置和证书。

默认值: False

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

实验

命令组“iot 中心状态”是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

在不保存到文件的情况下，将一个中心的状态迁移到另一个中心。

如果指定了臂方面，则中心将在不存在时创建。

默认情况下，迁移的状态将包括：中心、中心配置的 arm 模板（包括 ADM 配置和边缘部署）、设备信息（包括设备标识、设备孪生、模块标识和模块孪生）。

对于具有系统分配的标识身份验证的已迁移终结点，指定的中心必须具有正确的权限。 否则命令将失败。

迁移过程中将忽略专用终结点。

如果在迁移时遇到问题，请使用导出和导入命令将文件作为备份。

有关详细信息，请参阅 aka.ms/aziotcli-iot-hub-state。

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

示例

将源中心支持的状态迁移到目标中心。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

将源中心支持的状态迁移到目标中心，覆盖中心以前的状态。 在上传新状态之前，将删除目标中心中的所有证书、配置和设备。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

仅将 arm 模板从源中心迁移到目标中心。 请注意，如果目标中心不存在，则会创建新中心。 源中心可能包含设备和配置，但这些设备将被忽略。

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

仅将设备和配置从源中心迁移到目标中心。 请注意，如果目标中心不存在并且命令将失败，则不会创建新中心。 将忽略源中心的 arm 模板。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

可选参数

--aspects

中心方面（空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。 如果身份验证类型为登录，并且提供资源主机名，则除非需要，否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

默认值: key

--destination-hub --dh

将源中心状态复制到的IoT 中心的名称。

--destination-hub-login --dl

此命令支持具有对目标中心执行操作的权限的实体连接字符串。 用于避免通过az login此IoT 中心实例登录会话。 如果同时提供实体连接字符串和名称，则连接字符串优先。 如果未提供 --destination-hub，则为必需。

--destination-resource-group --dg

将源中心状态复制到的IoT 中心资源组的名称。 如果未提供，将使用源IoT 中心的资源组。

--og --origin-resource-group

要复制IoT 中心的资源组的名称。

--oh --origin-hub

将复制IoT 中心的名称。

--ol --origin-hub-login

此命令支持具有对源中心执行操作的权限的实体连接字符串。 用于避免通过az login此IoT 中心实例登录会话。 如果同时提供实体连接字符串和名称，则连接字符串优先。 如果未提供 --origin-hub，则为必需。

--replace -r

如果设置了此标志，则该命令将删除目标中心的当前设备、配置和证书。

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