az iot hub state

  • Экспериментальный

Note

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение автоматически установит первый запуск команды az iot hub state. Подробнее о расширениях.

Эта группа команд экспериментальна и находится в стадии разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Управление состоянием IoT Hub.

Дополнительные сведения см. в aka.ms/aziotcli-iot-hub-state.

Команды

Имя Описание Тип Состояние
az iot hub state export

Экспорт состояния IoT Hub в файл.

 Extension Experimental
az iot hub state import

Импорт состояния концентратора из файла в IoT Hub.

 Extension Experimental
az iot hub state migrate

Перенос состояния одного концентратора в другой, не сохраняя его в файл.

 Extension Experimental

az iot hub state export

Экспериментальный

Группа команд "Состояние концентратора iot" является экспериментальной и находится в стадии разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Экспорт состояния IoT Hub в файл.

По умолчанию экспортируемое состояние будет включать в себя шаблон arm для концентратора, конфигураций концентратора (включая конфигурации ADM и пограничные развертывания), сведения об устройстве (включая идентификаторы устройств, двойники устройств, удостоверения модулей и двойники модулей).

Дополнительные сведения см. в aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--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

Путь к файлу, в котором будут храниться сведения о состоянии.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--aspects

Аспекты концентратора (разделенные пробелами).

Свойство Значение
Допустимые значения: arm, configurations, devices
--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство Значение
Группа параметров: Access Control Arguments
Default value: key
Допустимые значения: key, login
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--replace -r

Если этот флаг задан, команда перезаписывает содержимое выходного файла.

Свойство Значение
Default value: False
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot hub state import

Экспериментальный

Группа команд "Состояние концентратора iot" является экспериментальной и находится в стадии разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Импорт состояния концентратора из файла в IoT Hub.

Если указан аспект руки, концентратор будет создан, если он не существует.

По умолчанию импортированное состояние будет включать в себя шаблон arm для концентратора, конфигураций концентратора (включая конфигурации ADM и пограничные развертывания), сведения об устройстве (включая идентификаторы устройств, двойники устройств, удостоверения модулей и двойники модулей).

Для импортированных конечных точек с проверкой подлинности назначаемого системой удостоверения указанный концентратор должен иметь правильные разрешения. В противном случае команда завершится ошибкой.

Частные конечные точки будут игнорироваться в процессе импорта.

Дополнительные сведения см. в aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--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

Путь к файлу, в котором будут храниться сведения о состоянии.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--aspects

Аспекты концентратора (разделенные пробелами).

Свойство Значение
Допустимые значения: arm, configurations, devices
--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство Значение
Группа параметров: Access Control Arguments
Default value: key
Допустимые значения: key, login
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--login -l

Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--replace -r

Если этот флаг задан, команда удаляет текущие устройства, конфигурации и сертификаты целевого концентратора.

Свойство Значение
Default value: False
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot hub state migrate

Экспериментальный

Группа команд "Состояние концентратора iot" является экспериментальной и находится в стадии разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Перенос состояния одного концентратора в другой, не сохраняя его в файл.

Если указан аспект руки, концентратор будет создан, если он не существует.

По умолчанию перенесенное состояние будет включать в себя шаблон arm для концентратора, конфигураций концентратора (включая конфигурации ADM и пограничные развертывания), сведения об устройстве (включая идентификаторы устройств, двойники устройств, удостоверения модулей и двойники модулей).

Для перенесенных конечных точек с проверкой подлинности назначаемого системой удостоверения указанный концентратор должен иметь правильные разрешения. В противном случае команда завершится ошибкой.

Частные конечные точки будут игнорироваться в процессе миграции.

Если у вас возникли проблемы с миграцией, используйте команды экспорта и импорта, чтобы иметь файл в качестве резервной копии.

Дополнительные сведения см. в aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--acquire-policy-token]
                         [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--change-reference]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--aspects

Аспекты концентратора (разделенные пробелами).

Свойство Значение
Допустимые значения: arm, configurations, devices
--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.

Свойство Значение
Группа параметров: Access Control Arguments
Default value: key
Допустимые значения: key, login
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--destination-hub --dh

Имя IoT Hub, в которую будет скопировано состояние концентратора источника.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--destination-hub-login --dl

Эта команда поддерживает сущность, connection string с правами на выполнение действий в целевом центре. Используйте для предотвращения входа в сеанс через az login для этого экземпляра IoT Hub. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если --destination-hub не указан.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--destination-resource-group --dg

Имя группы ресурсов IoT Hub, в которую будет скопировано состояние концентратора источника. Если это не указано, используйте группу ресурсов IoT Hub источника.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--og --origin-resource-group

Имя группы ресурсов IoT Hub, которая будет скопирована.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--oh --origin-hub

Имя IoT Hub, которое будет скопировано.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--ol --origin-hub-login

Эта команда поддерживает сущность connection string с правами на выполнение действий в центре источника. Используйте для предотвращения входа в сеанс через az login для этого экземпляра IoT Hub. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если --origin-hub не указан.

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--replace -r

Если этот флаг задан, команда удаляет текущие устройства, конфигурации и сертификаты целевого концентратора.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False