Job Scheduler - List Item Schedules

Odwołanie

Usługa:: Core

Wersja interfejsu API:: v1

Pobierz ustawienia planowania dla jednego określonego elementu.
Ten interfejs API obsługuje stronicowanie.

Wymagane zakresy delegowane

W przypadku interfejsów API elementów użyj następujących typów zakresów:

Zakres ogólny: Item.ReadWrite.All lub Item.Read.All
Określony zakres: itemType. ReadWrite.All lub itemType. Read.All (na przykład: Notebook.ReadWrite.All)

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł zakresy.

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Nie

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
itemId	path	True	string uuid	Identyfikator elementu.
jobType	path	True	string	Typ zadania.
workspaceId	path	True	string uuid	Identyfikator obszaru roboczego.
continuationToken	query		string	Token do pobierania następnej strony wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ItemSchedules	Pomyślnie pobrano wszystkie harmonogramy elementów.
Other Status Codes	ErrorResponse	Typowe kody błędów: InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień dostępu do elementu ItemNotFound — nie znaleziono żądanego identyfikatora elementu

Nazwa

Typ

Opis

200 OK

ItemSchedules

Pomyślnie pobrano wszystkie harmonogramy elementów.

Other Status Codes

ErrorResponse

Typowe kody błędów:

InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień dostępu do elementu
ItemNotFound — nie znaleziono żądanego identyfikatora elementu

Przykłady

List item schedules example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	Lista dni roboczych, w większości siedmiu elementów jest dozwolonych.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
ItemSchedule	Harmonogram elementów.
ItemSchedules	lista harmonogramów dla tego elementu.
Principal	Reprezentuje tożsamość lub grupę firmy Microsoft Entra.
PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.
WeeklyScheduleConfig

CronScheduleConfig

Objekt

Nazwa	Typ	Opis
endDateTime	string date-time	Godzina zakończenia tego harmonogramu. Godzina zakończenia musi być późniejsza niż godzina rozpoczęcia.
interval	integer int32	Interwał czasu w minutach. Liczba z zakresu od 1 do 5270400 (10 lat).
localTimeZoneId	string	Rejestr identyfikatorów strefy czasowej na komputerze lokalnym dla systemu Windows, zobacz domyślne strefy czasowe
startDateTime	string date-time	Godzina rozpoczęcia dla tego harmonogramu. Jeśli czas rozpoczęcia jest w przeszłości, spowoduje to natychmiastowe wyzwolenie zadania.
type	string: Cron	Ciąg reprezentuje typ planu. Dodatkowe typy planType można dodawać w czasie.

DailyScheduleConfig

Objekt

Nazwa	Typ	Opis
endDateTime	string date-time	Godzina zakończenia tego harmonogramu. Godzina zakończenia musi być późniejsza niż godzina rozpoczęcia.
localTimeZoneId	string	Rejestr identyfikatorów strefy czasowej na komputerze lokalnym dla systemu Windows, zobacz domyślne strefy czasowe
startDateTime	string date-time	Godzina rozpoczęcia dla tego harmonogramu. Jeśli czas rozpoczęcia jest w przeszłości, spowoduje to natychmiastowe wyzwolenie zadania.
times	string[]	Lista przedziałów czasu w formacie hh:mm, w większości 100 elementów jest dozwolonych.
type	string: Daily	Ciąg reprezentuje typ planu. Dodatkowe typy planType można dodawać w czasie.

DayOfWeek

Wyliczanie

Lista dni roboczych, w większości siedmiu elementów jest dozwolonych.

Wartość	Opis
Friday	Piątek
Monday	Poniedziałek
Saturday	Sobota
Sunday	Niedziela
Thursday	Czwartek
Tuesday	Wtorek
Wednesday	Środa

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwa	Typ	Opis
groupType	GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupType

Wyliczanie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość	Opis
DistributionList	Podmiot zabezpieczeń jest listą dystrybucyjną.
SecurityGroup	Podmiot zabezpieczeń jest grupą zabezpieczeń.
Unknown	Typ grupy podmiotu zabezpieczeń jest nieznany.

ItemSchedule

Objekt

Harmonogram elementów.

Nazwa	Typ	Opis
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Rzeczywiste dane zawierają czas/dni robocze tego harmonogramu.
createdDateTime	string date-time	Utworzona sygnatura czasowa tego harmonogramu w formacie Utc.
enabled	boolean	Czy ten harmonogram jest włączony. True — włączone, Fałsz — wyłączone.
id	string uuid	Identyfikator harmonogramu.
owner	Principal	Tożsamość użytkownika, która utworzyła ten harmonogram lub ostatnia modyfikacja.

ItemSchedules

Objekt

lista harmonogramów dla tego elementu.

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	ItemSchedule[]	lista harmonogramów dla tego elementu.

Principal

Objekt

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails	GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
id	string uuid	Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails	ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
type	PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails	UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość	Opis
Group	Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipal	Jednostka jest jednostką usługi Microsoft Entra.
ServicePrincipalProfile	Jednostka jest profilem jednostki usługi.
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwa	Typ	Opis
aadAppId	string uuid	Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwa	Typ	Opis
parentPrincipal	Principal	Jednostka nadrzędna profilu jednostki usługi.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwa	Typ	Opis
userPrincipalName	string	Główna nazwa użytkownika.

WeeklyScheduleConfig

Objekt

Nazwa	Typ	Opis
endDateTime	string date-time	Godzina zakończenia tego harmonogramu. Godzina zakończenia musi być późniejsza niż godzina rozpoczęcia.
localTimeZoneId	string	Rejestr identyfikatorów strefy czasowej na komputerze lokalnym dla systemu Windows, zobacz domyślne strefy czasowe
startDateTime	string date-time	Godzina rozpoczęcia dla tego harmonogramu. Jeśli czas rozpoczęcia jest w przeszłości, spowoduje to natychmiastowe wyzwolenie zadania.
times	string[]	Lista przedziałów czasu w formacie hh:mm, w większości 100 elementów jest dozwolonych.
type	string: Weekly	Ciąg reprezentuje typ planu. Dodatkowe typy planType można dodawać w czasie.
weekdays	DayOfWeek[]	Lista dni roboczych, w większości siedmiu elementów jest dozwolonych.

Udostępnij za pośrednictwem

Job Scheduler - List Item Schedules

Wymagane zakresy delegowane

Tożsamości obsługiwane przez firmę Microsoft

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List item schedules example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

ItemSchedules

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig

Dodatkowe zasoby