Background Jobs - Schedule Execute

Referensi

Layanan:: Dataflow

Versi API:: v1

Nota

API ini sedang dalam pratinjau.

Buat jadwal eksekusi baru untuk aliran data. Aliran data dapat membuat maksimum 20 penjadwal.

Cakupan yang Didelegasikan yang Diperlukan:

Dataflow.Execute.All dan Dataflow.ReadWrite.All

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukungan
Pengguna	Ya
Prinsipal Layanan dan Identitas Terkelola	Tidak.

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
dataflowId	path	True	string (uuid)	ID item.
workspaceId	path	True	string (uuid)	ID ruangkerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Data aktual berisi waktu/hari kerja dari jadwal ini.
enabled	True	boolean	Apakah jadwal ini diaktifkan. True - Diaktifkan, False - Dinonaktifkan.

Respons

Nama	Jenis	Deskripsi
201 Created	DataflowSchedule	Berhasil membuat jadwal. Header Location: string
Other Status Codes	ErrorResponse	Kode kesalahan umum: InsufficientPrivileges - Pemanggil tidak memiliki izin yang memadai untuk mengakses item ItemNotFound - Id item yang diminta tidak ditemukan ScheduleExceedsLimit - Jumlah jadwal yang dibuat untuk item melebihi batas

Nama

Jenis

Deskripsi

201 Created

DataflowSchedule

Berhasil membuat jadwal.

Header

Location: string

Other Status Codes

ErrorResponse

Kode kesalahan umum:

InsufficientPrivileges - Pemanggil tidak memiliki izin yang memadai untuk mengakses item
ItemNotFound - Id item yang diminta tidak ditemukan
ScheduleExceedsLimit - Jumlah jadwal yang dibuat untuk item melebihi batas

Contoh

Create dataflow Execute schedule example

Permintaan sampel

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

Respon sampel

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

Definisi

Nama	Deskripsi
CreateDataflowExecuteScheduleRequest	Membuat payload permintaan rencana jadwal eksekusi aliran data.
CronScheduleConfig
DailyScheduleConfig
DataflowSchedule	Jadwal aliran data.
DayOfWeek	Daftar hari kerja, paling banyak tujuh elemen diizinkan.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.
Principal	Mewakili identitas atau grup Microsoft Entra.
PrincipalType	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.
WeeklyScheduleConfig

CreateDataflowExecuteScheduleRequest

Objek

Membuat payload permintaan rencana jadwal eksekusi aliran data.

Nama	Jenis	Deskripsi
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Data aktual berisi waktu/hari kerja dari jadwal ini.
enabled	boolean	Apakah jadwal ini diaktifkan. True - Diaktifkan, False - Dinonaktifkan.

CronScheduleConfig

Objek

Nama	Jenis	Deskripsi
endDateTime	string (date-time)	Waktu akhir untuk jadwal ini. Waktu akhir harus lebih lambat dari waktu mulai. Ini harus dalam format UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
interval	integer (int32) minimum: 1 maximum: 5270400	Interval waktu dalam menit. Angka antara 1 dan 5270400 (10 tahun).
localTimeZoneId	string	Registri pengidentifikasi zona waktu di komputer lokal untuk windows, lihat Zona Waktu Default
startDateTime	string (date-time)	Waktu mulai untuk jadwal ini. Jika waktu mulai berada di masa lalu, itu akan memicu pekerjaan secara instan. Waktunya dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
type	string: Cron	String mewakili jenis paket. Jenis planType tambahan dapat ditambahkan dari waktu ke waktu.

DailyScheduleConfig

Objek

Nama	Jenis	Deskripsi
endDateTime	string (date-time)	Waktu akhir untuk jadwal ini. Waktu akhir harus lebih lambat dari waktu mulai. Ini harus dalam format UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
localTimeZoneId	string	Registri pengidentifikasi zona waktu di komputer lokal untuk windows, lihat Zona Waktu Default
startDateTime	string (date-time)	Waktu mulai untuk jadwal ini. Jika waktu mulai berada di masa lalu, itu akan memicu pekerjaan secara instan. Waktunya dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
times	string[]	Daftar slot waktu dalam format hh:mm, paling banyak 100 elemen diizinkan.
type	string: Daily	String mewakili jenis paket. Jenis planType tambahan dapat ditambahkan dari waktu ke waktu.

