ทําให้การปรับใช้อัตโนมัติด้วยแผนการปรับใช้ (ตัวอย่าง)

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

เลือกเวิร์กโฟลว์อัตโนมัติ

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

หากไม่มีแผนการปรับใช้ API แต่ละตัวก็ทํางานเหมือนเดิม

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

ข้อกําหนดเบื้องต้น

ก่อนที่คุณจะเพิ่มแผน:

• สร้างแผนการปรับใช้ ตรวจสอบให้แน่ใจว่าการดําเนินการสามารถแก้ไขปัญหาได้
• รับโทเค็นการเข้าถึง Microsoft Entra ใช้มันสําหรับ Fabric API
• ตรวจสอบให้แน่ใจว่าผู้โทรมีบทบาทที่จําเป็นตามการดําเนินการเดิม
• ตรวจสอบให้แน่ใจว่าโทเค็นมีขอบเขตของการดําเนินการเดิมและItem.Execute.All
• เพิ่ม beta=true ใน URL ของการดําเนินการ

โทเค็นต้องมีขอบเขตดังต่อไปนี้:

ผู้เรียกยังต้องการบทบาทที่ระบุไว้ใน API อ้างอิงต้นฉบับด้วย การอ้างอิงเดียวกันนี้แสดงประเภทตัวตนที่ API รองรับ Service Principal หรือ managed identity จะทํางานได้ก็ต่อเมื่อทุกรายการในการดําเนินการรองรับ

เพิ่มแผนการปรับใช้ลงในคําขอ

สําหรับ API ที่รองรับแต่ละตัว:

1. เพิ่ม beta=true ใน URL ของคําขอ
2. เพิ่มdeploymentPlanวัตถุภายในวัตถุที่มีอยู่options
3. เก็บส่วนที่เหลือของคําขอไว้เหมือนเดิม

ใช้คุณสมบัติตัวพิมพ์ referenceType เล็ก ค่าของมันขึ้นอยู่กับตัวพิมพ์ใหญ่-เล็ก

อัปเดตพื้นที่ทํางานจาก Git

ใช้รหัสตรรกะของแผน แผนงานอาจมาจากพื้นที่ทํางานหรือเนื้อหา Git ที่เข้ามา สําหรับแผนที่เก็บไว้ใน Git ให้ค้นหา Logical ID ในไฟล์ของแผนนั้น.platform

สําหรับการซิงค์เบื้องต้นที่ขับเคลื่อนด้วย API ให้เรียกใช้ Initialize Connection ก่อน หากการตอบกลับต้องการการอัปเดต ให้เพิ่มแผนนี้ลงในคําขอ Update From Git ต่อไปนี้ Initialize Connection ไม่ยอมรับแผนการปรับใช้

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit?beta=true

เพิ่มวัตถุต่อไปนี้ในคําขอ Update From Git:

{
  "options": {
    "deploymentPlan": {
      "logicalId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByLogicalId"
    }
  }
}

เก็บ workspaceHead, remoteCommitHash, การแก้ไขความขัดแย้ง และตัวเลือกอื่น ๆ ไว้ สร้างคําขอทั้งหมดโดยใช้คู่มืออัตโนมัติของ Git คู่มือยังแสดงวิธีตรวจสอบสถานะการดําเนินงานด้วย ดูที่ อัปเดตจาก Git

ปรับใช้เนื้อหาระหว่างขั้นตอนของกระบวนการ

อ้างอิงแผนการปรับใช้โดยใช้รหัสรายการ

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/deploy?beta=true

เพิ่มวัตถุต่อไปนี้ในคําขอเนื้อหา Deploy Stage:

{
  "options": {
    "deploymentPlan": {
      "itemId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByItemId"
    }
  }
}

เก็บขั้นตอนต้นทาง ขั้นตอนเป้าหมาย รายการที่เลือก บันทึกการปรับใช้ และตัวเลือกอื่น ๆ ไว้ สร้างคําขอทั้งหมดโดยใช้คู่มือ deployment pipeline คู่มือยังแสดงวิธีตรวจสอบสถานะการดําเนินงานด้วย ดูที่ อัตโนมัติกระบวนการปรับใช้ของคุณด้วย Fabric APIs

