Scheduled Jobs - Create

Referencia

Servicio:: IoT Central

Versión de la API:: 2022-07-31

Cree o actualice un trabajo programado por identificador.

PUT https://{subdomain}.{baseDomain}/api/scheduledJobs/{scheduledJobId}?api-version=2022-07-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
scheduledJobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Identificador único del trabajo programado.
subdomain	path	True	string	Subdominio de aplicación.
api-version	query	True	string	Versión de la API a la que se llama.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
data	True	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Datos relacionados con la operación que realiza este trabajo. Todas las entradas deben ser del mismo tipo.
group	True	string	Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo programado.
schedule	True	JobSchedule	Programación en la que se va a ejecutar el trabajo.
batch		JobBatch	Configuración de procesamiento por lotes para el trabajo programado.
cancellationThreshold		JobCancellationThreshold	Umbral de cancelación del trabajo programado.
description		string	Descripción detallada del trabajo programado.
displayName		string	Nombre para mostrar del trabajo programado.
enabled		boolean	Indica si el trabajo programado está habilitado.
etag		string	ETag usado para evitar conflictos en las actualizaciones de trabajos programadas.
organizations		string[]	Lista de organizaciones del trabajo, solo se admite una organización hoy en día, pronto se admitirán varias organizaciones.

Respuestas

Nombre	Tipo	Description
200 OK	ScheduledJob	Éxito
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

ScheduledJob

Éxito

Other Status Codes

Error

Respuesta de error recibida del servicio IoT Central.

Encabezados

x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a scheduled job

Solicitud de ejemplo

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/scheduledJobs/newScheduledJobId?api-version=2022-07-31

