Job Scheduler - Create Item Schedule

Referens

Tjänst:: Core

API-version:: v1

Skapa ett nytt schema för ett objekt. Ett objekt kan skapa högst 20 schemaläggare.

Obligatoriska delegerade omfång:

Item.Execute.All och Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Nej

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
itemId	path	True	string uuid	Objekt-ID:t.
jobType	path	True	string	Jobbtypen.
workspaceId	path	True	string uuid	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Faktiska data innehåller tid/veckodagar för det här schemat.
enabled	True	boolean	Om det här schemat är aktiverat. Sant – aktiverat, falskt – inaktiverat.

Svar

Name	Typ	Description
201 Created	ItemSchedule	Skapa schemat. Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Vanliga felkoder: InsufficientPrivileges – anroparen har inte tillräcklig behörighet för att komma åt objektet ItemNotFound – Det gick inte att hitta det begärda objekt-ID:t ScheduleExceedsLimit – Antalet skapade scheman för objektet överskrider gränsen

Name

Typ

Description

201 Created

ItemSchedule

Skapa schemat.

Sidhuvuden

Location: string

Other Status Codes

ErrorResponse

Vanliga felkoder:

InsufficientPrivileges – anroparen har inte tillräcklig behörighet för att komma åt objektet
ItemNotFound – Det gick inte att hitta det begärda objekt-ID:t
ScheduleExceedsLimit – Antalet skapade scheman för objektet överskrider gränsen

Exempel

create item schedule example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 201

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

Definitioner

Name	Description
CreateScheduleRequest	Skapa nyttolasten för artikelschemaplansbegäran.
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	En lista över vardagar, högst sju element tillåts.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
ItemSchedule	Objektschema.
Principal	Representerar en identitet eller en Microsoft Entra-grupp.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.
WeeklyScheduleConfig

CreateScheduleRequest

Objekt

Skapa nyttolasten för artikelschemaplansbegäran.

Name	Typ	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Faktiska data innehåller tid/veckodagar för det här schemat.
enabled	boolean	Om det här schemat är aktiverat. Sant – aktiverat, falskt – inaktiverat.

CronScheduleConfig

Objekt

Name	Typ	Description
endDateTime	string date-time	Sluttiden för det här schemat. Sluttiden måste vara senare än starttiden.
interval	integer int32	Tidsintervallet i minuter. Ett tal mellan 1 och 5270400 (10 år).
localTimeZoneId	string	Tidszonsidentifierarregistret på den lokala datorn för windows finns i Standardtidszoner
startDateTime	string date-time	Starttiden för det här schemat. Om starttiden är tidigare utlöses ett jobb direkt.
type	string: Cron	En sträng representerar typen av plan. Ytterligare planType-typer kan läggas till över tid.

DailyScheduleConfig

Objekt

Name	Typ	Description
endDateTime	string date-time	Sluttiden för det här schemat. Sluttiden måste vara senare än starttiden.
localTimeZoneId	string	Tidszonsidentifierarregistret på den lokala datorn för windows finns i Standardtidszoner
startDateTime	string date-time	Starttiden för det här schemat. Om starttiden är tidigare utlöses ett jobb direkt.
times	string[]	En lista över tidsfack i hh:mm-format, högst 100 element tillåts.
type	string: Daily	En sträng representerar typen av plan. Ytterligare planType-typer kan läggas till över tid.

DayOfWeek

Uppräkning

En lista över vardagar, högst sju element tillåts.

Värde	Description
Friday	Fredag
Monday	Måndag
Saturday	Lördag
Sunday	Söndag
Thursday	Torsdag
Tuesday	Tisdag
Wednesday	Onsdag

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
DistributionList	Huvudnamn är en distributionslista.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
Unknown	Huvudgrupptypen är okänd.

ItemSchedule

Objekt

Objektschema.

Name	Typ	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Faktiska data innehåller tid/veckodagar för det här schemat.
createdDateTime	string date-time	Den skapade tidsstämpeln för det här schemat i Utc.
enabled	boolean	Om det här schemat är aktiverat. Sant – aktiverat, falskt – inaktiverat.
id	string uuid	Schema-ID:t.
owner	Principal	Användaridentiteten som skapade det här schemat eller som senast ändrades.

Principal

Objekt

Representerar en identitet eller en Microsoft Entra-grupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string uuid	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipal	Principal är microsoft entra-tjänstens huvudnamn.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
User	Principal är ett Microsoft Entra-användarhuvudnamn.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string uuid	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

WeeklyScheduleConfig

Objekt

Name	Typ	Description
endDateTime	string date-time	Sluttiden för det här schemat. Sluttiden måste vara senare än starttiden.
localTimeZoneId	string	Tidszonsidentifierarregistret på den lokala datorn för windows finns i Standardtidszoner
startDateTime	string date-time	Starttiden för det här schemat. Om starttiden är tidigare utlöses ett jobb direkt.
times	string[]	En lista över tidsfack i hh:mm-format, högst 100 element tillåts.
type	string: Weekly	En sträng representerar typen av plan. Ytterligare planType-typer kan läggas till över tid.
weekdays	DayOfWeek[]	En lista över vardagar, högst sju element tillåts.

Dela via

Job Scheduler - Create Item Schedule

Obligatoriska delegerade omfång:

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

create item schedule example

Exempelbegäran

Exempelsvar

Definitioner

CreateScheduleRequest

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig

Ytterligare resurser