แชร์ผ่าน

จัดการสภาพแวดล้อมผ่าน API สาธารณะ

Microsoft Fabric REST API มีจุดสิ้นสุดการบริการสําหรับการดําเนินการสร้าง อ่าน อัปเดต และลบ (CRUD) ของรายการ Fabric บทความนี้อธิบายถึง REST API ของสภาพแวดล้อมที่พร้อมใช้งานและการใช้งานของ REST

ย้าย API สภาพแวดล้อมไปยังเวอร์ชัน GA ที่เสถียร

สำคัญ

  • รุ่น GA ประกอบด้วยการอัปเดตในสัญญาคําขอ/การตอบกลับของ API ที่มีอยู่ การเลิกใช้งาน API และ API ใหม่ คุณสามารถดูรายละเอียดได้ในส่วนต่อไปนี้
  • มีการนําพารามิเตอร์ beta คิวรีใหม่มาใช้เพื่ออํานวยความสะดวกในการเปลี่ยนการเปลี่ยนแปลงสัญญาคําขอ/การตอบสนอง betaพารามิเตอร์คิวรีมีค่าเริ่มต้นจนถึงTrueวันที่ 31 มีนาคม 2026 ทําให้สัญญาแสดงตัวอย่างยังคงพร้อมใช้งาน ตั้งค่าเป็น False เพื่อเริ่มต้นใช้สัญญารุ่นนําออกใช้ที่เสถียร
  • Preview query ถูกแทนที่ด้วย beta. สําหรับความเข้ากันได้แบบย้อนหลัง การแสดงตัวอย่างยังคงได้รับการสนับสนุนและทํางานเหมือนกับเบต้า
  • API ที่เลิกใช้งาน to-beจะยังคงได้รับการสนับสนุนจนถึง วันที่ 31 มีนาคม 2026 โปรดใช้ API ที่เพิ่งเปิดตัวเพื่อแทนที่โดยเร็วที่สุด

API ที่มีการอัปเดตสัญญาคําขอ/การตอบกลับ

ประเภท API คำอธิบาย บันทึกย่อ ตัวอย่างเวอร์ชัน swagger รุ่นที่วางจําหน่าย swagger
การดําเนินงานสินค้า เผยแพร่สภาพแวดล้อม ทริกเกอร์การดําเนินการเผยแพร่ของสภาพแวดล้อมด้วยการเปลี่ยนแปลงที่รอดําเนินการในปัจจุบัน อัปเดตในสัญญาการตอบสนอง สภาพแวดล้อมการเผยแพร่ (พรีวิว) สภาพแวดล้อมการเผยแพร่
การจัดเตรียม ไลบรารีการกําหนดระยะรายการ รับรายการไลบรารีการกําหนดระยะแบบเต็ม รายการนี้ประกอบด้วยไลบรารีที่เผยแพร่และค้างอยู่ อัปเดตในสัญญาการตอบสนอง รายการไลบรารีการจัดเตรียม (พรีวิว) แสดงรายการไลบรารีการจัดเตรียม
การจัดเตรียม การจัดเตรียมรายการการประมวลผล Spark รับการกําหนดค่าการคํานวณการกําหนดระยะแบบเต็ม การกําหนดค่าการแสดงข้อมูลรวมถึงการกําหนดค่าการคํานวณที่เผยแพร่และค้างอยู่ อัปเดตในสัญญาการตอบสนอง การแสดงรายการ Spark compute (พรีวิว) การจัดเตรียมรายการการประมวลผล Spark
การจัดเตรียม อัปเดตการประมวลผล Spark อัปเดตการกําหนดค่าการประมวลผลและคุณสมบัติ Spark สําหรับสภาพแวดล้อม อัปเดตในสัญญาคําขอและการตอบกลับ อัปเดตการประมวลผล Spark (พรีวิว) อัปเดตการประมวลผล Spark
เผยแพร่แล้ว รายการไลบรารีที่เผยแพร่ รับไลบรารีที่เผยแพร่และมีประสิทธิภาพในเซสชัน Spark อัปเดตในสัญญาการตอบสนอง แสดงรายการไลบรารีที่เผยแพร่ (พรีวิว) แสดงรายการไลบรารีที่เผยแพร่
เผยแพร่แล้ว รายการที่เผยแพร่การประมวลผล Spark รับการกําหนดค่าการคํานวณ Spark และคุณสมบัติ Spark ที่มีการเผยแพร่และมีประสิทธิภาพในเซสชัน Spark อัปเดตในสัญญาการตอบสนอง แสดงรายการไลบรารีที่เผยแพร่ (พรีวิว) แสดงรายการไลบรารีที่เผยแพร่

