Job Scheduler - List Item Schedules
เรียกดูการตั้งค่าการจัดกําหนดการสําหรับสินค้าเฉพาะรายการหนึ่ง
API นี้สนับสนุน การแบ่งหน้า
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
สําหรับรายการ API ใช้ชนิดขอบเขตเหล่านี้:
- ขอบเขตทั่วไป: Item.ReadWrite.All หรือ Item.Read.All
- ขอบเขตเฉพาะ: itemTypeReadWrite.All หรือ itemTypeRead.All (ตัวอย่างเช่น: Notebook.ReadWrite.All)
สําหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต โปรดดูบทความขอบเขต
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
เอกลักษณ์ | สนับสนุน |
---|---|
ผู้ใช้ | ใช่ |
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | ไม่ใช่ |
อิน เทอร์ เฟซ
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules?continuationToken={continuationToken}
พารามิเตอร์ URI
ชื่อ | ใน | จำเป็น | พิมพ์ | คำอธิบาย |
---|---|---|---|---|
item
|
path | True |
string uuid |
รหัสสินค้า |
job
|
path | True |
string |
ชนิดงาน |
workspace
|
path | True |
string uuid |
ID พื้นที่ทํางาน |
continuation
|
query |
string |
โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์ |
การตอบสนอง
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
200 OK |
ดึงข้อมูลกําหนดการรายการทั้งหมดสําเร็จแล้ว |
|
Other Status Codes |
รหัสข้อผิดพลาดทั่วไป:
|
ตัวอย่าง
List item schedules example
คำขอตัวอย่าง
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/3546052c-ae64-4526-b1a8-52af7761426f/jobs/DefaultJob/schedules
คำตอบตัวอย่าง
{
"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"
}
}
]
}
คำจำกัดความ
ชื่อ | คำอธิบาย |
---|---|
Cron |
|
Daily |
|
Day |
รายการของวันในสัปดาห์ที่อนุญาตให้ใช้องค์ประกอบส่วนใหญ่เจ็ดองค์ประกอบ |
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
Error |
การตอบสนองข้อผิดพลาด |
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
Group |
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก |
Group |
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป |
Item |
กําหนดการรายการ |
Item |
รายการของกําหนดการสําหรับรายการนี้ |
Principal |
แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra |
Principal |
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป |
Service |
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก |
Service |
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก |
User |
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก |
Weekly |
CronScheduleConfig
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
endDateTime |
string date-time |
เวลาสิ้นสุดสําหรับกําหนดการนี้ เวลาสิ้นสุดต้องอยู่หลังเวลาเริ่มต้น |
interval |
integer int32 |
ช่วงเวลาเป็นนาที ตัวเลขระหว่าง 1 ถึง 5270400 (10 ปี) |
localTimeZoneId |
string |
รีจิสทรีตัวระบุโซนเวลาบนคอมพิวเตอร์เฉพาะที่สําหรับ Windows ดู โซนเวลาเริ่มต้น |
startDateTime |
string date-time |
เวลาเริ่มต้นสําหรับกําหนดการนี้ ถ้าเวลาเริ่มต้นคือในอดีตจะทริกเกอร์งานได้ทันที |
type |
string:
Cron |
สตริงแสดงชนิดของแผน ชนิด planType เพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป |
DailyScheduleConfig
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
endDateTime |
string date-time |
เวลาสิ้นสุดสําหรับกําหนดการนี้ เวลาสิ้นสุดต้องอยู่หลังเวลาเริ่มต้น |
localTimeZoneId |
string |
รีจิสทรีตัวระบุโซนเวลาบนคอมพิวเตอร์เฉพาะที่สําหรับ Windows ดู โซนเวลาเริ่มต้น |
startDateTime |
string date-time |
เวลาเริ่มต้นสําหรับกําหนดการนี้ ถ้าเวลาเริ่มต้นคือในอดีตจะทริกเกอร์งานได้ทันที |
times |
string[] |
รายการของช่องเวลาในรูปแบบ hh:mm ที่อนุญาตให้ใช้องค์ประกอบได้มากที่สุด 100 องค์ประกอบ |
type |
string:
Daily |
สตริงแสดงชนิดของแผน ชนิด planType เพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป |
DayOfWeek
รายการของวันในสัปดาห์ที่อนุญาตให้ใช้องค์ประกอบส่วนใหญ่เจ็ดองค์ประกอบ
ค่า | คำอธิบาย |
---|---|
Friday |
วันศุกร์ |
Monday |
วันจันทร์ |
Saturday |
วันเสาร์ |
Sunday |
วันอาทิตย์ |
Thursday |
วันพฤหัสบดี |
Tuesday |
วันอังคาร |
Wednesday |
วันพุธ |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
requestId |
string |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
GroupDetails
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
groupType |
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป |
GroupType
ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป
ค่า | คำอธิบาย |
---|---|
DistributionList |
หลักคือรายการการแจกจ่าย |
SecurityGroup |
หลักคือกลุ่มความปลอดภัย |
Unknown |
ไม่รู้จักชนิดกลุ่มหลัก |
ItemSchedule
กําหนดการรายการ
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
configuration | ScheduleConfig: |
ข้อมูลจริงประกอบด้วยเวลา/วันทํางานของกําหนดการนี้ |
createdDateTime |
string date-time |
ประทับเวลาที่สร้างขึ้นของตารางเวลานี้ใน Utc |
enabled |
boolean |
เปิดใช้งานกําหนดการนี้หรือไม่ True - เปิดใช้งาน เท็จ - ปิดใช้งาน |
id |
string uuid |
รหัสกําหนดการ |
owner |
ข้อมูลประจําตัวผู้ใช้ที่สร้างกําหนดการนี้หรือปรับเปลี่ยนครั้งล่าสุด |
ItemSchedules
รายการของกําหนดการสําหรับรายการนี้
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
continuationToken |
string |
โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง |
continuationUri |
string |
URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง |
value |
รายการของกําหนดการสําหรับรายการนี้ |
Principal
แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
displayName |
string |
ชื่อที่แสดงขององค์ประกอบหลัก |
groupDetails |
รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก |
|
id |
string uuid |
ID ของโครงร่างสําคัญ |
servicePrincipalDetails |
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก |
|
servicePrincipalProfileDetails |
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก |
|
type |
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป |
|
userDetails |
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก |
PrincipalType
ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
ค่า | คำอธิบาย |
---|---|
Group |
หลักคือกลุ่มความปลอดภัย |
ServicePrincipal |
หลักคือโครงร่างสําคัญของบริการ Microsoft Entra |
ServicePrincipalProfile |
หลักคือ โปรไฟล์โครงร่างสําคัญของบริการ |
User |
หลักคือผู้ใช้หลัก Microsoft Entra |
ServicePrincipalDetails
รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
aadAppId |
string uuid |
Microsoft Entra AppId ของบริการหลัก |
ServicePrincipalProfileDetails
รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
parentPrincipal |
โครงร่างสําคัญของโปรไฟล์บริการหลัก |
UserDetails
รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก User
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
userPrincipalName |
string |
ชื่อหลักของผู้ใช้ |
WeeklyScheduleConfig
ชื่อ | พิมพ์ | คำอธิบาย |
---|---|---|
endDateTime |
string date-time |
เวลาสิ้นสุดสําหรับกําหนดการนี้ เวลาสิ้นสุดต้องอยู่หลังเวลาเริ่มต้น |
localTimeZoneId |
string |
รีจิสทรีตัวระบุโซนเวลาบนคอมพิวเตอร์เฉพาะที่สําหรับ Windows ดู โซนเวลาเริ่มต้น |
startDateTime |
string date-time |
เวลาเริ่มต้นสําหรับกําหนดการนี้ ถ้าเวลาเริ่มต้นคือในอดีตจะทริกเกอร์งานได้ทันที |
times |
string[] |
รายการของช่องเวลาในรูปแบบ hh:mm ที่อนุญาตให้ใช้องค์ประกอบได้มากที่สุด 100 องค์ประกอบ |
type |
string:
Weekly |
สตริงแสดงชนิดของแผน ชนิด planType เพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป |
weekdays |
รายการของวันในสัปดาห์ที่อนุญาตให้ใช้องค์ประกอบส่วนใหญ่เจ็ดองค์ประกอบ |