Jobs - Create Scheduled Job

Referencia

Servicio:: IoT Hub

Versión de la API:: 2021-04-12

Crea un nuevo trabajo para programar actualizaciones de gemelos o métodos directos en el IoT Hub a una hora programada. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obtener más información.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	Identificador único del trabajo.
api-version	query	True	string	Versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
cloudToDeviceMethod	CloudToDeviceMethod	Tipo de método y parámetros. Esto es necesario si el tipo de trabajo es cloudToDeviceMethod.
jobId	string	Identificador único del trabajo.
maxExecutionTimeInSeconds	integer	Tiempo de ejecución máximo en secounds.
queryCondition	string	Condición para que los dispositivos ejecuten el trabajo. Esto es necesario si el tipo de trabajo es updateTwin o cloudToDeviceMethod.
startTime	string	Fecha y hora de inicio del trabajo en la norma ISO 8601.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	El tipo de trabajo.
updateTwin	Twin	Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

Respuestas

Nombre	Tipo	Description
200 OK	JobResponse	Aceptar.

Definiciones

Nombre	Description
CloudToDeviceMethod	Parámetros para ejecutar un método directo en el dispositivo.
DeviceCapabilities	Estado de las funcionalidades habilitadas en el dispositivo.
DeviceJobStatistics	Estadísticas del trabajo con respecto al estado de ejecución.
JobRequest
JobResponse
Twin	Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.
TwinProperties	Las propiedades deseadas y notificadas del gemelo. La profundidad máxima del objeto es 10.
X509Thumbprint

CloudToDeviceMethod

Parámetros para ejecutar un método directo en el dispositivo.

Nombre	Tipo	Description
connectTimeoutInSeconds	integer
methodName	string	Nombre del método que se va a ejecutar.
payload	object	La carga del método directo con formato JSON, de hasta 128 kb de tamaño.
responseTimeoutInSeconds	integer

DeviceCapabilities

Estado de las funcionalidades habilitadas en el dispositivo.

Nombre	Tipo	Description
iotEdge	boolean	Propiedad que determina si el dispositivo es un dispositivo perimetral o no.

DeviceJobStatistics

Estadísticas del trabajo con respecto al estado de ejecución.

Nombre	Tipo	Description
deviceCount	integer	Número de dispositivos de destino del trabajo.
failedCount	integer	Número de trabajos con errores.
pendingCount	integer	Número de trabajos pendientes (programados).
runningCount	integer	Número de trabajos en ejecución.
succeededCount	integer	Número de trabajos correctos.

JobRequest

Nombre	Tipo	Description
cloudToDeviceMethod	CloudToDeviceMethod	Tipo de método y parámetros. Esto es necesario si el tipo de trabajo es cloudToDeviceMethod.
jobId	string	Identificador único del trabajo.
maxExecutionTimeInSeconds	integer	Tiempo de ejecución máximo en secounds.
queryCondition	string	Condición para que los dispositivos ejecuten el trabajo. Esto es necesario si el tipo de trabajo es updateTwin o cloudToDeviceMethod.
startTime	string	Fecha y hora de inicio del trabajo en la norma ISO 8601.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	El tipo de trabajo.
updateTwin	Twin	Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

JobResponse

Nombre	Tipo	Description
cloudToDeviceMethod	CloudToDeviceMethod	Tipo de método y parámetros. Esto es necesario si el tipo de trabajo es cloudToDeviceMethod.
createdTime	string	Sistema generado. Se omite en la creación. Fecha y hora de creación del trabajo.
deviceJobStatistics	DeviceJobStatistics	Los detalles relacionados con el estado de ejecución del trabajo.
endTime	string	Sistema generado. Se omite en la creación. Fecha y hora de finalización del trabajo en UTC.
failureReason	string	Motivo del error, si se produjo un error.
jobId	string	Sistema generado. Se omite en la creación. Identificador único del trabajo.
maxExecutionTimeInSeconds	integer	Tiempo de ejecución máximo en secounds.
queryCondition	string	Condición de consulta del dispositivo.
startTime	string	Fecha y hora de inicio del trabajo programado en UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Sistema generado. Se omite en la creación. El estado del trabajo.
statusMessage	string	Mensaje de estado del trabajo.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	El tipo de trabajo.
updateTwin	Twin	Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

Twin

Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

Nombre	Tipo	Description
authenticationType	enum: certificateAuthority none sas selfSigned	Tipo de autenticación usado por el dispositivo.
capabilities	DeviceCapabilities	Estado de las funcionalidades habilitadas en el dispositivo.
cloudToDeviceMessageCount	integer	Número de mensajes de nube a dispositivo enviados.
connectionState	enum: Connected Disconnected	Estado de conexión del dispositivo.
deviceEtag	string	Cadena que representa una ETag para el dispositivo, según RFC7232.
deviceId	string	Identificador único del dispositivo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope	string	El ámbito del dispositivo.
etag	string	Cadena que representa un ETag para el dispositivo gemelo, según RFC7232.
lastActivityTime	string	Fecha y hora en que el dispositivo se conectó por última vez o recibió o envió un mensaje. La fecha y hora se especifican en ISO8601 formato datetime en UTC, por ejemplo, 2015-01-28T16:24:48.789Z. Este valor no se actualiza si el dispositivo usa el protocolo HTTP/1 para realizar operaciones de mensajería.
moduleId	string	Identificador único del módulo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes	string[]	Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.
properties	TwinProperties	Las propiedades deseadas y notificadas del gemelo.
status	enum: disabled enabled	Estado habilitado del dispositivo. Si está deshabilitado, el dispositivo no puede conectarse al servicio.
statusReason	string	Motivo del estado actual del dispositivo, si existe.
statusUpdateTime	string	Fecha y hora en que se actualizó por última vez el estado del dispositivo.
tags	object	Colección de pares clave-valor leídos y escritos por el back-end de la solución. No son visibles para las aplicaciones de dispositivo. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores son objetos JSON, de hasta 4 KB de longitud.
version	integer	La versión del dispositivo gemelo, incluidas las etiquetas y las propiedades deseadas
x509Thumbprint	X509Thumbprint	Huella digital X509 del dispositivo.

TwinProperties

Las propiedades deseadas y notificadas del gemelo. La profundidad máxima del objeto es 10.

Nombre	Tipo	Description
desired	object	Colección de pares clave-valor de propiedad deseada. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores de porperty deseados son objetos JSON, de hasta 4 KB de longitud.
reported	object	Colección de pares clave-valor de propiedad notificados. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores de propiedad notificados son objetos JSON, de hasta 4 KB de longitud.

X509Thumbprint

Nombre	Tipo	Description
primaryThumbprint	string	Huella digital principal del certificado de cliente X509.
secondaryThumbprint	string	Huella digital secundaria del certificado de cliente X509.

Compartir a través de