az iot du device deployment

  • Ссылка

Примечание.

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.37.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды 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

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

 Расширение Общедоступная версия

az iot du device deployment cancel

Отмена развертывания подгруппы класса устройства.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --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>.

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

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

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

--verbose

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

az iot du device deployment create

Создайте развертывание для группы устройств. Развертывание будет выполняться с несколькими приведениями к каждой подгруппе класса устройств в целевой группе.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--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>.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

--instance -i

Имя экземпляра обновления устройства. Можно настроить имя экземпляра по умолчанию с помощью az config set defaults.adu_instance=<name>.

--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 -g

Имя группы ресурсов учетной записи обновления устройства. Вы можете настроить расположение по умолчанию с помощью az config set defaults.adu_group=<name>.

--start-time

Время начала развертывания, соответствующее стандарту ISO-8601. Если не указано соответствующее значение для UTC "now", будет использоваться.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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

az iot du device deployment delete

Удаление развертывания по группе устройств или подгруппе класса устройств.

az iot du device deployment delete --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--cid]
                                   [--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>.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

--instance -i

Имя экземпляра обновления устройства. Можно настроить имя экземпляра по умолчанию с помощью az config set defaults.adu_instance=<name>.

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

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

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

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

--verbose

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

az iot du device deployment list

Вывод списка развертываний для подгруппы группы устройств или класса устройств.

az iot du device deployment list --account
                                 --gid
                                 --instance
                                 [--cid]
                                 [--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>.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

--instance -i

Имя экземпляра обновления устройства. Можно настроить имя экземпляра по умолчанию с помощью az config set defaults.adu_instance=<name>.

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

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

--order-by

Упорядочивает возвращенный набор развертываний. Вы можете заказать по startDateTime [desc/asc].

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

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

--verbose

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

az iot du device deployment list-devices

Вывод списка устройств в развертывании подгруппы класса устройств вместе с их состоянием. Полезно для получения списка неудачных устройств.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --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>.

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

--instance -i

Имя экземпляра обновления устройства. Можно настроить имя экземпляра по умолчанию с помощью az config set defaults.adu_instance=<name>.

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

--filter

Ограничивает набор возвращенных состояний устройства развертывания. Вы можете отфильтровать идентификатор устройства и moduleId и (или) deviceState.

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

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

--verbose

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

az iot du device deployment retry

Повторите развертывание подгруппы класса устройства.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --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>.

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

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

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

--verbose

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

az iot du device deployment show

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

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--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>.

--deployment-id --did

Идентификатор развертывания, предоставленный вызывающим. Это не может быть больше 73 символов, должно быть все строчные буквы и не может содержать "&", "^", "[", "]", "{", "}", "|<>", "", косая черта, обратная косая черта или двойная кавычка.

--gid --group-id

Идентификатор группы устройств. Это создается из значения тега ADUGroup в двойнике устройства или модуля подключенного Центр Интернета вещей или $default для устройств без тега.

--instance -i

Имя экземпляра обновления устройства. Можно настроить имя экземпляра по умолчанию с помощью az config set defaults.adu_instance=<name>.

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

--cid --class-id

Идентификатор класса устройства. Это создается из идентификатора модели и свойств compat, сообщаемых агентом обновления устройства в интерфейсе PnP обновления устройства в Центр Интернета вещей. Это хэш, закодированный в шестнадцатеричном формате SHA1.

--resource-group -g

Имя группы ресурсов учетной записи обновления устройства. Вы можете настроить расположение по умолчанию с помощью az config set defaults.adu_group=<name>.

--status

Возвращает состояние развертывания, включая разбивку количества устройств в развертывании, завершенных или неудачных.

допустимые значения: false, true
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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