จัดการสภาพแวดล้อมผ่าน API สาธารณะ
Microsoft Fabric REST API มีจุดสิ้นสุดการบริการสําหรับการดําเนินการสร้าง อ่าน อัปเดต และลบ (CRUD) ของรายการ Fabric บทความนี้อธิบายถึง REST API ของสภาพแวดล้อมที่พร้อมใช้งานและการใช้งานของ REST
สำคัญ
- การเผยแพร่ใหม่รวมถึง API ใหม่, การสนับสนุน API และการเปลี่ยนแปลงของสัญญาการตอบกลับ/คําขอ API ตารางในส่วนต่อไปนี้สรุปการเปลี่ยนแปลง API ทั้งหมด
- API ที่กําลังจะถูกยกเลิกการสนับสนุนจะยังคงมีการสนับสนุนจนถึงวันที่ 30 มิถุนายน 2025 การเปลี่ยนแปลงของสัญญาการตอบกลับ/คําขอจะมีผลทันทีเมื่อที่เริ่มเผยแพร่ที่ดิน
ข้อมูลสรุปของ API ของสภาพแวดล้อม
ประเภท | API | คำอธิบาย | หมายเหตุ |
---|---|---|---|
การดําเนินงานสินค้า | สร้างสภาพแวดล้อม | สร้างสภาพแวดล้อมว่างใหม่ในพื้นที่ทํางาน | ไม่เปลี่ยนแปลง |
การดําเนินงานสินค้า | สร้างสภาพแวดล้อมด้วยคํานิยาม | สร้างสภาพแวดล้อมใหม่ด้วยข้อกําหนด | API ใหม่ |
การดําเนินงานสินค้า | ลบสภาพแวดล้อม | ลบสภาพแวดล้อมที่มีอยู่ | ไม่เปลี่ยนแปลง |
การดําเนินงานสินค้า | สภาพแวดล้อมรายการ | รับรายการของสภาพแวดล้อมในพื้นที่ทํางาน | ไม่เปลี่ยนแปลง |
การดําเนินงานสินค้า | รับสภาพแวดล้อม | รับเมตาดาต้าของสภาพแวดล้อม การตอบสนองรวมถึงสถานะของสภาพแวดล้อม | การปรับปรุงสัญญาตอบสนอง |
การดําเนินงานสินค้า | รับข้อกําหนดของสภาพแวดล้อม | รับข้อกําหนดของสภาพแวดล้อม | API ใหม่ |
การดําเนินงานสินค้า | อัปเดตสภาพแวดล้อม | อัปเดตเมตาดาต้าของสภาพแวดล้อม เช่น ชื่อและคําอธิบาย | ไม่เปลี่ยนแปลง |
การดําเนินงานสินค้า | อัปเดตข้อกําหนดสภาพแวดล้อม | อัปเดตข้อกําหนดของสภาพแวดล้อม | API ใหม่ |
การดําเนินงานสินค้า | เผยแพร่สภาพแวดล้อม | ทริกเกอร์การเผยแพร่ของสภาพแวดล้อมที่มีการเปลี่ยนแปลงที่ค้างอยู่ปัจจุบัน | การปรับปรุงสัญญาตอบสนอง |
การดําเนินงานสินค้า | ยกเลิกสภาพแวดล้อมการเผยแพร่ | ยกเลิกการเผยแพร่อย่างต่อเนื่องของสภาพแวดล้อม | ไม่เปลี่ยนแปลง |
การจัดเตรียม | ไลบรารีการกําหนดระยะรายการ | รับรายการไลบรารีการกําหนดระยะแบบเต็ม รายการนี้ประกอบด้วยไลบรารีที่เผยแพร่และค้างอยู่ | การปรับปรุงสัญญาตอบสนอง |
การจัดเตรียม | นําเข้าไลบรารีภายนอก | อัปโหลดไลบรารีภายนอกเป็นไฟล์ environment.yml ลงในสภาพแวดล้อม ซึ่งจะแทนที่รายการของไลบรารีภายนอกที่มีอยู่ในสภาพแวดล้อม | API ใหม่ |
การจัดเตรียม | ส่งออกไลบรารีภายนอก | รับไลบรารีภายนอกเต็มรูปแบบเป็นไฟล์ environment.yml | API ใหม่ |
การจัดเตรียม | เอาไลบรารีภายนอกออก | ลบไลบรารีภายนอกออกจากสภาพแวดล้อม API นี้ยอมรับไลบรารีหนึ่งไลบรารีในแต่ละครั้ง | API ใหม่ |
การจัดเตรียม | อัปโหลดไลบรารีแบบกําหนดเอง | อัปโหลดแพคเกจแบบกําหนดเองในสภาพแวดล้อม API นี้อนุญาตให้อัปโหลดไฟล์หนึ่งไฟล์ในแต่ละครั้ง รูปแบบไฟล์ที่ได้รับการสนับสนุน.jar .py .whl และ.tar.gz | API ใหม่ |
การจัดเตรียม | ลบไลบรารีแบบกําหนดเอง | ลบแพคเกจแบบกําหนดเองจากสภาพแวดล้อม ใส่ชื่อเต็มของแพคเกจแบบกําหนดเองด้วยส่วนขยายในคําขอ API เพื่อนําออก | API ใหม่ |
การจัดเตรียม | อัปโหลดไลบรารีการจัดเตรียม | เพิ่มไลบรารีแบบกําหนดเองหนึ่งรายการหรือไลบรารีสาธารณะหนึ่งไลบรารี/หลายรายการในสภาพแวดล้อม | เลิกใช้ |
การจัดเตรียม | ลบไลบรารีการจัดเตรียม | ลบไลบรารีแบบกําหนดเองสําหรับการจัดเตรียมหนึ่งรายการหรือไลบรารีสาธารณะทั้งหมด | เลิกใช้ |
การจัดเตรียม | การตั้งค่า Spark การจัดเตรียมรายการ | รับการกําหนดค่าการคํานวณการกําหนดระยะแบบเต็ม การกําหนดค่าการแสดงข้อมูลรวมถึงการกําหนดค่าการคํานวณที่เผยแพร่และค้างอยู่ | การปรับปรุงสัญญาตอบสนอง |
การจัดเตรียม | อัปเดตการตั้งค่า Spark | อัปเดตการกําหนดค่าการคํานวณและคุณสมบัติ Spark สําหรับสภาพแวดล้อม | ปรับปรุงสัญญาคําขอ/การตอบกลับของ |
เผยแพร่แล้ว | รายการไลบรารีที่เผยแพร่ | รับไลบรารีที่เผยแพร่และมีประสิทธิภาพในเซสชัน Spark | การปรับปรุงสัญญาตอบสนอง |
เผยแพร่แล้ว | การตั้งค่า Spark ที่เผยแพร่ | รับการกําหนดค่าการคํานวณ Spark และคุณสมบัติ Spark ที่มีการเผยแพร่และมีประสิทธิภาพในเซสชัน Spark | การปรับปรุงสัญญาตอบสนอง |
เผยแพร่แล้ว | ส่งออกไลบรารีภายนอก | รับไลบรารีภายนอกที่เผยแพร่เป็นไฟล์ environment.yml | API ใหม่ |
เรียนรู้เพิ่มเติมเกี่ยวกับ API สาธารณะของสภาพแวดล้อมที่มีอยู่ใน API รายการ - สภาพแวดล้อม
รายละเอียดการอัปเดต API สาธารณะของสภาพแวดล้อม
ในส่วนนี้จะอธิบายเกี่ยวกับการอัปเดตที่กําลังจะเกิดขึ้นสําหรับ API ที่มีอยู่
รับสภาพแวดล้อม
ในการตอบสนองต่อรับ API ของสภาพแวดล้อม 'startTime' จะกลายเป็น 'startDateTime' และ 'endTime' จะกลายเป็น 'endDateTime' ซึ่งแสดงเวลาเริ่มต้น/สิ้นสุดของการดําเนินการเผยแพร่
หมายเหตุ
'startTime' และ 'endTime' กําลังใช้รูปแบบ วันที่-เวลา ในขณะที่ 'startDateTime' และ 'endDateTime' จะเป็น สตริงซึ่งอยู่ใน UTC และใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
อินเตอร์เฟซ
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}
การตอบสนองตัวอย่างเดิม
{ "displayName": "Environment_1", "description": "An Environment description", "type": "Environment", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "id": "5b218778-e7a5-4d73-8187-f10824047715", "properties": { "publishDetails": { "state": "Success", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "endTime": "2024-03-29T14:48:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Success" }, "sparkSettings": { "state": "Success" } } } } }
การตอบสนองตัวอย่างใหม่
{ "displayName": "Environment_1", "description": "An Environment description", "type": "Environment", "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "id": "5b218778-e7a5-4d73-8187-f10824047715", "properties": { "publishDetails": { "state": "Success", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startDateTime": "2024-03-29T14:17:09Z", "endDateTime": "2024-03-29T14:48:09Z", "componentPublishInfo": { "sparkLibraries": { "state": "Success" }, "sparkSettings": { "state": "Success" } } } } }
เผยแพร่สภาพแวดล้อม
เผยแพร่ API สภาพแวดล้อมจะสนับสนุนการดําเนินการที่ใช้เวลานานโดยเริ่มต้นจากการวางจําหน่าย สัญญาของการตอบสนองจะเปลี่ยนแปลง ปลายทางยังคงเหมือนเดิมสําหรับการส่งคําขอ
อินเตอร์เฟซ
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish
การตอบสนองตัวอย่างเดิม
{ "publishDetails": { "state": "Running", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Running" }, "sparkSettings": { "state": "Running" } } } }
การตอบสนองตัวอย่างใหม่
Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69 x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69 Retry-After: 60
แสดงรายการจัดเตรียม/เผยแพร่ไลบรารีแล้ว
API ทั้งสองนี้สามารถรับรายการทั้งหมดของไลบรารีจัดเตรียม/เผยแพร่ของสภาพแวดล้อมได้ จุดสิ้นสุดยังคงเหมือนเดิมสําหรับการส่งคําขอ ในขณะที่ไลบรารีจะถูกส่งกลับด้วยโครงสร้างที่แตกต่างกัน
อินเทอร์เฟซ
รับไลบรารีการจัดเตรียม
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/libraries
รับไลบรารีที่เผยแพร่แล้ว
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries
การตอบสนองตัวอย่างเดิม
{ "customLibraries": { "wheelFiles": [ "samplewheel-0.18.0-py2.py3-none-any.whl" ], "pyFiles": [ "samplepython.py" ], "jarFiles": [ "samplejar.jar" ], "rTarFiles": [ "sampleR.tar.gz" ] }, "environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3" }
การตอบสนองตัวอย่างใหม่
{ "libraries": [ { "name": "samplewheel-0.18.0-py2.py3-none-any.whl", "libraryType": "Custom" }, { "name": "samplepython.py", "libraryType": "Custom" }, { "name": "samplejar.jar", "libraryType": "Custom" }, { "name": "sampleR.tar.gz", "libraryType": "Custom" }, { "name": "fuzzywuzzy", "libraryType": "External", "version": "0.0.1" }, { "name": "matplotlib", "libraryType": "External", "version": "0.0.1" } ], "continuationToken": "null", "continuationUri": "null" }
การตั้งค่า Staging/Published Spark
API ทั้งสองนี้สามารถรับการกําหนดค่าการคํานวณ Spark และคุณสมบัติของสภาพแวดล้อมได้ ปลายทางยังคงเหมือนเดิมสําหรับการส่งคําขอ คุณสมบัติ Spark จะเปลี่ยนเป็นรายการ
อินเทอร์เฟซ
รับการตั้งค่า Staging Spark
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute
รับการตั้งค่า Spark ที่เผยแพร่
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute
การตอบสนองตัวอย่างเดิม
{ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", "id": "78942136-106c-4f3e-80fc-7ff4eae11603" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": "false" }, "runtimeVersion": "1.2" }
การตอบสนองตัวอย่างใหม่
{ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", "id": "78942136-106c-4f3e-80fc-7ff4eae11603" }, "driverCores": "4", "driverMemory": "56G", "executorCores": "4", "executorMemory": "56G", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": [ { "key": "spark.acls.enable", "value": "false" } ], "runtimeVersion": "1.2" }
อัปเดตการตั้งค่า Spark
API นี้สําหรับการอัปเดตการคํานวณและคุณสมบัติของ Spark ในสภาพแวดล้อม สัญญาของ Spark คุณสมบัติในคําขอและการตอบสนองจะได้รับการอัปเดตเมื่อพื้นที่ที่วางจําหน่าย
คําขอตัวอย่างเดิม
PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute { "instancePool": { "name": "MyWorkspacePool", "type": "Workspace" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": "false", "spark.admin.acls": null }, "runtimeVersion": "1.2" }
คําขอตัวอย่างใหม่
PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute { "instancePool": { "name": "MyWorkspacePool", "type": "Workspace" }, "driverCores": "4", "driverMemory": "56G", "executorCores": "4", "executorMemory": "56G", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": [ { "key": "spark.acls.enable", "value": "false" }, { "key": "spark.admin.acls", "value": null } ], "runtimeVersion": "1.2" }
การตอบสนองตัวอย่างเดิม
{ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", "id": "78942136-106c-4f3e-80fc-7ff4eae11603" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": "false" }, "runtimeVersion": "1.2" }
การตอบสนองตัวอย่างใหม่
{ "instancePool": { "name": "MyWorkspacePool", "type": "Workspace", "id": "78942136-106c-4f3e-80fc-7ff4eae11603" }, "driverCores": "4", "driverMemory": "56G", "executorCores": "4", "executorMemory": "56G", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": [ { "key": "spark.acls.enable", "value": "false" } ], "runtimeVersion": "1.2" }
กรณีการใช้งาน API สาธารณะของสภาพแวดล้อม
สำคัญ
API และการเปลี่ยนแปลงสัญญาใหม่ไม่ได้รวมอยู่ในส่วนนี้
ส่วนนี้สาธิตวิธีการใช้ API ที่พร้อมใช้งานในปัจจุบันเพื่อบรรลุเป้าหมายที่เฉพาะเจาะจง คุณสามารถแทนที่ {WORKSPACE_ID}
และ {ARTIFACT_ID}
ในตัวอย่างต่อไปนี้ด้วยค่าที่เหมาะสม
สร้างสภาพแวดล้อมใหม่
คุณสามารถสร้างสภาพแวดล้อมว่างใหม่โดยใช้ API ต่อไปนี้
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments { "displayName": "Environment_1", "description": "An environment description" }
จัดการไลบรารีการจัดเตรียม
คุณสามารถใช้ไลบรารีจัดเตรียมการอัปโหลด/ลบ API เพื่อจัดการส่วนไลบรารีในสภาพแวดล้อม
ตรวจสอบไลบรารีที่เผยแพร่สําหรับสภาพแวดล้อม
ก่อนที่จะเพิ่ม/ลบไลบรารี คุณสามารถใช้ API ไลบรารีที่เผยแพร่แล้วเพื่อตรวจสอบไลบรารีใดที่มีประสิทธิภาพในปัจจุบัน
คำขอตัวอย่าง
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries
คำตอบตัวอย่าง
{ "customLibraries": { "wheelFiles": [ "samplewheel-0.18.0-py2.py3-none-any.whl" ], "pyFiles": [ "samplepython.py" ], "jarFiles": [ "samplejar.jar" ], "rTarFiles": [ "sampleR.tar.gz" ] }, "environmentYml": "dependencies:\r\n- pip:\r\n - matplotlib==3.4.3" }
การอัปโหลดไลบรารี
API สําหรับการอัปโหลดไลบรารีการกําหนดระยะจะยอมรับหนึ่งไฟล์ในแต่ละครั้ง ชนิดไฟล์ที่ได้รับการสนับสนุนคือ .whl, .jar, .tar.gz, .py และ environment.yml สําหรับไลบรารีสาธารณะ คุณสามารถระบุไฟล์ผ่านประเภทเนื้อหาแบบหลายส่วน/ฟอร์มข้อมูล
หมายเหตุ
- เพื่อจัดการไลบรารีสาธารณะอย่างมีประสิทธิภาพมากขึ้น ขอแนะนําให้เขียนไลบรารีที่คาดหวังทั้งหมดจาก PyPI และ conda ในไฟล์ environment.yml
- API การอัปโหลดอนุญาตให้มีไฟล์สูงสุด 200 MB ในหนึ่งคําขอ ไลบรารีที่เกินขีดจํากัดขนาดนี้ยังไม่ได้รับการรองรับใน API สาธารณะ
คําขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries
การลบไลบรารี
ด้วยการระบุชื่อแฟ้มไลบรารีแบบเต็มด้วยชนิดคําต่อท้าย คุณสามารถลบไลบรารีได้ครั้งละหนึ่งไลบรารี
หมายเหตุ
- ถ้าคุณระบุ
environment.yml
เป็นไฟล์ที่จะลบ คุณกําลังเอาไลบรารีสาธารณะทั้งหมดออก - ถ้าคุณต้องการเอาชุดย่อยของไลบรารีสาธารณะที่มีอยู่ออก โปรดใช้ไลบรารีการอัปโหลดแทน และอัปโหลด environment.yml ที่มีเฉพาะไลบรารีที่คาดไว้เท่านั้น environment.yml ที่อัปโหลดจะแทนที่ส่วนไลบรารีสาธารณะที่มีอยู่ทั้งหมด
คําขอตัวอย่าง
DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?libraryToDelete=fuzzywuzzy-0.18.0-py2.py3-none-any.whl
จัดการการคํานวณ Staging Spark
คุณสามารถใช้การคํานวณ Staging Spark เพื่อจัดการการคํานวณ Spark ได้
ตรวจสอบการคํานวณ Spark ที่เผยแพร่สําหรับสภาพแวดล้อม
ก่อนที่จะเปลี่ยนการกําหนดค่าสําหรับสภาพแวดล้อม คุณสามารถใช้ API การคํานวณ Spark ที่เผยแพร่แล้วเพื่อตรวจสอบการกําหนดค่าการคํานวณ Spark ใดที่มีประสิทธิภาพในปัจจุบันได้
คำขอตัวอย่าง
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute
คำตอบตัวอย่าง
{ "instancePool": { "name": "Starter Pool", "type": "Workspace" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": "false" }, "runtimeVersion": "1.2" }
อัปเดตการกําหนดค่าการคํานวณ
คุณสามารถอัปเดตรันไทม์ Spark สลับไปยังพูลอื่น ปรับปรุงการกําหนดค่าการคํานวณ และเพิ่ม/ลบคุณสมบัติ Spark ผ่านการแก้ไขเนื้อความคําขอของ API นี้
คุณสามารถสลับกลุ่มที่แนบมาโดยการระบุชื่อกลุ่มและกลุ่ม ระบุชื่อพูลเป็น Starter Pool
เพื่อสลับพูลไปเป็นการตั้งค่าเริ่มต้น หากต้องการรับรายการพูลแบบกําหนดเองที่มีทั้งหมดของพื้นที่ทํางานโดย REST API ดู พูลแบบกําหนดเอง - รายการพื้นที่ทํางานแบบกําหนดเอง
ถ้าคุณต้องการเอาคุณสมบัติ Spark ที่มีอยู่ออก คุณจําเป็นต้องระบุค่าเป็น null
ด้วยคีย์ที่คุณต้องการนําออก ดังที่แสดงในตัวอย่างต่อไปนี้
คำขอตัวอย่าง
PATCH https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute { "instancePool": { "name": "Starter Pool", "type": "Workspace" }, "driverCores": 4, "driverMemory": "56g", "executorCores": 4, "executorMemory": "56g", "dynamicExecutorAllocation": { "enabled": false, "minExecutors": 1, "maxExecutors": 1 }, "sparkProperties": { "spark.acls.enable": null }, "runtimeVersion": "1.2" }
ทําให้การเปลี่ยนแปลงมีผลบังคับใช้
ใช้ชุด API ต่อไปนี้เพื่อเผยแพร่การเปลี่ยนแปลง
เตรียมพร้อมสําหรับการเผยแพร่
สภาพแวดล้อมสามารถยอมรับหนึ่งการเผยแพร่ในแต่ละครั้ง ก่อนที่จะเผยแพร่สภาพแวดล้อมของคุณ คุณสามารถตรวจสอบสถานะของสภาพแวดล้อมและมีการตรวจทานขั้นสุดท้ายของการเปลี่ยนแปลงการจัดเตรียมได้ เมื่อเผยแพร่สภาพแวดล้อมสําเร็จแล้ว การกําหนดค่าทั้งหมดในสถานะการแสดงข้อมูลจะมีผล
ขั้นตอนที่ 1: รับเมตาดาต้าของสภาพแวดล้อม
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
ในเนื้อหาคําตอบ คุณสามารถบอกสถานะของสภาพแวดล้อมได้อย่างชัดเจน ตรวจสอบให้แน่ใจว่าไม่มีการเผยแพร่อย่างต่อเนื่องก่อนที่คุณจะย้ายไปยังขั้นตอนถัดไป
ขั้นตอนที่ 2: รับไลบรารีจัดเตรียม/Spark คํานวณเพื่อให้มีการตรวจทานขั้นสุดท้าย
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute
ทริกเกอร์การเผยแพร่ของสภาพแวดล้อม
การเปลี่ยนแปลงที่คุณทําในสําหรับไลบรารีการกําหนดระยะและการคํานวณ Spark จะถูกแคช แต่จําเป็นต้องมีการเผยแพร่เพื่อให้มีประสิทธิภาพ ทําตามตัวอย่างต่อไปนี้เพื่อทริกเกอร์การเผยแพร่
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish
คำตอบตัวอย่าง
{ "publishDetails": { "state": "Running", "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d", "startTime": "2024-03-29T14:17:09.0697022Z", "componentPublishInfo": { "sparkLibraries": { "state": "Running" }, "sparkSettings": { "state": "Running" } } } }
ในระหว่างการเผยแพร่ คุณยังสามารถเรียกใช้ API ต่อไปนี้เพื่อ ยกเลิก ได้อีกด้วย
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish