Compartilhar via


Job Scheduler - Create Item Schedule

Crie um novo agendamento para um item. Um item pode criar no máximo 20 agendadores.

Escopos delegados necessários:

Item.Execute.All e Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Não

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
itemId
path True

string

uuid

A ID do item.

jobType
path True

string

O tipo de trabalho.

workspaceId
path True

string

uuid

A ID do workspace.

Corpo da solicitação

Nome Obrigatório Tipo Description
configuration True ScheduleConfig:

Os dados reais contêm a hora/dias da semana deste agendamento.

enabled True

boolean

Se esse agendamento está habilitado. True – Habilitado, False – Desabilitado.

Respostas

Nome Tipo Description
201 Created

ItemSchedule

Crie a agenda com êxito.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InsufficientPrivileges - O chamador não tem permissões suficientes para acessar o item

  • ItemNotFound – ID de item solicitada não encontrada

  • ScheduleExceedsLimit - O número de agendas criadas para o item excede o limite

Exemplos

create item schedule example

Solicitação de exemplo

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
  }
}

Resposta de exemplo

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"
  }
}

Definições

Nome Description
CreateScheduleRequest

Criar conteúdo da solicitação do plano de agendamento de item.

CronScheduleConfig
DailyScheduleConfig
DayOfWeek

Uma lista de dias da semana, no máximo sete elementos são permitidos.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

ItemSchedule

Agendamento do item.

Principal

Representa uma identidade ou um grupo do Microsoft Entra.

PrincipalType

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

UserDetails

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

WeeklyScheduleConfig

CreateScheduleRequest

Criar conteúdo da solicitação do plano de agendamento de item.

Nome Tipo Description
configuration ScheduleConfig:

Os dados reais contêm a hora/dias da semana deste agendamento.

enabled

boolean

Se esse agendamento está habilitado. True – Habilitado, False – Desabilitado.

CronScheduleConfig

Nome Tipo Description
endDateTime

string

date-time

A hora de término dessa agenda. A hora de término deve ser posterior à hora de início.

interval

integer

int32

O intervalo de tempo em minutos. Um número entre 1 e 5270400 (10 anos).

localTimeZoneId

string

O registro do identificador de fuso horário no computador local para janelas, consulte Fusos Horários Padrão

startDateTime

string

date-time

A hora de início deste agendamento. Se a hora de início estiver no passado, ela disparará um trabalho instantaneamente.

type string:

Cron

Uma cadeia de caracteres representa o tipo do plano. Tipos de planType adicionais podem ser adicionados ao longo do tempo.

DailyScheduleConfig

Nome Tipo Description
endDateTime

string

date-time

A hora de término dessa agenda. A hora de término deve ser posterior à hora de início.

localTimeZoneId

string

O registro do identificador de fuso horário no computador local para janelas, consulte Fusos Horários Padrão

startDateTime

string

date-time

A hora de início deste agendamento. Se a hora de início estiver no passado, ela disparará um trabalho instantaneamente.

times

string[]

Uma lista de slots de tempo no formato hh:mm, no máximo 100 elementos são permitidos.

type string:

Daily

Uma cadeia de caracteres representa o tipo do plano. Tipos de planType adicionais podem ser adicionados ao longo do tempo.

DayOfWeek

Uma lista de dias da semana, no máximo sete elementos são permitidos.

Valor Description
Friday

Sexta-feira

Monday

Segunda-feira

Saturday

Sábado

Sunday

Domingo

Thursday

Quinta-feira

Tuesday

Terça-feira

Wednesday

Quarta-feira

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.

resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível humana do erro.

moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível humana do erro.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Nome Tipo Description
groupType

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor Description
DistributionList

Principal é uma lista de distribuição.

SecurityGroup

A entidade de segurança é um grupo de segurança.

Unknown

O tipo de grupo principal é desconhecido.

ItemSchedule

Agendamento do item.

Nome Tipo Description
configuration ScheduleConfig:

Os dados reais contêm a hora/dias da semana deste agendamento.

createdDateTime

string

date-time

O carimbo de data/hora criado dessa agenda em Utc.

enabled

boolean

Se esse agendamento está habilitado. True – Habilitado, False – Desabilitado.

id

string

uuid

A ID da agenda.

owner

Principal

A identidade do usuário que criou esse agendamento ou última modificação.

Principal

Representa uma identidade ou um grupo do Microsoft Entra.

Nome Tipo Description
displayName

string

O nome de exibição da entidade de segurança.

groupDetails

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

id

string

uuid

A ID da entidade de segurança.

servicePrincipalDetails

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

type

PrincipalType

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

userDetails

UserDetails

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

PrincipalType

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

Valor Description
Group

A entidade de segurança é um grupo de segurança.

ServicePrincipal

A entidade de segurança é uma entidade de serviço do Microsoft Entra.

ServicePrincipalProfile

Principal é um perfil de entidade de serviço.

User

Principal é uma entidade de usuário do Microsoft Entra.

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Nome Tipo Description
aadAppId

string

uuid

O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Nome Tipo Description
parentPrincipal

Principal

A entidade pai do perfil da entidade de serviço.

UserDetails

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

Nome Tipo Description
userPrincipalName

string

O nome da entidade de usuário.

WeeklyScheduleConfig

Nome Tipo Description
endDateTime

string

date-time

A hora de término dessa agenda. A hora de término deve ser posterior à hora de início.

localTimeZoneId

string

O registro do identificador de fuso horário no computador local para janelas, consulte Fusos Horários Padrão

startDateTime

string

date-time

A hora de início deste agendamento. Se a hora de início estiver no passado, ela disparará um trabalho instantaneamente.

times

string[]

Uma lista de slots de tempo no formato hh:mm, no máximo 100 elementos são permitidos.

type string:

Weekly

Uma cadeia de caracteres representa o tipo do plano. Tipos de planType adicionais podem ser adicionados ao longo do tempo.

weekdays

DayOfWeek[]

Uma lista de dias da semana, no máximo sete elementos são permitidos.