Job Scheduler - List Item Schedules

Referentie

Service:: Core

API-versie:: v1

Planningsinstellingen voor één specifiek item ophalen.
Deze API ondersteunt paginering.

Vereiste gedelegeerde bereiken

Voor item-API's worden deze bereiktypen gebruikt:

Algemeen bereik: Item.ReadWrite.All of Item.Read.All
Specifiek bereik: itemType. ReadWrite.All of itemType. Read.All (bijvoorbeeld: Notebook.ReadWrite.All)

Zie het artikel bereikenvoor meer informatie over bereiken.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Nee

Interface

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

Met optionele parameters:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules?continuationToken={continuationToken}

URI-parameters

Name	In	Vereist	Type	Description
itemId	path	True	string uuid	De item-id.
jobType	path	True	string	Het taaktype.
workspaceId	path	True	string uuid	De werkruimte-id.
continuationToken	query		string	Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name	Type	Description
200 OK	ItemSchedules	Alle itemschema's zijn opgehaald.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: InsufficientPrivileges - De beller beschikt niet over voldoende machtigingen voor toegang tot het item ItemNotFound - Aangevraagde item-id is niet gevonden

Name

Type

Description

200 OK

ItemSchedules

Alle itemschema's zijn opgehaald.

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

InsufficientPrivileges - De beller beschikt niet over voldoende machtigingen voor toegang tot het item
ItemNotFound - Aangevraagde item-id is niet gevonden

Voorbeelden

List item schedules example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/3546052c-ae64-4526-b1a8-52af7761426f/jobs/DefaultJob/schedules

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "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"
      }
    },
    {
      "id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
      "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": "Weekly",
        "weekdays": [
          "Monday",
          "Tuesday"
        ],
        "times": [
          "18:09",
          "17:12"
        ]
      },
      "owner": {
        "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
        "type": "User"
      }
    },
    {
      "id": "c0ed1d27-32dc-49e6-90ba-cac9b6248c7f",
      "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": "Daily",
        "times": [
          "18:09",
          "17:12"
        ]
      },
      "owner": {
        "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
        "type": "User"
      }
    }
  ]
}

Definities

Name	Description
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	Een lijst met weekdagen, maximaal zeven elementen zijn toegestaan.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.
ItemSchedule	Itemplanning.
ItemSchedules	lijst met planningen voor dit item.
Principal	Vertegenwoordigt een identiteit of een Microsoft Entra-groep.
PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.
WeeklyScheduleConfig

CronScheduleConfig

Object

Name	Type	Description
endDateTime	string date-time	De eindtijd voor dit schema. De eindtijd moet later zijn dan de begintijd.
interval	integer int32	Het tijdsinterval in minuten. Een getal tussen 1 en 5270400 (10 jaar).
localTimeZoneId	string	Zie het register voor tijdzone-id's op de lokale computer voor Windows standaardtijdzones
startDateTime	string date-time	De begintijd voor deze planning. Als de begintijd zich in het verleden bevindt, wordt er direct een taak geactiveerd.
type	string: Cron	Een tekenreeks vertegenwoordigt het type van het plan. Er kunnen in de loop van de tijd extra typen planType worden toegevoegd.

DailyScheduleConfig

Object

Name	Type	Description
endDateTime	string date-time	De eindtijd voor dit schema. De eindtijd moet later zijn dan de begintijd.
localTimeZoneId	string	Zie het register voor tijdzone-id's op de lokale computer voor Windows standaardtijdzones
startDateTime	string date-time	De begintijd voor deze planning. Als de begintijd zich in het verleden bevindt, wordt er direct een taak geactiveerd.
times	string[]	Een lijst met tijdsleuven in uu:mm-indeling, maximaal 100 elementen zijn toegestaan.
type	string: Daily	Een tekenreeks vertegenwoordigt het type van het plan. Er kunnen in de loop van de tijd extra typen planType worden toegevoegd.

DayOfWeek

Inventarisatie

Een lijst met weekdagen, maximaal zeven elementen zijn toegestaan.

Waarde	Description
Friday	Vrijdag
Monday	Maandag
Saturday	Zaterdag
Sunday	Zondag
Thursday	Donderdag
Tuesday	Dinsdag
Wednesday	Woensdag

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GroupDetails

Object

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name	Type	Description
groupType	GroupType	Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupType

Inventarisatie

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde	Description
DistributionList	Principal is een distributielijst.
SecurityGroup	Principal is een beveiligingsgroep.
Unknown	Het type Principal-groep is onbekend.

ItemSchedule

Object

Itemplanning.

Name	Type	Description
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	De werkelijke gegevens bevatten de tijd/weekdagen van dit schema.
createdDateTime	string date-time	Het gemaakte tijdstempel van deze planning in Utc.
enabled	boolean	Of deze planning is ingeschakeld. True - Ingeschakeld, Onwaar - Uitgeschakeld.
id	string uuid	De plannings-id.
owner	Principal	De gebruikersidentiteit die dit schema heeft gemaakt of voor het laatst is gewijzigd.

ItemSchedules

Object

lijst met planningen voor dit item.

Name	Type	Description
continuationToken	string	Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri	string	De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value	ItemSchedule[]	lijst met planningen voor dit item.

Principal

Object

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.

Name	Type	Description
displayName	string	De weergavenaam van de principal.
groupDetails	GroupDetails	Groepsspecifieke details. Van toepassing wanneer het principal-type is `Group`.
id	string uuid	De id van de principal.
servicePrincipalDetails	ServicePrincipalDetails	Specifieke details van de service-principal. Van toepassing wanneer het principal-type is `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Details van service-principalprofiel. Van toepassing wanneer het principal-type is `ServicePrincipalProfile`.
type	PrincipalType	Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.
userDetails	UserDetails	Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is `User`.

PrincipalType

Inventarisatie

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde	Description
Group	Principal is een beveiligingsgroep.
ServicePrincipal	Principal is een Microsoft Entra-service-principal.
ServicePrincipalProfile	Principal is een service-principalprofiel.
User	Principal is een Microsoft Entra-gebruikersprincipaal.

ServicePrincipalDetails

Object

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name	Type	Description
aadAppId	string uuid	De Microsoft Entra AppId van de service-principal.

ServicePrincipalProfileDetails

Object

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	De bovenliggende principal van het service-principalprofiel.

UserDetails

Object

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name	Type	Description
userPrincipalName	string	De principal-naam van de gebruiker.

WeeklyScheduleConfig

Object

Name	Type	Description
endDateTime	string date-time	De eindtijd voor dit schema. De eindtijd moet later zijn dan de begintijd.
localTimeZoneId	string	Zie het register voor tijdzone-id's op de lokale computer voor Windows standaardtijdzones
startDateTime	string date-time	De begintijd voor deze planning. Als de begintijd zich in het verleden bevindt, wordt er direct een taak geactiveerd.
times	string[]	Een lijst met tijdsleuven in uu:mm-indeling, maximaal 100 elementen zijn toegestaan.
type	string: Weekly	Een tekenreeks vertegenwoordigt het type van het plan. Er kunnen in de loop van de tijd extra typen planType worden toegevoegd.
weekdays	DayOfWeek[]	Een lijst met weekdagen, maximaal zeven elementen zijn toegestaan.

Delen via

Job Scheduler - List Item Schedules

Vereiste gedelegeerde bereiken

Door Microsoft Entra ondersteunde identiteiten

Interface

URI-parameters

Antwoorden

Voorbeelden

List item schedules example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

ItemSchedules

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig

Aanvullende resources