นําเข้าคํานิยามรายการ

ใช้รหัสตรรกะของแผน หามันได้ในแฟ้มแผน.platform

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/bulkImportDefinitions?beta=true

เพิ่มแผนการปรับใช้ในตัวเลือกคําขอนําเข้าจํานวนมาก:

{
  "options": {
    "allowPairingByName": false,
    "deploymentPlan": {
      "logicalId": "00000000-0000-0000-0000-000000000000",
      "referenceType": "ByLogicalId"
    }
  }
}

เก็บชิ้นส่วนนิยามรายการและตัวเลือกการนําเข้าทั้งหมดไว้ สร้างคําขอเต็มรูปแบบโดยใช้บทเรียน Bulk Import บทเรียนยังแสดงวิธีตรวจสอบสถานะการทํางานด้วย ดู Fabric CI/CD พร้อม API นิยามรายการนําเข้าจํานวนมาก

เข้าใจว่าแผนเปลี่ยนแปลงอะไรบ้าง

แผนจะเปลี่ยนแค่ลําดับและการกระทําเท่านั้น มันไม่เปลี่ยนแปลงรายการที่เลือก

รายการที่เลือกนอกกลุ่มการปรับใช้จะใช้พฤติกรรมมาตรฐานของการดําเนินการ

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

ตรวจสอบคําขอ

ก่อนที่คุณจะเรียกใช้ระบบอัตโนมัติ โปรดตรวจสอบว่า:

• URL ประกอบด้วย beta=true.
• โทเค็นนี้รวมถึง Item.Execute.All ขอบเขตของการดําเนินการเดิม
• วัตถุอยู่ deploymentPlan ภายใน optionsไม่ใช่ที่ root ของคําขอ
• referenceType ใช้ค่าที่ระบุและตัวอักษร
• รหัสรายการหรือรหัสตรรกะไม่ได้ว่างเปล่าหรือผิดรูปแบบ
• การดําเนินการนี้สามารถแก้ไขแผนงานในพื้นที่ทํางานที่เกี่ยวข้องหรือเนื้อหาที่เข้ามาได้
• คําจํากัดความของแผนงานนี้ถูกต้องและไม่มีการพึ่งพาแบบวนซ้ํา

การดําเนินการจะหยุดเมื่อการตรวจสอบความถูกต้อง รายการ หรือการดําเนินการล้มเหลว Fabric ไม่ย้อนงานที่ทําเสร็จแล้ว

ข้อควรพิจารณาและข้อจำกัด

ไลบรารีไม่ fabric-cicd รองรับแผนการนําไปใช้งาน ใช้ Update From Git, Deploy Stage Content หรือ Bulk Import Item Definitions เมื่อคุณทําให้การปรับใช้อัตโนมัติด้วยแผนงาน

สําหรับข้อจํากัดทั้งหมดของแผนการปรับใช้ โปรดดูที่ข้อพิจารณาและข้อจํากัดของแผนการปรับใช้

จัดการรายการแผนการปรับใช้

แผนการปรับใช้คือไอเท็ม Fabric ใช้ Fabric REST API ต่อไปนี้เพื่อจัดการ การเรียกใช้งานเหล่านี้แยกออกจากการดําเนินการปรับใช้

การกําหนดแผนการปรับใช้ประกอบด้วยชิ้นส่วนที่มีเส้นทาง, ภาระ Base64 และ InlineBase64 ประเภทภาระ

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

• แผนการปฏิบัติงานคืออะไร?
• แนบแผนการปรับใช้
• สร้างแผนการปรับใช้
• การดําเนินการแผนการนําไปใช้งาน
• สิทธิ์แผนการปรับใช้
• แก้ไขปัญหาแผนการปรับใช้
• ทําให้การรวม Git เป็นแบบอัตโนมัติโดยใช้ API
• ทําให้กระบวนการติดตั้งของคุณเป็นอัตโนมัติด้วย Fabric APIs
• Fabric CI/CD พร้อม API การกําหนดรายการนําเข้าจํานวนมาก