หมายเหตุ
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลอง ลงชื่อเข้าใช้หรือเปลี่ยนไดเรกทอรีได้
การเข้าถึงหน้านี้ต้องได้รับการอนุญาต คุณสามารถลองเปลี่ยนไดเรกทอรีได้
Microsoft Fabric REST API มีจุดสิ้นสุดการบริการสําหรับการดําเนินการสร้าง อ่าน อัปเดต และลบ (CRUD) ของรายการ Fabric บทความนี้อธิบาย REST API ของสมุดบันทึกที่พร้อมใช้งานและการใช้งานของ API
ด้วย API สมุดบันทึก วิศวกรข้อมูลและนักวิทยาศาสตร์ข้อมูลสามารถปรับไปป์ไลน์ของตนเองให้เป็นอัตโนมัติและสร้าง CI/CD ได้อย่างสะดวกและมีประสิทธิภาพ API เหล่านี้ยังทําให้ผู้ใช้สามารถจัดการและจัดการรายการโน้ตบุ๊ค Fabric และรวมสมุดบันทึกกับเครื่องมือและระบบอื่น ๆ ได้อย่างง่ายดาย สมุดบันทึกสามารถประสานได้จากไปป์ไลน์ Fabric และตัวกําหนดเวลาภายนอกผ่าน API เหล่านี้ ทําให้สามารถผสานรวมกับเวิร์กโฟลว์อัตโนมัติได้อย่างราบรื่น
การดําเนินการจัดการรายการเหล่านี้จะพร้อมใช้งานสําหรับสมุดบันทึก:
| การดำเนินการ | คำอธิบาย |
|---|---|
| สร้างรายการ | สร้างสมุดบันทึกภายในพื้นที่ทํางาน |
| อัปเดตหน่วยข้อมูล | อัปเดตเมตาดาต้าของสมุดบันทึก |
| อัปเดตข้อกําหนดรายการ | อัปเดตเนื้อหาของสมุดบันทึก |
| ลบรายการ | ลบสมุดบันทึก |
| รับรายการ | รับเมตาดาต้าของสมุดบันทึก |
| รับข้อกําหนดรายการ | รับเนื้อหาของสมุดบันทึก |
| ข้อมูลในรายการ | แสดงรายการทั้งหมดในพื้นที่ทํางาน |
สําหรับข้อมูลเพิ่มเติม ดูรายการ - REST API
การดําเนินการของตัวจัดกําหนดการงานต่อไปนี้จะพร้อมใช้งานสําหรับสมุดบันทึก:
| การดำเนินการ | คำอธิบาย |
|---|---|
| การรันงานตามความต้องการสินค้า | เรียกใช้สมุดบันทึกตามความต้องการพร้อมรองรับการกําหนดพารามิเตอร์ การกําหนดค่าเซสชัน (เช่น การตั้งค่า Spark/การคํานวณ) การเลือกสภาพแวดล้อมและรันไทม์ และการเลือก Fabric Lakehouse เป้าหมาย |
| ยกเลิกอินสแตนซ์งานรายการ | ยกเลิกการรันงานสมุดบันทึก |
| รับรายการอินสแตนซ์ของงาน | รับสถานะการเรียกใช้สมุดบันทึกและดึงค่าออกที่ส่งคืนโดยการเรียกใช้ |
สําหรับข้อมูลเพิ่มเติม ให้ดูที่ ตัวจัดกําหนดการงาน
หมายเหตุ
การรับรองความถูกต้องของบริการหลักได้รับการสนับสนุนสําหรับทั้ง Items REST API (การดําเนินการ CRUD ของสมุดบันทึก) และ Job Scheduler API (การดําเนินการ การตรวจสอบ และการยกเลิก) สิ่งนี้ทําให้ระบบอัตโนมัติและสถานการณ์ CI/CD และระบบอัตโนมัติแบบไม่ต้องใส่ข้อมูลได้อย่างปลอดภัย เพิ่มบริการหลักไปยังพื้นที่ทํางานด้วยบทบาทที่เหมาะสม (ผู้ดูแลระบบ สมาชิก หรือผู้สนับสนุน) เพื่อจัดการและดําเนินการสมุดบันทึก
ออกจากค่าจากการเรียกใช้สมุดบันทึก
การเรียกใช้สมุดบันทึกที่ดําเนินการผ่าน Job Scheduler API สามารถส่งคืนค่าออกที่คุณสามารถใช้สําหรับการประสานรวมแบบมีเงื่อนไข ค่า exit จะปรากฏในexitValueฟิลด์ของเพย์โหลดการตอบสนอง Get Item Job Instance
สมุดบันทึกสามารถตั้งค่าออกได้โดยการ mssparkutils.notebook.exit("your-value") เรียกก่อนที่การเรียกใช้จะเสร็จสมบูรณ์ ค่าออกเป็นสตริงและสามารถเข้ารหัสสัญญาณผลลัพธ์ใดๆ ได้ เช่น "success", หรือ "no_rows_processed"ผลลัพธ์แบบอนุกรม JSON
ผู้ประสานงานภายนอก ไปป์ไลน์ Fabric และเครื่องมืออัตโนมัติอื่นๆ สามารถเรียกใช้ Get Item Job Instance หลังจากการเรียกใช้เสร็จสิ้นเพื่ออ่านค่าออกและแยกสาขาในผลลัพธ์ เช่น:
- ส่ง งานรายการ เรียกใช้ตามความต้องการ พร้อมพารามิเตอร์และการตั้งค่าการดําเนินการ
- โพล รับอินสแตนซ์งานไอเท็ม จนกระทั่ง
statusCompleted(หรือFailed) - อ่าน
exitValueจากคําตอบเพื่อกําหนดขั้นตอนต่อไปในเวิร์กโฟลว์ของคุณ
รูปแบบนี้เปิดใช้งานการประสานรวมแบบมีเงื่อนไขและการส่งสัญญาณดาวน์สตรีมตามผลลัพธ์การดําเนินการของโน้ตบุ๊ก
ตัวอย่างแบบครบวงจร
ตัวอย่างต่อไปนี้แสดงวิธีการส่งการเรียกใช้สมุดบันทึกและเรียกดูสถานะและค่าออก สําหรับสคีมาเนื้อหาคําขอที่สมบูรณ์ รวมถึงพารามิเตอร์ การกําหนดค่าเซสชัน และฟิลด์การเลือก Lakehouse โปรดดู ตัวจัดกําหนดการงาน - การอ้างอิง API งานรายการเรียกใช้ตามความต้องการ
ขั้นตอนที่ 1: ส่งการเรียกใช้
ใช้จุดสิ้นสุด งานรายการเรียกใช้ตามความต้องการ เพื่อเริ่มการเรียกใช้สมุดบันทึก:
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances?jobType=RunNotebook
การตอบกลับจะส่งคืน 202 Accepted พร้อมกับ Location ส่วนหัวที่มี URL ของอินสแตนซ์งานที่คุณใช้เพื่อตรวจสอบการรัน
ขั้นตอนที่ 2: ดึงสถานะการเรียกใช้และค่าออก
ใช้ URL จาก Location ส่วนหัวเพื่อตรวจสอบสถานะและอ่านค่าออกหลังจากการเรียกใช้เสร็จสิ้น
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances/{jobInstanceId}
ตัวอย่างการตอบกลับ (ตัวย่อ):
{
"id": "<jobInstanceId>",
"itemId": "<notebookId>",
"jobType": "RunNotebook",
"invokeType": "OnDemand",
"status": "Completed",
"startTimeUtc": "2026-03-01T10:00:00Z",
"endTimeUtc": "2026-03-01T10:05:00Z",
"failureReason": null,
"exitValue": "success"
}
อ่าน exitValue เพื่อกําหนดผลลัพธ์และแยกตรรกะการทํางานอัตโนมัติของคุณตามนั้น