Jobs - Create Scheduled Job

  • Ссылка
Service:
IoT Hub
API Version:
2021-04-12

Создает новое задание для планирования обновлений двойников или направления методов в Центр Интернета вещей в запланированное время. Подробнее см. в разделе https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

PUT https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12

Параметры URI

Имя В Обязательно Тип Описание
id
 path True

string

Уникальный идентификатор задания.
api-version
 query True

string

Версия API.

Текст запроса

Имя Тип Описание
cloudToDeviceMethod

CloudToDeviceMethod

Тип и параметры метода. Это необходимо, если тип задания — cloudToDeviceMethod.
jobId

string

Уникальный идентификатор задания.
maxExecutionTimeInSeconds

integer

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

string

Условие для выполнения задания устройствами. Это необходимо, если тип задания — updateTwin или cloudToDeviceMethod.
startTime

string

Дата и время начала задания в стандарте ISO 8601.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Тип задания.
updateTwin

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

Ответы

Имя Тип Описание
200 OK

JobResponse

Все в порядке.

Определения

Имя Описание
CloudToDeviceMethod

Параметры для выполнения прямого метода на устройстве.
DeviceCapabilities

Состояние возможностей, включенных на устройстве.
DeviceJobStatistics

Статистика задания о состоянии выполнения.
JobRequest
JobResponse
Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.
TwinProperties

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта — 10.
X509Thumbprint

CloudToDeviceMethod

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

Имя Тип Описание
connectTimeoutInSeconds

integer

methodName

string

Имя метода, который необходимо выполнить.
payload

object

Полезные данные прямого метода в формате JSON размером до 128 КБ.
responseTimeoutInSeconds

integer

DeviceCapabilities

Состояние возможностей, включенных на устройстве.

Имя Тип Описание
iotEdge

boolean

Свойство, определяющее, является ли устройство пограничным устройством.

DeviceJobStatistics

Статистика задания о состоянии выполнения.

Имя Тип Описание
deviceCount

integer

Количество устройств, предназначенных для задания.
failedCount

integer

Количество неудачных заданий.
pendingCount

integer

Количество ожидающих (запланированных) заданий.
runningCount

integer

Количество выполняемых заданий.
succeededCount

integer

Количество успешных заданий.

JobRequest

Имя Тип Описание
cloudToDeviceMethod

CloudToDeviceMethod

Тип и параметры метода. Это необходимо, если тип задания — cloudToDeviceMethod.
jobId

string

Уникальный идентификатор задания.
maxExecutionTimeInSeconds

integer

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

string

Условие для выполнения задания устройствами. Это необходимо, если тип задания — updateTwin или cloudToDeviceMethod.
startTime

string

Дата и время начала задания в стандарте ISO 8601.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Тип задания.
updateTwin

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

JobResponse

Имя Тип Описание
cloudToDeviceMethod

CloudToDeviceMethod

Тип и параметры метода. Это необходимо, если тип задания — cloudToDeviceMethod.
createdTime

string

Создано системой. Игнорируется при создании. Дата и время создания задания.
deviceJobStatistics

DeviceJobStatistics

Сведения о состоянии выполнения задания.
endTime

string

Создано системой. Игнорируется при создании. Дата и время окончания задания в формате UTC.
failureReason

string

Причина сбоя, если произошел сбой.
jobId

string

Создано системой. Игнорируется при создании. Уникальный идентификатор задания.
maxExecutionTimeInSeconds

integer

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

string

Условие запроса устройства.
startTime

string

Дата и время начала запланированного задания в формате UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Создано системой. Игнорируется при создании. Состояние задания.
statusMessage

string

Сообщение о состоянии задания.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Тип задания.
updateTwin

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

Twin

Сведения о состоянии устройства или модуля. Он неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центр Интернета вещей.

Имя Тип Описание
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Тип проверки подлинности, используемый устройством.
capabilities

DeviceCapabilities

Состояние возможностей, включенных на устройстве.
cloudToDeviceMessageCount

integer

Количество отправленных сообщений из облака на устройство.
connectionState enum:
  • Connected
  • Disconnected

Состояние подключения устройства.
deviceEtag

string

Строка, представляющая ETag для устройства в RFC7232.
deviceId

string

Уникальный идентификатор устройства в реестре удостоверений Центр Интернета вещей. Это строка с учетом регистра (длиной до 128 символов) из 7-разрядных буквенно-цифровых символов ASCII. и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "*", "?", "!", "(", ")", ",", "=", "@", ";", "$", "", """}.
deviceScope

string

Область действия устройства.
etag

string

Строка, представляющая ETag для двойника устройства в RFC7232.
lastActivityTime

string

Дата и время последнего подключения устройства, получения или отправки сообщения. Дата и время являются последовательными в формате ISO8601 в формате UTC, например 2015-01-28T16:24:48.789Z. Это значение не обновляется, если устройство использует протокол HTTP/1 для выполнения операций обмена сообщениями.
moduleId

string

Уникальный идентификатор модуля в реестре удостоверений Центр Интернета вещей. Это строка с учетом регистра (длиной до 128 символов) из 7-разрядных буквенно-цифровых символов ASCII. и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "*", "?", "!", "(", ")", ",", "=", "@", ";", "$", "", """}.
parentScopes

string[]

Области пограничных устройств верхнего уровня, если применимо. Доступно только для пограничных устройств.
properties

TwinProperties

Требуемые и сообщаемые свойства двойника.
status enum:
  • disabled
  • enabled

Состояние включенного устройства. Если этот параметр отключен, устройство не сможет подключиться к службе.
statusReason

string

Причина текущего состояния устройства, если оно есть.
statusUpdateTime

string

Дата и время последнего обновления состояния устройства.
tags

object

Коллекция пар "ключ-значение", считываемых и записываемых внутренней частью решения. Они не видны приложениям устройств. Они имеют кодировку UTF-8 с учетом регистра и имеют длину до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Значениями являются объекты JSON длиной до 4 КБ.
version

integer

Версия двойника устройства, включая теги и требуемые свойства
x509Thumbprint

X509Thumbprint

Отпечаток устройства X509.

TwinProperties

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта — 10.

Имя Тип Описание
desired

object

Коллекция требуемых пар "ключ-значение" свойств. Ключи в кодировке UTF-8 с учетом регистра и длиной до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Требуемыми значениями porperty являются объекты JSON длиной до 4 КБ.
reported

object

Коллекция сообщаемых пар "ключ-значение" свойств. Ключи в кодировке UTF-8 с учетом регистра и длиной до 1 КБ. Допустимые символы исключают управляющие символы ЮНИКОДа (сегменты C0 и C1), ".", "$" и пробел. Сообщаемые значения свойств представляют собой объекты JSON длиной до 4 КБ.

X509Thumbprint

Имя Тип Описание
primaryThumbprint

string

Основной отпечаток сертификата клиента X509.
secondaryThumbprint

string

Дополнительный отпечаток сертификата клиента X509.