DataflowSchedule

Objek

Jadwal aliran data.

Nama	Jenis	Deskripsi
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	Data aktual berisi waktu/hari kerja dari jadwal ini.
createdDateTime	string (date-time)	Stempel waktu yang dibuat dari jadwal ini dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
enabled	boolean	Apakah jadwal ini diaktifkan. True - Diaktifkan, False - Dinonaktifkan.
id	string (uuid)	ID jadwal.
owner	Principal	Identitas pengguna yang membuat jadwal ini atau terakhir diubah.

DayOfWeek

Enumeration

Daftar hari kerja, paling banyak tujuh elemen diizinkan.

Nilai	Deskripsi
Friday	Jumat
Monday	Senin
Saturday	Sabtu
Sunday	Hari Minggu
Thursday	Kamis
Tuesday	Selasa
Wednesday	Rabu

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

GroupDetails

Objek

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.

Nama	Jenis	Deskripsi
groupType	GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

GroupType

Enumeration

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
DistributionList	Prinsipal adalah daftar distribusi.
SecurityGroup	Prinsipal adalah kelompok keamanan.
Unknown	Jenis grup utama tidak diketahui.

Principal

Objek

Mewakili identitas atau grup Microsoft Entra.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
groupDetails	GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
id	string (uuid)	Id utama.
servicePrincipalDetails	ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
type	PrincipalType	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
userDetails	UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.

PrincipalType

Enumeration

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Group	Prinsipal adalah kelompok keamanan.
ServicePrincipal	Prinsipal adalah perwakilan layanan Microsoft Entra.
ServicePrincipalProfile	Perwakilan adalah profil perwakilan layanan.
User	Prinsipal adalah prinsipal pengguna Microsoft Entra.

ServicePrincipalDetails

Objek

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.

Nama	Jenis	Deskripsi
aadAppId	string (uuid)	Microsoft Entra AppId perwakilan layanan.

ServicePrincipalProfileDetails

Objek

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.

Nama	Jenis	Deskripsi
parentPrincipal	Principal	Perwakilan induk profil perwakilan layanan.

UserDetails

Objek

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.

Nama	Jenis	Deskripsi
userPrincipalName	string	Nama prinsipal pengguna.

WeeklyScheduleConfig

Objek

Nama	Jenis	Deskripsi
endDateTime	string (date-time)	Waktu akhir untuk jadwal ini. Waktu akhir harus lebih lambat dari waktu mulai. Ini harus dalam format UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
localTimeZoneId	string	Registri pengidentifikasi zona waktu di komputer lokal untuk windows, lihat Zona Waktu Default
startDateTime	string (date-time)	Waktu mulai untuk jadwal ini. Jika waktu mulai berada di masa lalu, itu akan memicu pekerjaan secara instan. Waktunya dalam UTC, menggunakan format YYYY-MM-DDTHH:mm:ssZ.
times	string[]	Daftar slot waktu dalam format hh:mm, paling banyak 100 elemen diizinkan.
type	string: Weekly	String mewakili jenis paket. Jenis planType tambahan dapat ditambahkan dari waktu ke waktu.
weekdays	DayOfWeek[]	Daftar hari kerja, paling banyak tujuh elemen diizinkan.

Bagikan melalui

Background Jobs - Schedule Execute

Cakupan yang Didelegasikan yang Diperlukan:

Identitas yang didukung oleh Microsoft Entra

Antarmuka

Parameter URI

Isi Permintaan

Respons

Contoh

Create dataflow Execute schedule example

Permintaan sampel

Respon sampel

Definisi

CreateDataflowExecuteScheduleRequest

CronScheduleConfig

DailyScheduleConfig

DataflowSchedule

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig