Background Jobs - Schedule Execute

Viite

Palvelu:: Dataflow

Ohjelmointirajapinnan versio:: v1

Huomautus

Tämä ohjelmointirajapinta on ennakkoversio.

Luo uusi suoritusaikataulu tietovuota varten. Tietovuo voi luoda enintään 20 ajoitusta.

Vaaditut delegoidut vaikutusalueet:

Dataflow.Execute.All ja Dataflow.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Ei

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
dataflowId	path	True	string (uuid)	Kohdetunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Todelliset tiedot sisältävät tämän aikataulun kellonajan tai viikonpäivät.
enabled	True	boolean	Määrittää, onko tämä aikataulu käytössä. True – Käytössä, False – Ei käytössä.

Vastaukset

Nimi	Tyyppi	Description
201 Created	DataflowSchedule	Aikataulun luominen onnistui. Otsikot Location: string
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InsufficientPrivileges – soittajalla ei ole riittäviä käyttöoikeuksia kohteen käyttämiseen ItemNotFound – Pyydetty kohdetunnusta ei löytynyt ScheduleExceedsLimit – kohteen luotujen aikataulujen määrä ylittää rajoituksen

Nimi

Tyyppi

Description

201 Created

DataflowSchedule

Aikataulun luominen onnistui.

Otsikot

Location: string

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InsufficientPrivileges – soittajalla ei ole riittäviä käyttöoikeuksia kohteen käyttämiseen
ItemNotFound – Pyydetty kohdetunnusta ei löytynyt
ScheduleExceedsLimit – kohteen luotujen aikataulujen määrä ylittää rajoituksen

Esimerkit

Create dataflow Execute schedule example

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi	Description
CreateDataflowExecuteScheduleRequest	Luo tietovuon suoritusaikataulun suunnitelmapyynnön hyötykuorma.
CronScheduleConfig
DailyScheduleConfig
DataflowSchedule	Tietovuon ajoitus.
DayOfWeek	Viikonpäivien luettelo, enintään seitsemän elementtiä sallitaan.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
Principal	Edustaa käyttäjätietoja tai Microsoft Entra -ryhmää.
PrincipalType	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.
WeeklyScheduleConfig

CreateDataflowExecuteScheduleRequest

Object

Luo tietovuon suoritusaikataulun suunnitelmapyynnön hyötykuorma.

Nimi	Tyyppi	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Todelliset tiedot sisältävät tämän aikataulun kellonajan tai viikonpäivät.
enabled	boolean	Määrittää, onko tämä aikataulu käytössä. True – Käytössä, False – Ei käytössä.

CronScheduleConfig

Object

Nimi	Tyyppi	Description
endDateTime	string (date-time)	Tämän aikataulun päättymisaika. Päättymisajan on oltava alkamisaikaa uudempi. Sen on oltava UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
interval	integer (int32) minimum: 1 maximum: 5270400	Aikaväli minuutteina. Luku 1–5270400 (10 vuotta).
localTimeZoneId	string	Windowsin paikallisen tietokoneen aikavyöhykkeen tunnisterekisteri, katso Oletusaikavyöhykkeet-
startDateTime	string (date-time)	Tämän aikataulun alkamisaika. Jos alkamisaika on ohi, se käynnistää työn välittömästi. Aika on UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
type	string: Cron	Merkkijono edustaa suunnitelman tyyppiä. Muita planType-tyyppejä voidaan lisätä ajan kuluessa.

DailyScheduleConfig

Object

Nimi	Tyyppi	Description
endDateTime	string (date-time)	Tämän aikataulun päättymisaika. Päättymisajan on oltava alkamisaikaa uudempi. Sen on oltava UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
localTimeZoneId	string	Windowsin paikallisen tietokoneen aikavyöhykkeen tunnisterekisteri, katso Oletusaikavyöhykkeet-
startDateTime	string (date-time)	Tämän aikataulun alkamisaika. Jos alkamisaika on ohi, se käynnistää työn välittömästi. Aika on UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
times	string[]	Ajanjakson luettelo hh:mm-muodossa, enintään 100 elementtiä sallitaan.
type	string: Daily	Merkkijono edustaa suunnitelman tyyppiä. Muita planType-tyyppejä voidaan lisätä ajan kuluessa.

DataflowSchedule

Object

Tietovuon ajoitus.

Nimi	Tyyppi	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Todelliset tiedot sisältävät tämän aikataulun kellonajan tai viikonpäivät.
createdDateTime	string (date-time)	Tämän aikataulun luotu aikaleima UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
enabled	boolean	Määrittää, onko tämä aikataulu käytössä. True – Käytössä, False – Ei käytössä.
id	string (uuid)	Aikataulun tunnus.
owner	Principal	Käyttäjätiedot, jotka loivat tämän aikataulun tai joita on viimeksi muokattu.

DayOfWeek

Luettelointi

Viikonpäivien luettelo, enintään seitsemän elementtiä sallitaan.

Arvo	Description
Friday	Perjantai
Monday	Maanantai
Saturday	lauantai
Sunday	sunnuntai
Thursday	Torstai
Tuesday	Tiistai
Wednesday	Keskiviikko

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GroupDetails

Object

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi	Tyyppi	Description
groupType	GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo	Description
DistributionList	Principal on jakeluluettelo.
SecurityGroup	Principal on käyttöoikeusryhmä.
Unknown	Pääryhmän tyyppi on tuntematon.

Principal

Object

Edustaa käyttäjätietoja tai Microsoft Entra -ryhmää.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
groupDetails	GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
id	string (uuid)	Päänimen tunnus.
servicePrincipalDetails	ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
type	PrincipalType	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails	UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Group	Principal on käyttöoikeusryhmä.
ServicePrincipal	Principal on Microsoft Entra -palvelun päänimi.
ServicePrincipalProfile	Principal on palvelun pääprofiili.
User	Principal on Microsoft Entra -käyttäjäobjekti.

ServicePrincipalDetails

Object

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi	Tyyppi	Description
aadAppId	string (uuid)	Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalProfileDetails

Object

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi	Tyyppi	Description
parentPrincipal	Principal	Palvelun pääprofiilin pääobjekti.

UserDetails

Object

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi	Tyyppi	Description
userPrincipalName	string	Täydellinen käyttäjänimi.

WeeklyScheduleConfig

Object

Nimi	Tyyppi	Description
endDateTime	string (date-time)	Tämän aikataulun päättymisaika. Päättymisajan on oltava alkamisaikaa uudempi. Sen on oltava UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
localTimeZoneId	string	Windowsin paikallisen tietokoneen aikavyöhykkeen tunnisterekisteri, katso Oletusaikavyöhykkeet-
startDateTime	string (date-time)	Tämän aikataulun alkamisaika. Jos alkamisaika on ohi, se käynnistää työn välittömästi. Aika on UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
times	string[]	Ajanjakson luettelo hh:mm-muodossa, enintään 100 elementtiä sallitaan.
type	string: Weekly	Merkkijono edustaa suunnitelman tyyppiä. Muita planType-tyyppejä voidaan lisätä ajan kuluessa.
weekdays	DayOfWeek[]	Viikonpäivien luettelo, enintään seitsemän elementtiä sallitaan.

Jaa

Background Jobs - Schedule Execute

Vaaditut delegoidut vaikutusalueet:

Microsoft Entran tukemat käyttäjätiedot

Rajapinta

URI-parametrit

Pyynnön leipäteksti

Vastaukset

Esimerkit

Create dataflow Execute schedule example

Mallipyyntö

Mallivastaus

Määritelmät

CreateDataflowExecuteScheduleRequest

CronScheduleConfig

DailyScheduleConfig

DataflowSchedule

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig