Поделиться через

az iot du instance

Note

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

Управление экземплярами обновления устройств.

Команды

Имя Описание Тип Состояние
az iot du instance create

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

 Extension GA
az iot du instance delete

Удаление экземпляра обновления устройства.

 Extension GA
az iot du instance list

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

 Extension GA
az iot du instance show

Отображение экземпляра обновления устройства.

 Extension GA
az iot du instance update

Обновление экземпляра обновления устройства.

 Extension GA
az iot du instance wait

Блокировать до тех пор, пока не будет выполнено требуемое состояние ресурса экземпляра.

 Extension 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

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments
--instance -i

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

Свойство Значение
Группа параметров: Account Identifier Arguments
--iothub-ids

Идентификаторы ресурсов Центра Интернета вещей, разделенные пробелами.

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

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

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

--diagnostics-storage-id

Пользователь предоставил идентификатор ресурса учетной записи хранения для использования в коллекции журналов диагностики.

Свойство Значение
Группа параметров: Storage Arguments
--enable-diagnostics

Включает коллекцию журналов диагностики.

Свойство Значение
Допустимые значения: false, true
--no-wait

Не ожидать завершения длительной операции.

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

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

Свойство Значение
Группа параметров: Account Identifier Arguments
--tags

Теги ресурсов. Контейнер свойств в парах "ключ-значение" со следующим форматом: a=b=b=d.

Глобальные параметры
--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 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

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments
--instance -i

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

Свойство Значение
Группа параметров: Account Identifier Arguments

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

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

--no-wait

Не ожидать завершения длительной операции.

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

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

Свойство Значение
Группа параметров: Account Identifier Arguments
--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: false.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--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 du instance list

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

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

Примеры

Вывод списка экземпляров, связанных с целевой учетной записью.

az iot du instance list -n {account_name}

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

--account -n

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments

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

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

--resource-group -g

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

Свойство Значение
Группа параметров: Account Identifier Arguments
Глобальные параметры
--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 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

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments
--instance -i

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

Свойство Значение
Группа параметров: Account Identifier Arguments

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

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

--resource-group -g

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

Свойство Значение
Группа параметров: Account Identifier Arguments
Глобальные параметры
--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 du instance update

Обновление экземпляра обновления устройства.

В настоящее время можно обновить следующие свойства экземпляра — iotHubs, enableDiagnostics, diagnosticsStorageProperties и теги.

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

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments
--instance -i

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

Свойство Значение
Группа параметров: Account Identifier Arguments

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

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

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: False
--no-wait

Не ожидать завершения длительной операции.

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

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--resource-group -g

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

Свойство Значение
Группа параметров: Account Identifier Arguments
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
Глобальные параметры
--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 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

Имя учетной записи обновления устройства. Имя учетной записи по умолчанию можно настроить с помощью az config set defaults.adu_account={name}.

Свойство Значение
Группа параметров: Account Identifier Arguments
--instance -i

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

Свойство Значение
Группа параметров: Account Identifier Arguments

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

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

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Группа параметров: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--interval

Интервал опроса в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Свойство Значение
Группа параметров: Account Identifier Arguments
--timeout

Максимальное ожидание в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
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