Git - Commit To Git

บริการ:: Core

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

ยอมรับการเปลี่ยนแปลงที่ทําในพื้นที่ทํางานไปยังสาขาระยะไกลที่เชื่อมต่อกัน
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

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

คุณสามารถเลือกที่จะบันทึกการเปลี่ยนแปลงทั้งหมด รายการที่ระบุ หรือแฟ้มที่ระบุภายในรายการโดยใช้โหมด FileLevelSelective เมื่อต้องการซิงค์พื้นที่ทํางานเป็นครั้งแรก ใช้ API นี้หลังจาก เชื่อมต่อ และ เริ่มต้นการเชื่อมต่อ API

สิทธิ์

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

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

Workspace.GitCommit.All

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

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

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

อิน เทอร์ เฟซ

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

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน

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

ชื่อ	จำเป็น	พิมพ์	คำอธิบาย
mode	True	CommitMode	โหมดสําหรับการดําเนินการยอมรับ
comment		string maxLength: 300	ข้อคิดเห็นที่ไม่มีผู้เรียกสําหรับยอมรับนี้ ความยาวสูงสุดคือ 300 อักขระ ถ้าผู้โทรไม่แสดงข้อคิดเห็น ให้ใช้ข้อคิดเห็นของผู้ให้บริการ Git เริ่มต้น
items		ItemIdentifier[]	รายการเฉพาะที่จะยอมรับ การดําเนินการนี้จะเกี่ยวข้องกับโหมดการยอมรับแบบเลือกเท่านั้น รายการที่มีร่วมกันแบบพิเศษกับรายการ WithFileSelection สามารถเรียกใช้รายการได้จาก API สถานะ Git
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	รายการที่มีการเลือกแต่ละไฟล์สําหรับโหมดการยอมรับ FileLevelSelective มีรายการที่เป็นเอกสิทธิ์เฉพาะร่วมกัน แต่ละรายการระบุหน่วยข้อมูลและเป็นรายการเส้นทางไฟล์ที่จะบันทึก (เป็นทางเลือก) ถ้า selectedFiles เป็น null หรือว่างเปล่าสําหรับหน่วยข้อมูล ไฟล์ทั้งหมดสําหรับรายการนั้นจะถูกบันทึกไว้
workspaceHead		string	SHA แฮชเต็มรูปแบบที่พื้นที่ทํางานถูกซิงค์ด้วย แฮชสามารถเรียกใช้ได้จาก API สถานะ Git

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
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 - การดําเนินการก่อนหน้ายังคงอยู่ระหว่างดําเนินการ ไม่เพียงพอ Privileges - ผู้เรียกไม่มีสิทธิ์พื้นที่ทํางานเพียงพอ PrincipalTypeNotSupported - ไม่สนับสนุนชนิดข้อมูลประจําตัวของผู้เรียก

ตัวอย่าง

Commit all to Git example

Commit file-level selective to Git example

Commit selective items to Git example

Commit all to Git example

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

HTTP

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

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

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

รหัสสถานะ:: 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

Commit file-level selective to Git example

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

HTTP

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

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

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

รหัสสถานะ:: 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

Commit selective items to Git example

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

HTTP

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

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

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

รหัสสถานะ:: 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

คำจำกัดความ

ชื่อ	คำอธิบาย
CommitMode	โหมดสําหรับการดําเนินการยอมรับ โหมดเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
CommitToGitRequest	ประกอบด้วยคําขอยอมรับ
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
ItemIdentifier	ประกอบด้วยตัวระบุรายการ ต้องกําหนดคุณสมบัติอย่างน้อยหนึ่งอย่าง
ItemIdentifierWithFileSelection	ประกอบด้วยตัวระบุรายการที่มีการเลือกระดับไฟล์ทางเลือกสําหรับการดําเนินการยืนยัน

CommitMode

การแจงนับ

โหมดสําหรับการดําเนินการยอมรับ โหมดเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
All	ยอมรับการเปลี่ยนแปลงที่ยังไม่ได้ผูกมัดทั้งหมด ผู้เรียกไม่จําเป็นต้องแสดงรายการที่จะยอมรับ
Selective	บันทึกรายการที่ระบุของรายการที่มีการเปลี่ยนแปลงที่ยังไม่ได้ผูกมัด ใช้คุณสมบัติ `items` เพื่อระบุรายการ
FileLevelSelective	ยอมรับแฟ้มที่ระบุภายในรายการที่ระบุ `itemsWithFileSelection`ใช้คุณสมบัติ เพื่อระบุรายการและแฟ้ม