{
  "displayName": "New Scheduled Job",
  "description": "",
  "group": "ad86219f-d224-48ad-a29b-b593a4e4bb38",
  "data": [
    {
      "type": "command",
      "target": "dtmi:modelDefinition:test;1",
      "path": "Reboot",
      "value": null
    }
  ],
  "schedule": {
    "start": "2022-05-24T22:29:01Z",
    "recurrence": "daily"
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "newScheduledJobId",
  "displayName": "New Scheduled Job",
  "description": "",
  "group": "ad86219f-d224-48ad-a29b-b593a4e4bb38",
  "data": [
    {
      "type": "command",
      "target": "dtmi:modelDefinition:bhmvjf0oj:k6ulbcbyndp",
      "path": "Reboot",
      "value": null
    }
  ],
  "schedule": {
    "start": "2022-05-24T22:29:01Z",
    "recurrence": "daily"
  },
  "enabled": true,
  "completed": false,
  "etag": "\"970070b9-0000-0800-0000-628d554b0000\""
}

Definiciones

Nombre	Description
CloudPropertyJobData	Datos del trabajo de propiedad en la nube.
CommandJobData	Definición de datos del trabajo de comando.
DateJobScheduleEnd	Definición de finalización basada en fechas de programación de trabajos.
DeviceTemplateMigrationJobData	Definición de datos del trabajo de migración de plantillas de dispositivo.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.
JobBatch	Definición del lote del trabajo.
JobBatchType	Indica si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.
JobCancellationThreshold	Definición del umbral de cancelación del trabajo.
JobCancellationThresholdType	Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.
JobRecurrence	Periodicidad del trabajo programado. Si no se proporciona, el trabajo se ejecutará una vez a la hora de inicio especificada.
JobSchedule	Definición de programación del trabajo.
OccurrencesJobScheduleEnd	La definición de finalización basada en las repeticiones de la programación de trabajos.
PropertyJobData	Definición de datos del trabajo de propiedad.
ScheduledJob	Definición del trabajo programado.

CloudPropertyJobData

Object

Datos del trabajo de propiedad en la nube.

Nombre	Tipo	Description
path	string	Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.
target	string minLength: 1	Plantilla de dispositivo que define la funcionalidad de destino para el trabajo.
type	string: cloudProperty	Tipo de los datos del trabajo.
value	AnyValue	Valor que se usa para actualizar la funcionalidad de destino, si existe.

CommandJobData

Object

Definición de datos del trabajo de comando.

Nombre	Tipo	Description
path	string	Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.
target	string minLength: 1	Plantilla de dispositivo que define la funcionalidad de destino para el trabajo.
type	string: command	Tipo de los datos del trabajo.
value	AnyValue	Valor que se usa para actualizar la funcionalidad de destino, si existe.

DateJobScheduleEnd

Object

Definición de finalización basada en fechas de programación de trabajos.

Nombre	Tipo	Description
date	string (date)	Fecha de finalización del trabajo programado.
type	string: date	Tipo de finalización de la programación del trabajo.

DeviceTemplateMigrationJobData

Object

Definición de datos del trabajo de migración de plantillas de dispositivo.

Nombre	Tipo	Description
template	string minLength: 1	Plantilla de dispositivo de destino a la que se migrarán los dispositivos.
type	string: deviceTemplateMigration	Tipo de los datos del trabajo.

Error

Object

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error de la solicitud actual.

ErrorDetails

Object

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Detalles del mensaje de error.
requestId	string	Id. de correlación para la solicitud actual.
time	string (date-time-rfc1123)	Hora en que se produjo un error en la solicitud de error.

JobBatch

Object

Definición del lote del trabajo.

Nombre	Tipo	Description
type	JobBatchType	Indica si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.
value	number	Número o porcentaje de dispositivos en los que se realiza el procesamiento por lotes.

JobBatchType

Enumeración

Indica si el procesamiento por lotes se realiza en un número especificado de dispositivos o en un porcentaje del total de dispositivos.

Valor	Description
number	Procesamiento por lotes de trabajos en función del número de dispositivos.
percentage	Porcentaje basado en procesamiento por lotes del trabajo de los dispositivos aplicados totales.

JobCancellationThreshold

Object

Definición del umbral de cancelación del trabajo.

Nombre	Tipo	Description
batch	boolean	Si el umbral de cancelación se aplica por lote o al trabajo general.
type	JobCancellationThresholdType	Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.
value	number	Número o porcentaje de dispositivos en los que se aplica el umbral de cancelación.

JobCancellationThresholdType

Enumeración

Si el umbral de cancelación es por un número especificado de dispositivos o un porcentaje del total de dispositivos.

Valor	Description
number	Umbral de cancelación de trabajos en función del número especificado de dispositivos.
percentage	Umbral de cancelación de trabajos en función del porcentaje de dispositivos totales.

JobRecurrence

Enumeración

Periodicidad del trabajo programado. Si no se proporciona, el trabajo se ejecutará una vez a la hora de inicio especificada.

Valor	Description
daily	El trabajo se ejecutará una vez al día
monthly	El trabajo se ejecutará una vez al mes.
weekly	El trabajo se ejecutará una vez cada semana.

JobSchedule

Object

Definición de programación del trabajo.

Nombre	Tipo	Description
end	JobScheduleEnd: DateJobScheduleEnd OccurrencesJobScheduleEnd	Especificación de cuándo finalizar el trabajo programado.
recurrence	JobRecurrence	Periodicidad del trabajo programado. Si no se proporciona, el trabajo se ejecutará una vez a la hora de inicio especificada.
start	string (date-time)	Hora de inicio del trabajo programado

OccurrencesJobScheduleEnd

Object

La definición de finalización basada en las repeticiones de la programación de trabajos.

Nombre	Tipo	Description
occurrences	integer (int32) minimum: 1 maximum: 999	Número de repeticiones después de las cuales finalizar el trabajo programado.
type	string: occurrences	Tipo de finalización de la programación del trabajo.

PropertyJobData

Object

Definición de datos del trabajo de propiedad.

Nombre	Tipo	Description
path	string	Ruta de acceso a la funcionalidad de destino dentro de la plantilla de dispositivo.
target	string minLength: 1	Plantilla de dispositivo que define la funcionalidad de destino para el trabajo.
type	string: property	Tipo de los datos del trabajo.
value	AnyValue	Valor que se usa para actualizar la funcionalidad de destino, si existe.

ScheduledJob

Object

Definición del trabajo programado.

Nombre	Tipo	Description
batch	JobBatch	Configuración de procesamiento por lotes para el trabajo programado.
cancellationThreshold	JobCancellationThreshold	Umbral de cancelación del trabajo programado.
completed	boolean	Si se ha completado el trabajo programado.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Datos relacionados con la operación que realiza este trabajo. Todas las entradas deben ser del mismo tipo.
description	string	Descripción detallada del trabajo programado.
displayName	string	Nombre para mostrar del trabajo programado.
enabled	boolean	Indica si el trabajo programado está habilitado.
etag	string	ETag usado para evitar conflictos en las actualizaciones de trabajos programadas.
group	string	Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo programado.
id	string	Identificador único del trabajo programado.
organizations	string[]	Lista de organizaciones del trabajo, solo se admite una organización hoy en día, pronto se admitirán varias organizaciones.
schedule	JobSchedule	Programación en la que se va a ejecutar el trabajo.

Compartir a través de

Scheduled Jobs - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create a scheduled job

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudPropertyJobData

CommandJobData

DateJobScheduleEnd

DeviceTemplateMigrationJobData

Error

ErrorDetails

JobBatch

JobBatchType

JobCancellationThreshold

JobCancellationThresholdType

JobRecurrence

JobSchedule

OccurrencesJobScheduleEnd

PropertyJobData

ScheduledJob