betaพารามิเตอร์มีค่าเริ่มต้นจนถึงTrueวันที่ 31 มีนาคม 2026 กล่าวคือ ระบบจะพิจารณาพารามิเตอร์ราวกับTrueว่าคําขอกําลังส่งโดยไม่ระบุพารามิเตอร์นี้จนกว่าจะถึงวันที่เลิกใช้แล้ว เราขอแนะนําอย่างยิ่งให้ย้ายการใช้งานของคุณไปยังเวอร์ชันเสถียรโดยตั้งค่า beta พารามิเตอร์อย่างชัดเจนโดย False เร็วที่สุด

การใช้ List staging libraries API เป็นตัวอย่าง ซึ่งมีการอัปเดตในการตอบกลับ API

  • เมื่อส่งคําขอด้วย beta พารามิเตอร์เป็น True

    คําขอตัวอย่าง:

    GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

    ตัวอย่างการตอบสนอง:

    {
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

  • เมื่อส่งคําขอด้วย preview พารามิเตอร์เป็น False

    คําขอตัวอย่าง:

      GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

    ตัวอย่างการตอบสนอง:

    {
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

API ที่เลิกใช้แล้ว

สำคัญ

  • API ที่เลิกใช้งาน to-beจะยังคงได้รับการสนับสนุนจนถึงวันที่ 31 มีนาคม 2026 เราขอแนะนําให้ใช้ API ที่เพิ่งเปิดตัวใหม่เพื่อแทนที่การใช้งานของคุณโดยเร็วที่สุด
ประเภท API คำอธิบาย หมายเหตุ
การจัดเตรียม อัปโหลดไลบรารีการแสดงละคร เพิ่มไลบรารีแบบกําหนดเองหนึ่งไลบรารีหรือไลบรารีสาธารณะหนึ่ง/หลายไลบรารีในสภาพแวดล้อม การสนับสนุนจนถึง วันที่ 31 มีนาคม 2026 โปรดใช้ API ที่เพิ่งเปิดตัว Import external libraries/Upload custom library เพื่อแทนที่
การจัดเตรียม ลบไลบรารีการจัดเตรียม ลบไลบรารีแบบกําหนดเองที่จัดเตรียมไว้หนึ่งไลบรารีหรือไลบรารีสาธารณะทั้งหมด การสนับสนุนจนถึง วันที่ 31 มีนาคม 2026 โปรดใช้ API ที่เพิ่งเปิดตัว Remove external library/Delete custom library เพื่อแทนที่

ด้านล่างนี้คือตัวอย่างบางส่วนที่ครอบคลุมสถานการณ์เมื่อจัดการไลบรารีการจัดเตรียม

  • เพิ่มไลบรารีสาธารณะในสภาพแวดล้อมของคุณ

    ก่อนหน้านี้ คุณสามารถใช้ Upload staging libraries API เพื่ออัปโหลดไฟล์ YAML ที่อัปเดต และตอนนี้คุณสามารถใช้ Import external libraries API เพื่อนําเข้า YAML ที่อัปเดตแล้ว

  • ลบไลบรารีสาธารณะหนึ่งไลบรารีในสภาพแวดล้อมของคุณ

    ก่อนหน้านี้ คุณสามารถใช้ Upload staging libraries API เพื่ออัปโหลดไฟล์ YAML ที่อัปเดตแล้ว และตอนนี้คุณสามารถใช้ Remove external library API เพื่อลบออกได้

  • ลบไลบรารีสาธารณะทั้งหมดในสภาพแวดล้อมของคุณ

    ก่อนหน้านี้คุณสามารถใช้ Delete staging libraries API เพื่อลบไลบรารีสาธารณะทั้งหมดและตอนนี้คุณสามารถใช้ Remove external library API เพื่อลบไลบรารีสาธารณะทีละรายการหรือใช้เพื่อ Import external libraries อัปโหลดไฟล์ YAML เปล่าเพื่อให้ได้ฟังก์ชันการทํางานเดียวกัน

API ใหม่

ประเภท API คำอธิบาย หมายเหตุ
การดําเนินงานสินค้า สร้างสภาพแวดล้อมด้วยคําจํากัดความ สร้างสภาพแวดล้อมใหม่ด้วยคําจํากัดความ API ใหม่
การดําเนินงานสินค้า รับคําจํากัดความสภาพแวดล้อม รับข้อกําหนดของสภาพแวดล้อม API ใหม่
การดําเนินงานสินค้า ปรับปรุงข้อกําหนดสภาพแวดล้อม อัปเดตข้อกําหนดของสภาพแวดล้อม API ใหม่
การจัดเตรียม นําเข้าไลบรารีภายนอก อัปโหลดไลบรารีภายนอกเป็นไฟล์ environment.yml ลงในสภาพแวดล้อม มันแทนที่รายการของไลบรารีภายนอกที่มีอยู่ในสภาพแวดล้อม API ใหม่
การจัดเตรียม ส่งออกไลบรารีภายนอก รับไลบรารีภายนอกแบบเต็มเป็นไฟล์ environment.yml API ใหม่
การจัดเตรียม ลบไลบรารีภายนอก ลบไลบรารีภายนอกออกจากสภาพแวดล้อม API นี้ยอมรับไลบรารีทีละไลบรารี API ใหม่
การจัดเตรียม อัปโหลดไลบรารีแบบกําหนดเอง อัปโหลดแพคเกจแบบกําหนดเองในสภาพแวดล้อม API นี้อนุญาตให้อัปโหลดไฟล์หนึ่งไฟล์ในแต่ละครั้ง รูปแบบไฟล์ที่ได้รับการสนับสนุน.jar .py .whl และ.tar.gz API ใหม่
การจัดเตรียม ลบไลบรารีแบบกําหนดเอง ลบแพคเกจแบบกําหนดเองจากสภาพแวดล้อม ใส่ชื่อเต็มของแพคเกจแบบกําหนดเองด้วยส่วนขยายในคําขอ API เพื่อนําออก API ใหม่
เผยแพร่แล้ว ส่งออกไลบรารีภายนอก รับไลบรารีภายนอกที่เผยแพร่เป็นไฟล์ environment.yml API ใหม่

API ที่ไม่มีการอัปเดต

ประเภท API คำอธิบาย
การดําเนินงานสินค้า สร้างสภาพแวดล้อม สร้างสภาพแวดล้อมว่างใหม่ในพื้นที่ทํางาน
การดําเนินงานสินค้า รับสภาพแวดล้อม รับเมตาดาต้าของสภาพแวดล้อม การตอบสนองรวมถึงสถานะของสภาพแวดล้อม
การดําเนินงานสินค้า ลบสภาพแวดล้อม ลบสภาพแวดล้อมที่มีอยู่
การดําเนินงานสินค้า สภาพแวดล้อมรายการ รับรายการสภาพแวดล้อมในพื้นที่ทํางาน
การดําเนินงานสินค้า ปรับปรุงสภาพแวดล้อม อัปเดตเมตาดาต้าของสภาพแวดล้อม เช่น ชื่อและคําอธิบาย
การดําเนินงานสินค้า ยกเลิกสภาพแวดล้อมการเผยแพร่ ยกเลิกการดําเนินการเผยแพร่สภาพแวดล้อมที่กําลังดําเนินอยู่

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับ API สาธารณะของสภาพแวดล้อม โปรดดู API รายการ - สภาพแวดล้อม

กรณีการใช้งาน 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?beta=False

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

    {
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

นําเข้าไลบรารีสาธารณะหรืออัปโหลดไลบรารีแบบกําหนดเอง

คุณสามารถใช้ นําเข้าไลบรารีภายนอก และ อัปโหลด API ไลบรารีแบบกําหนดเอง เพื่อเพิ่มไลบรารีสาธารณะ/แบบกําหนดเองใหม่ให้กับสภาพแวดล้อมของคุณ API ไลบรารีภายนอกนําเข้ายอมรับไฟล์ environment.yml ในขณะที่ประเภทไฟล์ที่รองรับคือ .whl, .jar, .tar.gz.py สําหรับ API ไลบรารีที่กําหนดเองในการอัปโหลด

หมายเหตุ

ในการจัดการไลบรารีสาธารณะอย่างมีประสิทธิภาพมากขึ้นเราขอแนะนําให้คุณเขียนไลบรารีที่คาดหวังทั้งหมดจาก PyPI และ Conda ในไฟล์ environment.yml

API การอัปโหลดอนุญาตให้ใช้ไฟล์ได้สูงสุด 200 MB ในคําขอเดียว ไลบรารีที่เกินขีดจํากัดขนาดนี้ไม่ได้รับการสนับสนุนใน API สาธารณะในขณะนี้

  • คําขอตัวอย่าง

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

ลบไลบรารีแบบกําหนดเอง

ด้วยการระบุชื่อแฟ้มไลบรารีแบบเต็มด้วยคําต่อท้ายชนิด คุณสามารถลบไลบรารีแบบกําหนดเองได้ครั้งละหนึ่งไลบรารี

หมายเหตุ

หากคุณต้องการลบชุดย่อยของไลบรารีสาธารณะที่มีอยู่หรือทั้งหมด โปรดนําเข้าไฟล์ YAML ที่อัปเดตผ่าน Import public libraries API

  • คําขอตัวอย่าง

    DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

จัดการการคํานวณ Staging Spark

คุณสามารถใช้การคํานวณ Staging Spark เพื่อจัดการการคํานวณ Spark ได้

ตรวจสอบการคํานวณ Spark ที่เผยแพร่สําหรับสภาพแวดล้อม

ก่อนที่คุณจะเปลี่ยนการกําหนดค่าสําหรับสภาพแวดล้อม ให้ใช้ API การประมวลผล Spark ที่เผยแพร่แล้วเพื่อตรวจสอบว่าการกําหนดค่าการประมวลผลของ Spark ใดที่มีประสิทธิภาพในปัจจุบัน

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

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

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

    {
  "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 สลับไปยังพูลอื่น ปรับแต่งการกําหนดค่าการประมวลผล และเพิ่มหรือลบคุณสมบัติ Spark ผ่านการแก้ไขเนื้อหาคําขอของ API นี้

คุณสามารถสลับกลุ่มที่แนบมาโดยการระบุชื่อกลุ่มและกลุ่ม ระบุชื่อพูลเป็น Starter Pool เพื่อสลับพูลไปเป็นการตั้งค่าเริ่มต้น หากต้องการรับรายการทั้งหมดของพูลแบบกําหนดเองที่พร้อมใช้งานของพื้นที่ทํางานโดย REST API โปรดดู พูลแบบกําหนดเอง - แสดงรายการพูลแบบกําหนดเองของพื้นที่ทํางาน

ถ้าคุณต้องการลบคุณสมบัติ Spark ที่มีอยู่ ให้ระบุค่าเหมือนกับ null คีย์ที่คุณต้องการลบ

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

    PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

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

ทําให้การเปลี่ยนแปลงมีผลบังคับใช้

ใช้ 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?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

ทริกเกอร์การดําเนินการเผยแพร่ของสภาพแวดล้อม

การเปลี่ยนแปลงที่คุณทําสําหรับไลบรารีการจัดเตรียมและการประมวลผล Spark จะถูกแคชไว้ แต่จําเป็นต้องมีการเผยแพร่เพื่อให้มีผล ใช้ตัวอย่างถัดไปเพื่อทริกเกอร์การดําเนินการเผยแพร่ การตอบสนองเป็นไปตามรูปแบบ การดําเนินการที่ยาวนาน (LRO) และรหัสการตอบสนอง HTTP 202 อาจถูกส่งกลับ

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

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

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

    Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

ในระหว่างการดําเนินการเผยแพร่ คุณยังสามารถเรียกใช้ API ต่อไปนี้เพื่อยกเลิกได้

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

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

เนื้อหาที่เกี่ยวข้อง

  • Last updated on