Compartir a través de


Job Scheduler - Create Item Schedule

Cree una nueva programación para un elemento. Un elemento puede crear un máximo de 20 programadores.

Ámbitos delegados necesarios:

Item.Execute.All y Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad Apoyo
Usuario
de entidad de servicio y identidades administradas No

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules

Parámetros de identificador URI

Nombre En Requerido Tipo Description
itemId
path True

string

uuid

Identificador del elemento.

jobType
path True

string

Tipo de trabajo.

workspaceId
path True

string

uuid

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
configuration True ScheduleConfig:

Los datos reales contienen la hora y los días laborables de esta programación.

enabled True

boolean

Indica si esta programación está habilitada. True: habilitado, False: deshabilitado.

Respuestas

Nombre Tipo Description
201 Created

ItemSchedule

Cree correctamente la programación.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InsufficientPrivileges: el autor de la llamada no tiene permisos suficientes para acceder al elemento.

  • ItemNotFound: no se encontró el identificador de elemento solicitado

  • ScheduleExceedsLimit: el número de programaciones creadas para el elemento supera el límite.

Ejemplos

create item schedule example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules

{
  "enabled": true,
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  }
}

Respuesta de muestra

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules/235faf08-6ca0-488d-a2ca-6d706d530ebc
{
  "id": "235faf08-6ca0-488d-a2ca-6d706d530ebc",
  "enabled": true,
  "createdDateTime": "2024-04-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  },
  "owner": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  }
}

Definiciones

Nombre Description
CreateScheduleRequest

Cree una carga de solicitud de plan de programación de elementos.

CronScheduleConfig
DailyScheduleConfig
DayOfWeek

Se permite una lista de días laborables, como máximo siete elementos.

ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.

ErrorResponse

Respuesta de error.

ErrorResponseDetails

Detalles de la respuesta de error.

GroupDetails

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

GroupType

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

ItemSchedule

Programación de elementos.

Principal

Representa una identidad o un grupo de Microsoft Entra.

PrincipalType

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

ServicePrincipalDetails

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

ServicePrincipalProfileDetails

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

UserDetails

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

WeeklyScheduleConfig

CreateScheduleRequest

Cree una carga de solicitud de plan de programación de elementos.

Nombre Tipo Description
configuration ScheduleConfig:

Los datos reales contienen la hora y los días laborables de esta programación.

enabled

boolean

Indica si esta programación está habilitada. True: habilitado, False: deshabilitado.

CronScheduleConfig

Nombre Tipo Description
endDateTime

string

date-time

Hora de finalización de esta programación. La hora de finalización debe ser posterior a la hora de inicio.

interval

integer

int32

Intervalo de tiempo en minutos. Número comprendido entre 1 y 5270400 (10 años).

localTimeZoneId

string

El registro de identificadores de zona horaria en el equipo local para windows, consulte zona horaria predeterminada

startDateTime

string

date-time

Hora de inicio de esta programación. Si la hora de inicio está en el pasado, desencadenará un trabajo al instante.

type string:

Cron

Una cadena representa el tipo del plan. Se pueden agregar tipos planType adicionales a lo largo del tiempo.

DailyScheduleConfig

Nombre Tipo Description
endDateTime

string

date-time

Hora de finalización de esta programación. La hora de finalización debe ser posterior a la hora de inicio.

localTimeZoneId

string

El registro de identificadores de zona horaria en el equipo local para windows, consulte zona horaria predeterminada

startDateTime

string

date-time

Hora de inicio de esta programación. Si la hora de inicio está en el pasado, desencadenará un trabajo al instante.

times

string[]

Se permite una lista de espacios de tiempo en formato hh:mm, como máximo 100 elementos.

type string:

Daily

Una cadena representa el tipo del plan. Se pueden agregar tipos planType adicionales a lo largo del tiempo.

DayOfWeek

Se permite una lista de días laborables, como máximo siete elementos.

Valor Description
Friday

Viernes

Monday

Lunes

Saturday

Sábado

Sunday

Domingo

Thursday

Jueves

Tuesday

Martes

Wednesday

Miércoles

ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.

resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.

message

string

Representación legible del error.

moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.

relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.

message

string

Representación legible del error.

relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

GroupDetails

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre Tipo Description
groupType

GroupType

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupType

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

Valor Description
DistributionList

La entidad de seguridad es una lista de distribución.

SecurityGroup

La entidad de seguridad es un grupo de seguridad.

Unknown

El tipo de grupo principal es desconocido.

ItemSchedule

Programación de elementos.

Nombre Tipo Description
configuration ScheduleConfig:

Los datos reales contienen la hora y los días laborables de esta programación.

createdDateTime

string

date-time

Marca de tiempo creada de esta programación en utc.

enabled

boolean

Indica si esta programación está habilitada. True: habilitado, False: deshabilitado.

id

string

uuid

Identificador de programación.

owner

Principal

Identidad del usuario que creó esta programación o modificó por última vez.

Principal

Representa una identidad o un grupo de Microsoft Entra.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad.

groupDetails

GroupDetails

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

id

string

uuid

Identificador de la entidad de seguridad.

servicePrincipalDetails

ServicePrincipalDetails

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

type

PrincipalType

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

userDetails

UserDetails

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

PrincipalType

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor Description
Group

La entidad de seguridad es un grupo de seguridad.

ServicePrincipal

La entidad de seguridad es una entidad de servicio de Microsoft Entra.

ServicePrincipalProfile

La entidad de servicio es un perfil de entidad de servicio.

User

La entidad de seguridad es una entidad de seguridad de usuario de Microsoft Entra.

ServicePrincipalDetails

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre Tipo Description
aadAppId

string

uuid

Microsoft Entra AppId de la entidad de servicio.

ServicePrincipalProfileDetails

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre Tipo Description
parentPrincipal

Principal

La entidad de seguridad principal del perfil de la entidad de servicio.

UserDetails

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre Tipo Description
userPrincipalName

string

Nombre principal de usuario.

WeeklyScheduleConfig

Nombre Tipo Description
endDateTime

string

date-time

Hora de finalización de esta programación. La hora de finalización debe ser posterior a la hora de inicio.

localTimeZoneId

string

El registro de identificadores de zona horaria en el equipo local para windows, consulte zona horaria predeterminada

startDateTime

string

date-time

Hora de inicio de esta programación. Si la hora de inicio está en el pasado, desencadenará un trabajo al instante.

times

string[]

Se permite una lista de espacios de tiempo en formato hh:mm, como máximo 100 elementos.

type string:

Weekly

Una cadena representa el tipo del plan. Se pueden agregar tipos planType adicionales a lo largo del tiempo.

weekdays

DayOfWeek[]

Se permite una lista de días laborables, como máximo siete elementos.