CommitToGitRequest

วัตถุ

ประกอบด้วยคําขอยอมรับ

ชื่อ	พิมพ์	คำอธิบาย
comment	string maxLength: 300	ข้อคิดเห็นที่ไม่มีผู้เรียกสําหรับยอมรับนี้ ความยาวสูงสุดคือ 300 อักขระ ถ้าผู้โทรไม่แสดงข้อคิดเห็น ให้ใช้ข้อคิดเห็นของผู้ให้บริการ Git เริ่มต้น
items	ItemIdentifier[]	รายการเฉพาะที่จะยอมรับ การดําเนินการนี้จะเกี่ยวข้องกับโหมดการยอมรับแบบเลือกเท่านั้น รายการที่มีร่วมกันแบบพิเศษกับรายการ WithFileSelection สามารถเรียกใช้รายการได้จาก API สถานะ Git
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	รายการที่มีการเลือกแต่ละไฟล์สําหรับโหมดการยอมรับ FileLevelSelective มีรายการที่เป็นเอกสิทธิ์เฉพาะร่วมกัน แต่ละรายการระบุหน่วยข้อมูลและเป็นรายการเส้นทางไฟล์ที่จะบันทึก (เป็นทางเลือก) ถ้า selectedFiles เป็น null หรือว่างเปล่าสําหรับหน่วยข้อมูล ไฟล์ทั้งหมดสําหรับรายการนั้นจะถูกบันทึกไว้
mode	CommitMode	โหมดสําหรับการดําเนินการยอมรับ
workspaceHead	string	SHA แฮชเต็มรูปแบบที่พื้นที่ทํางานถูกซิงค์ด้วย แฮชสามารถเรียกใช้ได้จาก API สถานะ Git

ErrorRelatedResource

วัตถุ

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

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

ErrorResponse

วัตถุ

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

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

ErrorResponseDetails

วัตถุ

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

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

ItemIdentifier

วัตถุ

ประกอบด้วยตัวระบุรายการ ต้องกําหนดคุณสมบัติอย่างน้อยหนึ่งอย่าง

ชื่อ	พิมพ์	คำอธิบาย
logicalId	string (uuid)	ID เชิงตรรกะของสินค้า เมื่อ ID เชิงตรรกะไม่พร้อมใช้งานเนื่องจากรายการยังไม่ได้เพิ่มไปยังพื้นที่ทํางาน คุณสามารถใช้ ID ออบเจ็กต์ได้
objectId	string (uuid)	ID ออปเจ็กต์ของรายการ เมื่อ ID ออบเจ็กต์ไม่พร้อมใช้งานเนื่องจากรายการถูกลบจากพื้นที่ทํางาน คุณสามารถใช้ ID เชิงตรรกะได้

ItemIdentifierWithFileSelection

วัตถุ

ประกอบด้วยตัวระบุรายการที่มีการเลือกระดับไฟล์ทางเลือกสําหรับการดําเนินการยืนยัน

ชื่อ	พิมพ์	คำอธิบาย
logicalId	string (uuid)	ID เชิงตรรกะของสินค้า เมื่อ ID เชิงตรรกะไม่พร้อมใช้งานเนื่องจากรายการยังไม่ได้เพิ่มไปยังพื้นที่ทํางาน คุณสามารถใช้ ID ออบเจ็กต์ได้
objectId	string (uuid)	ID ออปเจ็กต์ของรายการ เมื่อ ID ออบเจ็กต์ไม่พร้อมใช้งานเนื่องจากรายการถูกลบจากพื้นที่ทํางาน คุณสามารถใช้ ID เชิงตรรกะได้
selectedFiles	string[]	เส้นทางของไฟล์ที่จะบันทึก ซึ่งสัมพันธ์กับรูทรายการ เส้นทางใช้เครื่องหมายทับไปข้างหน้าเท่านั้น ไม่มีเครื่องหมายทับนําหน้า เส้นทางไฟล์แบบเต็มเท่านั้น (ไม่มีไดเรกทอรีหรืออักขระตัวแทน) ไม่มีส่วนที่ว่างเปล่าหรือช่องว่างเท่านั้น และเซกเมนต์จะไม่สามารถลงท้ายด้วยจุดหรือช่องว่างต่อท้ายได้ ถ้าเป็น null หรือว่างเปล่า ไฟล์ทั้งหมดสําหรับรายการนี้จะถูกบันทึกไว้