Background Jobs - Schedule Execute

Referência

Serviço:: Dataflow

Versão da API:: v1

Observação

Esta API está na versão prévia.

Crie um novo agendamento de execução para um fluxo de dados. Um fluxo de dados pode criar no máximo 20 agendadores.

Escopos delegados necessários:

Dataflow.Execute.All e Dataflow.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

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/schedules

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataflowId	path	True	string (uuid)	A ID do item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	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	DataflowSchedule	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

Nome

Tipo

Description

201 Created

DataflowSchedule

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 dataflow Execute schedule example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/schedules

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

Resposta de exemplo

Código de status:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/schedules/bbbbbbbb-1111-2222-3333-cccccccccccc

{
  "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "enabled": true,
  "createdDateTime": "2024-05-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2025-04-28T00:00:00",
    "endDateTime": "2025-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  },
  "owner": {
    "id": "33dd33dd-ee44-ff55-aa66-77bb77bb77bb",
    "type": "User"
  }
}

Definições

Nome	Description
CreateDataflowExecuteScheduleRequest	Criar conteúdo da solicitação do plano de agendamento de execução do fluxo de dados.
CronScheduleConfig
DailyScheduleConfig
DataflowSchedule	Agendamento de fluxo de dados.
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.
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

CreateDataflowExecuteScheduleRequest

Objeto

Criar conteúdo da solicitação do plano de agendamento de execução do fluxo de dados.

Nome	Tipo	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Os dados reais contêm a hora/dias da semana deste agendamento.
enabled	boolean	Se esse agendamento está habilitado. True – Habilitado, False – Desabilitado.

CronScheduleConfig

Objeto

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. Ele precisa estar em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
interval	integer (int32) minimum: 1 maximum: 5270400	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. A hora está em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
type	string: Cron	Uma cadeia de caracteres representa o tipo do plano. Tipos de planType adicionais podem ser adicionados ao longo do tempo.

DailyScheduleConfig

Objeto

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. Ele precisa estar em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
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. A hora está em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
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.

DataflowSchedule

Objeto

Agendamento de fluxo de dados.

Nome	Tipo	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	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, usando o formato YYYY-MM-DDTHH:mm:ssZ.
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.

DayOfWeek

Enumeração

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Enumeração

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.

Principal

Objeto

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

Enumeração

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

Objeto

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

Objeto

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

Objeto

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

Nome	Tipo	Description
userPrincipalName	string	Nome principal do usuário.

WeeklyScheduleConfig

Objeto

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. Ele precisa estar em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
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. A hora está em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
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.

Compartilhar via

Background Jobs - Schedule Execute

Escopos delegados necessários:

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create dataflow Execute schedule example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateDataflowExecuteScheduleRequest

CronScheduleConfig

DailyScheduleConfig

DataflowSchedule

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig