Git - Update From Git

บริการ:: Core

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

อัปเดตพื้นที่ทํางานด้วยการยอมรับที่ส่งไปยังสาขาที่เชื่อมต่อกัน

Note

การสนับสนุนแผนการปรับใช้ใน API นี้เป็นส่วนหนึ่งของการเผยแพร่รุ่นเบต้า และมีไว้สําหรับการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต ฟังก์ชันการทํางานอื่นๆ ทั้งหมดของ API นี้จะพร้อมใช้งานโดยทั่วไปแล้ว หากต้องการใช้การสนับสนุนแผนการปรับใช้ ผู้โทรต้องระบุ true เป็นค่าสําหรับพารามิเตอร์ betaคิวรี

API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

เมื่อต้องการใช้ API นี้ ข้อมูลประจําตัว Git ของผู้เรียกต้องได้รับการกําหนดค่าโดยใช้ อัปเดตข้อมูลประจําตัว Git ของฉัน คุณสามารถใช้ API รับข้อมูลประจําตัว Git ของฉัน เพื่อตรวจสอบการกําหนดค่าข้อมูลประจําตัวของ Git ได้

การอัปเดตจะมีผลต่อรายการในพื้นที่ทํางานที่มีการเปลี่ยนแปลงในยอมรับเหล่านั้นเท่านั้น ถ้าถูกเรียกหลัง Connect และ Initialize Connection API การเชื่อมต่อจะดําเนินการอัปเดตทั้งหมดของพื้นที่ทํางานทั้งหมด

สิทธิ์

ผู้โทรต้องมีบทบาทผู้สนับสนุน หรือสูงกว่าในพื้นที่ทํางาน

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

Workspace.GitUpdate.All

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

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

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

อิน เทอร์ เฟซ

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

ด้วยพารามิเตอร์ที่เลือกได้:

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

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
beta	query		boolean	ตั้งค่าเป็น `true` เพื่อเปิดใช้งานฟังก์ชันเบต้า รวมถึงการสนับสนุนแผนการปรับใช้ เมื่อเว้นไว้หรือตั้งค่าเป็น `false`ฟังก์ชันที่พร้อมใช้งานโดยทั่วไปเท่านั้นจะสามารถเข้าถึงได้ และจะไม่มีการยอมรับอินพุตแผนการปรับใช้

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

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
remoteCommitHash	True	string	แฮชการยอมรับ SHA แบบเต็มระยะไกล
conflictResolution		WorkspaceConflictResolution	การแก้ปัญหาความขัดแย้งที่จะใช้ในการปรับปรุงจากการดําเนินการ Git หากหน่วยข้อมูลขัดแย้งกัน และไม่มีการระบุวิธีแก้ปัญหาข้อขัดแย้ง การดําเนินการปรับปรุงจะไม่เริ่มขึ้น
options		UpdateOptions	ตัวเลือกที่จะใช้ในการอัปเดตจากการดําเนินการ Git
workspaceHead		string	SHA แฮชเต็มรูปแบบที่พื้นที่ทํางานถูกซิงค์ด้วย ค่านี้อาจเป็น Null หลังจากกําหนดค่าเริ่มต้นการเชื่อมต่อแล้วเท่านั้น ในกรณีอื่น ๆ ระบบจะตรวจสอบว่าค่าที่กําหนดสอดคล้องกับหัวที่รู้จักกันในระบบ

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK		คําขอเสร็จสมบูรณ์
202 Accepted		ยอมรับคําขอ แล้วอัปเดตจาก Git ที่กําลังดําเนินการ ส่วนหัว Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: WorkspaceNotConnectedToGit - พื้นที่ทํางานไม่ได้เชื่อมต่อกับ git WorkspaceHasNoCapacityAssigned - ไม่ได้กําหนดความจุให้กับพื้นที่ทํางาน WorkspaceHeadMismatch - ส่วนหัวในคําขอไม่ตรงกับส่วนหัวในระบบ WorkspacePreviousOperationInProgress - การดําเนินการก่อนหน้ายังคงอยู่ระหว่างดําเนินการ การอ้างอิงหายไป - การขึ้นต่อกันขาดหายไปในการดําเนินการอัปเดต PotentialDuplicateDisplayNameAndType - การดําเนินการอัปเดตจะสร้างชื่อและชนิดที่แสดงที่ซ้ํากัน DependencyDeletionFailed - การดําเนินการอัปเดตจะลบการขึ้นต่อกันแบบยาก ไม่เพียงพอ Privileges - ผู้เรียกไม่มีสิทธิ์พื้นที่ทํางานเพียงพอ PrincipalTypeNotSupported - ไม่สนับสนุนชนิดข้อมูลประจําตัวของผู้เรียก

ตัวอย่าง

Update a workspace from Git with options example

Update a workspace using data from a Git example

Update a workspace using data from a Git with a deployment plan example

Update a workspace from Git with options example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

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

รหัสสถานะ:: 200

รหัสสถานะ:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Update a workspace using data from a Git example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

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

รหัสสถานะ:: 200

รหัสสถานะ:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Update a workspace using data from a Git with a deployment plan example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "deploymentPlan": {
      "referenceType": "ByLogicalId",
      "logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

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

รหัสสถานะ:: 200

รหัสสถานะ:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

คำจำกัดความ

ชื่อ	คำอธิบาย
ConflictResolutionPolicy	นโยบายการแก้ปัญหาความขัดแย้ง อาจมีการเพิ่มนโยบายการแก้ปัญหาข้อขัดแย้งเพิ่มเติมเมื่อเวลาผ่านไป
ConflictResolutionType	ชนิดการแก้ปัญหาความขัดแย้ง ชนิดการแก้ปัญหาข้อขัดแย้งเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
DeploymentPlanReferenceByItemId	การอ้างอิงแผนการปรับใช้ตามรหัสรายการ
DeploymentPlanReferenceByLogicalId	การอ้างอิงแผนการปรับใช้ตามรหัสตรรกะ
DeploymentPlanReferenceType	ชนิดการอ้างอิงแผนการปรับใช้ ประเภท `DeploymentPlanReferenceType` เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
ItemOptionsByLogicalIdEntry	รายการตัวเลือกต่อสินค้าที่กําหนดเป้าหมายสินค้าตาม ID เชิงตรรกะ แต่ละรายการที่กําหนดเป้าหมายอาจปรากฏขึ้นมากที่สุดหนึ่งครั้ง
UpdateFromGitRequest	ประกอบด้วยการอัปเดตจากข้อมูลคําขอ Git
UpdateOptions	ประกอบด้วยตัวเลือกที่เปิดใช้งานสําหรับการอัปเดตจาก Git
WorkspaceConflictResolution	ข้อมูลการแก้ปัญหาความขัดแย้งพื้นฐาน

ConflictResolutionPolicy

การแจงนับ

นโยบายการแก้ปัญหาความขัดแย้ง อาจมีการเพิ่มนโยบายการแก้ปัญหาข้อขัดแย้งเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
PreferRemote	ต้องการเนื้อหาด้าน Git ระยะไกล
PreferWorkspace	ต้องการเนื้อหาด้านพื้นที่ทํางานมากกว่า

ConflictResolutionType

การแจงนับ

ชนิดการแก้ปัญหาความขัดแย้ง ชนิดการแก้ปัญหาข้อขัดแย้งเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Workspace	การแก้ปัญหาความขัดแย้งที่แสดงถึงระดับพื้นที่ทํางาน

DeploymentPlanReferenceByItemId

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
itemId	string (uuid)	รหัสรายการของรายการแผนการปรับใช้
referenceType	string: ByItemId	ชนิดการอ้างอิงแผนการปรับใช้

DeploymentPlanReferenceByLogicalId

วัตถุ

การอ้างอิงแผนการปรับใช้ตามรหัสตรรกะ

ชื่อ	พิมพ์	คำอธิบาย
logicalId	string (uuid)	รหัสตรรกะของรายการแผนการปรับใช้
referenceType	string: ByLogicalId	ชนิดการอ้างอิงแผนการปรับใช้

DeploymentPlanReferenceType

การแจงนับ

ชนิดการอ้างอิงแผนการปรับใช้ ประเภท DeploymentPlanReferenceType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
ByItemId	แผนการปรับใช้ถูกอ้างอิงด้วย ID รายการ
ByLogicalId	แผนการปรับใช้ถูกอ้างอิงด้วย ID เชิงตรรกะ

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
message	string	คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name	string	ตัวระบุพารามิเตอร์
value	string	ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

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

ItemOptionsByLogicalIdEntry

วัตถุ

รายการตัวเลือกต่อสินค้าที่กําหนดเป้าหมายสินค้าตาม ID เชิงตรรกะ แต่ละรายการที่กําหนดเป้าหมายอาจปรากฏขึ้นมากที่สุดหนึ่งครั้ง

ชื่อ	พิมพ์	คำอธิบาย
logicalId	string (uuid)	ID เชิงตรรกะของรายการเป้าหมาย
options	object	ตัวเลือกสําหรับสินค้าที่กําหนดเป้าหมาย ชื่อคุณสมบัติเป็นชื่อตัวเลือกที่ถูกต้องสําหรับชนิดหน่วยข้อมูล ค่าเป็นค่าตัวเลือก สําหรับตัวเลือกที่ได้รับการสนับสนุนโดยประเภทรายการเฉพาะ โปรดดูเอกสารประกอบ API ของ `Update-Definition` ชนิดหน่วยข้อมูลนั้น

UpdateFromGitRequest

วัตถุ

ประกอบด้วยการอัปเดตจากข้อมูลคําขอ Git

ชื่อ	พิมพ์	คำอธิบาย
conflictResolution	WorkspaceConflictResolution	การแก้ปัญหาความขัดแย้งที่จะใช้ในการปรับปรุงจากการดําเนินการ Git หากหน่วยข้อมูลขัดแย้งกัน และไม่มีการระบุวิธีแก้ปัญหาข้อขัดแย้ง การดําเนินการปรับปรุงจะไม่เริ่มขึ้น
options	UpdateOptions	ตัวเลือกที่จะใช้ในการอัปเดตจากการดําเนินการ Git
remoteCommitHash	string	แฮชการยอมรับ SHA แบบเต็มระยะไกล
workspaceHead	string	SHA แฮชเต็มรูปแบบที่พื้นที่ทํางานถูกซิงค์ด้วย ค่านี้อาจเป็น Null หลังจากกําหนดค่าเริ่มต้นการเชื่อมต่อแล้วเท่านั้น ในกรณีอื่น ๆ ระบบจะตรวจสอบว่าค่าที่กําหนดสอดคล้องกับหัวที่รู้จักกันในระบบ

UpdateOptions

วัตถุ

ประกอบด้วยตัวเลือกที่เปิดใช้งานสําหรับการอัปเดตจาก Git

ชื่อ	พิมพ์	คำอธิบาย
allowOverrideItems	boolean	ความยินยอมของผู้ใช้ในการแทนที่รายการขาเข้าในระหว่างกระบวนการอัปเดตจากกระบวนการ Git เมื่อมีรายการขาเข้าและไม่มีการระบุรายการการแทนที่อนุญาตหรือระบุเป็นเท็จ การดําเนินการอัปเดตจะไม่เริ่มขึ้น ค่าเริ่มต้นเป็นเท็จ
deploymentPlan	DeploymentPlanReference: DeploymentPlanReferenceByItemId DeploymentPlanReferenceByLogicalId	การอ้างอิงไปยังรายการแผนการปรับใช้เพื่อปรับใช้ เมื่อระบุแล้ว แผนจะควบคุมการจัดลําดับการปรับใช้รายการและดําเนินการปรับใช้ก่อน/โพสต์ เมื่อไม่มีข้อมูลหรือเป็น null การดําเนินการจะทํางานเป็นวันนี้ ในปัจจุบัน รองรับเฉพาะชนิดการอ้างอิงเท่านั้น`ByLogicalId` การสนับสนุนแผนการปรับใช้อยู่ในรุ่นเบต้าในขณะนี้ คุณสมบัตินี้สามารถใช้ได้เฉพาะเมื่อมีการตั้งค่าพารามิเตอร์ `beta` คิวรีเป็น `true` และอาจเปลี่ยนแปลงตามคําติชม
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	ตัวเลือกการอัปเดตต่อรายการ รายการแต่ละรายการกําหนดเป้าหมายสินค้าตาม ID เชิงตรรกะและใช้ตัวเลือกกับสินค้านั้น

WorkspaceConflictResolution

วัตถุ

ข้อมูลการแก้ปัญหาความขัดแย้งพื้นฐาน

ชื่อ	พิมพ์	คำอธิบาย
conflictResolutionPolicy	ConflictResolutionPolicy	นโยบายการแก้ปัญหาความขัดแย้ง อาจมีการเพิ่มนโยบายการแก้ปัญหาข้อขัดแย้งเพิ่มเติมเมื่อเวลาผ่านไป
conflictResolutionType	ConflictResolutionType	ชนิดการแก้ปัญหาความขัดแย้ง ชนิดการแก้ปัญหาข้อขัดแย้งเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป