Job Scheduler - Create Item Schedule

การอ้างอิง

บริการ:: Core

เวอร์ชัน API:: v1

สร้างกําหนดการใหม่สําหรับรายการ รายการสามารถสร้างพนักงานจัดกําหนดการได้สูงสุด 20 คน

ขอบเขตที่ได้รับมอบสิทธิ์ที่จําเป็น:

Item.Execute.All และ Item.ReadWrite.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์	สนับสนุน
ผู้ใช้	ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	ไม่ใช่

อิน เทอร์ เฟซ

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

พารามิเตอร์ URI

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
itemId	path	True	string uuid	รหัสสินค้า
jobType	path	True	string	ชนิดงาน
workspaceId	path	True	string uuid	ID พื้นที่ทํางาน

เนื้อความของคำขอ

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	ข้อมูลจริงประกอบด้วยเวลา/วันทํางานของกําหนดการนี้
enabled	True	boolean	เปิดใช้งานกําหนดการนี้หรือไม่ True - เปิดใช้งาน เท็จ - ปิดใช้งาน

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
201 Created	ItemSchedule	สร้างกําหนดการเรียบร้อยแล้ว ส่วนหัว Location: string
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: ไม่เพียงพอ Privileges - ผู้เรียกมีสิทธิ์เพียงพอที่จะเข้าถึงรายการ ItemNotFound - ไม่พบ ID รายการที่ร้องขอ ScheduleExceedsLimit - จํานวนกําหนดการที่สร้างขึ้นสําหรับสินค้าเกินขีดจํากัด

ชื่อ

พิมพ์

คำอธิบาย

201 Created

ItemSchedule

สร้างกําหนดการเรียบร้อยแล้ว

ส่วนหัว

Location: string

Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

ไม่เพียงพอ Privileges - ผู้เรียกมีสิทธิ์เพียงพอที่จะเข้าถึงรายการ
ItemNotFound - ไม่พบ ID รายการที่ร้องขอ
ScheduleExceedsLimit - จํานวนกําหนดการที่สร้างขึ้นสําหรับสินค้าเกินขีดจํากัด

ตัวอย่าง

create item schedule example

คำขอตัวอย่าง

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

คำตอบตัวอย่าง

รหัสสถานะ:: 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"
  }
}

คำจำกัดความ

ชื่อ	คำอธิบาย
CreateScheduleRequest	สร้างเพย์โหลดคําขอกําหนดตารางเวลารายการ
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	รายการของวันในสัปดาห์ที่อนุญาตให้ใช้องค์ประกอบส่วนใหญ่เจ็ดองค์ประกอบ
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
GroupDetails	รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก `Group`
GroupType	ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป
ItemSchedule	กําหนดการรายการ
Principal	แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra
PrincipalType	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
ServicePrincipalDetails	รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก `ServicePrincipal`
ServicePrincipalProfileDetails	รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก `ServicePrincipalProfile`
UserDetails	รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก `User`
WeeklyScheduleConfig

CreateScheduleRequest

ออบเจ็กต์

สร้างเพย์โหลดคําขอกําหนดตารางเวลารายการ

ชื่อ	พิมพ์	คำอธิบาย
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	ข้อมูลจริงประกอบด้วยเวลา/วันทํางานของกําหนดการนี้
enabled	boolean	เปิดใช้งานกําหนดการนี้หรือไม่ True - เปิดใช้งาน เท็จ - ปิดใช้งาน

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	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

GroupDetails

ออบเจ็กต์

รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก Group

ชื่อ	พิมพ์	คำอธิบาย
groupType	GroupType	ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

GroupType

การแจงนับ

ชนิดของกลุ่ม คุณสามารถเพิ่มชนิดกลุ่มเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
DistributionList	หลักคือรายการการแจกจ่าย
SecurityGroup	หลักคือกลุ่มความปลอดภัย
Unknown	ไม่รู้จักชนิดกลุ่มหลัก

ItemSchedule

ออบเจ็กต์

กําหนดการรายการ

ชื่อ	พิมพ์	คำอธิบาย
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	ข้อมูลจริงประกอบด้วยเวลา/วันทํางานของกําหนดการนี้
createdDateTime	string date-time	ประทับเวลาที่สร้างขึ้นของตารางเวลานี้ใน Utc
enabled	boolean	เปิดใช้งานกําหนดการนี้หรือไม่ True - เปิดใช้งาน เท็จ - ปิดใช้งาน
id	string uuid	รหัสกําหนดการ
owner	Principal	ข้อมูลประจําตัวผู้ใช้ที่สร้างกําหนดการนี้หรือปรับเปลี่ยนครั้งล่าสุด

Principal

ออบเจ็กต์

แสดงข้อมูลประจําตัวหรือกลุ่ม Microsoft Entra

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงขององค์ประกอบหลัก
groupDetails	GroupDetails	รายละเอียดเฉพาะของกลุ่ม ใช้ได้เมื่อชนิดหลัก `Group`
id	string uuid	ID ของโครงร่างสําคัญ
servicePrincipalDetails	ServicePrincipalDetails	รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก `ServicePrincipal`
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก `ServicePrincipalProfile`
type	PrincipalType	ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป
userDetails	UserDetails	รายละเอียดเฉพาะของผู้ใช้หลัก ใช้ได้เมื่อชนิดหลัก `User`

PrincipalType

การแจงนับ

ชนิดของรายการหลัก คุณสามารถเพิ่มชนิดหลักเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Group	หลักคือกลุ่มความปลอดภัย
ServicePrincipal	หลักคือโครงร่างสําคัญของบริการ Microsoft Entra
ServicePrincipalProfile	หลักคือ โปรไฟล์โครงร่างสําคัญของบริการ
User	หลักคือผู้ใช้หลัก Microsoft Entra

ServicePrincipalDetails

ออบเจ็กต์

รายละเอียดเฉพาะของบริการหลัก ใช้ได้เมื่อชนิดหลัก ServicePrincipal

ชื่อ	พิมพ์	คำอธิบาย
aadAppId	string uuid	Microsoft Entra AppId ของบริการหลัก

ServicePrincipalProfileDetails

ออบเจ็กต์

รายละเอียดโปรไฟล์โครงร่างสําคัญของบริการ ใช้ได้เมื่อชนิดหลัก ServicePrincipalProfile

ชื่อ	พิมพ์	คำอธิบาย
parentPrincipal	Principal	โครงร่างสําคัญของโปรไฟล์บริการหลัก

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	DayOfWeek[]	รายการของวันในสัปดาห์ที่อนุญาตให้ใช้องค์ประกอบส่วนใหญ่เจ็ดองค์ประกอบ

แชร์ผ่าน

Job Scheduler - Create Item Schedule

ขอบเขตที่ได้รับมอบสิทธิ์ที่จําเป็น:

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

อิน เทอร์ เฟซ

พารามิเตอร์ URI

เนื้อความของคำขอ

การตอบสนอง

ตัวอย่าง

create item schedule example

คำขอตัวอย่าง

คำตอบตัวอย่าง

คำจำกัดความ

CreateScheduleRequest

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig

แหล่งทรัพยากรเพิ่มเติม