az iot hub job

Note

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

Управление заданиями IoT Hub (версия 2).

Команды

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

Отмена задания IoT Hub.

 Extension GA
az iot hub job create

Создание и планирование задания IoT Hub для выполнения.

 Extension GA
az iot hub job list

Перечисление исторических заданий IoT Hub.

 Extension GA
az iot hub job show

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

 Extension GA

az iot hub job cancel

Отмена задания IoT Hub.

az iot hub job cancel --job-id
                      [--acquire-policy-token]
                      [--auth-type {key, login}]
                      [--change-reference]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Примеры

Отмена задания IoT Hub.

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

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

--job-id

IoT Hub идентификатор задания.

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

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

--acquire-policy-token

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

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

Создание и планирование задания IoT Hub для выполнения.

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

az iot hub job create --job-id
                      --job-type --jt {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--acquire-policy-token]
                      [--auth-type {key, login}]
                      [--change-reference]
                      [--duration --poll-duration]
                      [--hub-name]
                      [--interval --poll-interval]
                      [--login]
                      [--mct --method-connect-timeout]
                      [--method-name --mn]
                      [--method-payload --mp]
                      [--method-response-timeout --mrt]
                      [--patch --twin-patch]
                      [--query-condition]
                      [--resource-group]
                      [--start --start-time]
                      [--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

IoT Hub идентификатор задания.

--job-type --jt

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

Свойство Значение
Допустимые значения: scheduleDeviceMethod, scheduleUpdateTwin

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

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

--acquire-policy-token

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

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

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

Свойство Значение
Default value: 600
--hub-name -n

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

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

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

Свойство Значение
Default value: 10
--login -l

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

Свойство Значение
Группа параметров: IoT Hub Identifier Arguments
--mct --method-connect-timeout

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

Свойство Значение
Default value: 30
--method-name --mn

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

--method-payload --mp

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

--method-response-timeout --mrt

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

Свойство Значение
Default value: 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

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

Свойство Значение
Default value: 3600
--wait -w

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

Свойство Значение
Default value: 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 hub job list

Перечисление исторических заданий IoT Hub.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status --js {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type --jt {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}.

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

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

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

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

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

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

Свойство Значение
Допустимые значения: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

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

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

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

--top

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

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

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

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

IoT Hub идентификатор задания.

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

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

--auth-type

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

Свойство Значение
Группа параметров: Access Control Arguments
Default value: key
Допустимые значения: key, login
--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
--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