az iot hub job

  • Ссылка

Примечание.

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

Управление заданиями Центр Интернета вещей (версия 2).

Команды

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

Отмена задания Центр Интернета вещей.

 Расширение Общедоступная версия
az iot hub job create

Создание и планирование задания Центр Интернета вещей для выполнения.

 Расширение Общедоступная версия
az iot hub job list

Перечислить исторические задания Центр Интернета вещей.

 Расширение Общедоступная версия
az iot hub job show

Отображение сведений о существующем задании Центр Интернета вещей.

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

az iot hub job cancel

Отмена задания Центр Интернета вещей.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Примеры

Отмена задания Центр Интернета вещей.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

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

--job-id

Центр Интернета вещей идентификатор задания.

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

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

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

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

--verbose

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

az iot hub job create

Создание и планирование задания Центр Интернета вещей для выполнения.

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

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Примеры

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

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

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

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

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

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

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

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

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

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

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

--job-id

Центр Интернета вещей идентификатор задания.

--job-type --jt

Тип запланированного задания.

допустимые значения: scheduleDeviceMethod, scheduleUpdateTwin

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--duration --poll-duration

Общая длительность в секундах, когда состояние задания будет проверка, если флаг -wait передается.

значение по умолчанию: 600
--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--interval --poll-interval

Интервал в секундах, когда состояние задания будет проверка, если флаг -wait передается.

значение по умолчанию: 10
--login -l

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

--mct --method-connect-timeout

Максимальное количество секунд, ожидающее подключения устройства.

значение по умолчанию: 30
--method-name --mn

Целевой метод для вызова.

--method-payload --mp

Полезные данные Json, передаваемые в метод. Должен быть путь к файлу или необработанный json.

--method-response-timeout --mrt

Максимальное количество секунд, ожидающее результата метода устройства.

значение по умолчанию: 30
--patch --twin-patch

Требуемое исправление двойника. Укажите путь к файлу или необработанный json.

--query-condition -q

Условие запроса устройства, чтобы получить устройства для выполнения задания. Требуется, если тип задания — scheduleDeviceMethod или scheduleUpdateTwin. Примечание. Служба будет префикс "SELECT * FROM устройства WHERE" для входных данных.

--resource-group -g

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

--start --start-time

Запланированное начало задания в формате даты ISO 8601. Если время начала не указано, задание помещается в очередь для выполнения asap. Использование настраиваемого времени начала, которое в прошлом может привести к сбою операции.

--ttl

Максимальное время выполнения в секундах перед завершением задания.

значение по умолчанию: 3600
--wait -w

Блокировать до тех пор, пока созданное задание не будет завершено, завершилось сбоем или отменено. Регулярно опрашивать интервал, указанный в интервале --poll-interval.

допустимые значения: false, true
значение по умолчанию: False
Глобальные параметры
--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 hub job list

Перечислить исторические задания Центр Интернета вещей.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Примеры

Вывод списка всех архивных заданий в течение периода хранения (максимум 30 дней).

az iot hub job list --hub-name {iothub_name}

Вывод списка всех архивных заданий, проектируемых определенных свойств

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Вывод списка только заданий типа двойника

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Перечисление заданий методов устройства с состоянием "scheduled"

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

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

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--job-status --js

Состояние запланированного задания.

допустимые значения: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Тип запланированного задания.

допустимые значения: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

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

--resource-group -g

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

--top

Максимальное количество возвращаемых элементов. Используйте -1 для неограниченного количества.

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

Отображение сведений о существующем задании Центр Интернета вещей.

az iot hub job show --job-id
                    [--auth-type {key, login}]
                    [--hub-name]
                    [--login]
                    [--resource-group]

Примеры

Отображение сведений о созданном задании.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

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

--job-id

Центр Интернета вещей идентификатор задания.

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

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

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

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

--verbose

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