แชร์ผ่าน

Git - Connect

บริการ:
Core
เวอร์ชัน API:
v1

เชื่อมต่อพื้นที่ทํางานเฉพาะกับที่เก็บข้อมูล git และสาขา
การดําเนินการนี้ไม่ซิงค์ระหว่างพื้นที่ทํางานและสาขาที่เชื่อมต่อกัน เมื่อต้องการทําการซิงค์ให้เสร็จสมบูรณ์ ให้ใช้การดําเนินการเชื่อมต่อเริ่มต้น และทําตามอย่างใดอย่างหนึ่งการยอมรับไปยัง Git หรือการดําเนินการอัปเดตจาก Git

หากต้องการเริ่มต้นใช้งาน GitHub โปรดดู: เริ่มต้นใช้งานการรวม Git

หากต้องการรับ ID การเชื่อมต่อ โปรดดู การรวม Git อัตโนมัติ

สิทธิ์

ผู้เรียกต้องมีบทบาท ผู้ดูแลระบบ สําหรับพื้นที่ทํางาน

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

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

Workspace.ReadWrite.All

Limitations

เมื่อใช้แหล่งข้อมูลประจําตัวอัตโนมัติ API นี้จะถูกบล็อกสําหรับผู้ให้บริการ GitHub และสําหรับบริการหลัก

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

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

เอกลักษณ์ สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ได้รับการสนับสนุนเฉพาะเมื่อ myGitCredentials.source ถูกกําหนดค่า Connection

อิน เทอร์ เฟซ

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

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

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

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

ชื่อ จำเป็น พิมพ์ คำอธิบาย
gitProviderDetails True GitProviderDetails:

รายละเอียดผู้ให้บริการ Git
myGitCredentials GitCredentials:

ข้อมูลประจําตัว Git เฉพาะผู้ใช้สําหรับการรับรองความถูกต้องไปยัง GitProvider ข้อมูลประจําตัวเหล่านี้จะไม่แชร์กับผู้สนับสนุนพื้นที่ทํางานอื่น ๆ สําหรับ GitHub คุณสมบัตินี้จําเป็น สําหรับ AzureDevOps คุณสมบัตินี้เป็นทางเลือก ถ้าไม่ได้ตั้งค่า ค่าเริ่มต้นคือ AutomaticGitCredentials

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

คําขอเสร็จสมบูรณ์
Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • UnknownError - เกิดข้อผิดพลาด

  • WorkspaceAlreadyConnectedToGit - พื้นที่ทํางานเชื่อมต่อกับ git แล้ว

  • WorkspaceHasNoCapacityAssigned - ไม่ได้กําหนดความจุให้กับพื้นที่ทํางาน

  • ไม่เพียงพอ Privileges - ผู้เรียกมีสิทธิ์พื้นที่ทํางานไม่เพียงพอ

  • PrincipalTypeNotSupported - ไม่สนับสนุนชนิดข้อมูลประจําตัวของผู้เรียก

ตัวอย่าง

Connect a workspace to Azure DevOps example
Connect a workspace to Azure DevOps using configured connection example
Connect a workspace to GitHub example
Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

Connect a workspace to Azure DevOps example

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

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory"
  }
}

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

รหัสสถานะ:
200

Connect a workspace to Azure DevOps using configured connection example

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

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

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

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

รหัสสถานะ:
200

Connect a workspace to GitHub example

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

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

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

รหัสสถานะ:
200

Connect a workspace to GitHub example - GitHub Enterprise With Data Residency (ghe.com)

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

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

{
  "gitProviderDetails": {
    "ownerName": "Test Owner",
    "customDomainName": "my-enterprise.ghe.com",
    "gitProviderType": "GitHub",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": "Test Directory/Test Subdirectory"
  },
  "myGitCredentials": {
    "source": "ConfiguredConnection",
    "connectionId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
}

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

รหัสสถานะ:
200

คำจำกัดความ

ชื่อ คำอธิบาย
AutomaticGitCredentials

ข้อมูลประจําตัว Git อัตโนมัติ
AzureDevOpsDetails

รายละเอียดผู้ให้บริการ Azure DevOps
ConfiguredConnectionGitCredentials

กําหนดค่าการเชื่อมต่อข้อมูลประจําตัว Git
ErrorRelatedResource

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

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

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

ประกอบด้วยข้อมูลคําขอเชื่อมต่อของ Git
GitCredentialsSource

แหล่งข้อมูลข้อมูลประจําตัว Git แหล่งข้อมูล Git เพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป
GitHubDetails

รายละเอียดผู้ให้บริการ GitHub
GitProviderType

ชนิดผู้ให้บริการ Git ชนิดตัวให้บริการเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป

AutomaticGitCredentials

วัตถุ

ข้อมูลประจําตัว Git อัตโนมัติ

ชื่อ พิมพ์ คำอธิบาย
source string:

Automatic

แหล่งข้อมูลข้อมูลประจําตัว Git

AzureDevOpsDetails

วัตถุ

รายละเอียดผู้ให้บริการ Azure DevOps

ชื่อ พิมพ์ คำอธิบาย
branchName

string

maxLength: 250

ชื่อสาขา ความยาวสูงสุดคือ 250 อักขระ
directoryName

string

maxLength: 256

เส้นทางสัมพัทธ์ไปยังไดเรกทอรี ความยาวสูงสุดคือ 256 อักขระ
gitProviderType string:

AzureDevOps

ชนิดผู้ให้บริการ Git ชนิดตัวให้บริการเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป
organizationName

string

maxLength: 100

ชื่อองค์กร ความยาวสูงสุดคือ 100 อักขระ
projectName

string

maxLength: 100

ชื่อโครงการ ความยาวสูงสุดคือ 100 อักขระ
repositoryName

string

maxLength: 128

ชื่อที่เก็บ ความยาวสูงสุดคือ 128 อักขระ

ConfiguredConnectionGitCredentials

วัตถุ

กําหนดค่าการเชื่อมต่อข้อมูลประจําตัว Git

ชื่อ พิมพ์ คำอธิบาย
connectionId

string (uuid)

ID ออปเจ็กต์ของการเชื่อมต่อ
source string:

ConfiguredConnection

แหล่งข้อมูลข้อมูลประจําตัว Git

ErrorRelatedResource

วัตถุ

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

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

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

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

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

GitConnectRequest

วัตถุ

ประกอบด้วยข้อมูลคําขอเชื่อมต่อของ Git

ชื่อ พิมพ์ คำอธิบาย
gitProviderDetails GitProviderDetails:

รายละเอียดผู้ให้บริการ Git
myGitCredentials GitCredentials:

ข้อมูลประจําตัว Git เฉพาะผู้ใช้สําหรับการรับรองความถูกต้องไปยัง GitProvider ข้อมูลประจําตัวเหล่านี้จะไม่แชร์กับผู้สนับสนุนพื้นที่ทํางานอื่น ๆ สําหรับ GitHub คุณสมบัตินี้จําเป็น สําหรับ AzureDevOps คุณสมบัตินี้เป็นทางเลือก ถ้าไม่ได้ตั้งค่า ค่าเริ่มต้นคือ AutomaticGitCredentials

GitCredentialsSource

การแจงนับ

แหล่งข้อมูลข้อมูลประจําตัว Git แหล่งข้อมูล Git เพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
ConfiguredConnection

ได้รับข้อมูลประจําตัว Git ผ่านการเชื่อมต่อที่กําหนดค่าไว้
Automatic

ระบบได้รับข้อมูลประจําตัว Git โดยอัตโนมัติ โดยใช้ข้อมูลประจําตัวเริ่มต้นถ้ามี
None

ไม่ได้กําหนดค่าข้อมูลประจําตัว Git

GitHubDetails

วัตถุ

รายละเอียดผู้ให้บริการ GitHub

ชื่อ พิมพ์ คำอธิบาย
branchName

string

maxLength: 250

ชื่อสาขา ความยาวสูงสุดคือ 250 อักขระ
customDomainName

string

maxLength: 100

Note

การสนับสนุนสําหรับ GitHub Enterprise ที่มีที่เก็บข้อมูล (ghe.com) อยู่ในตัวอย่าง (เรียนรู้เพิ่มเติม)

ชื่อของโดเมน github ขององค์กรถ้าไม่ใช่ github.com GitHub Enterprise ที่มีโดเมนที่อยู่ข้อมูล (ghe.com) เท่านั้นที่ได้รับการสนับสนุน ความยาวสูงสุดคือ 100 อักขระ
directoryName

string

maxLength: 256

เส้นทางสัมพัทธ์ไปยังไดเรกทอรี ความยาวสูงสุดคือ 256 อักขระ
gitProviderType string:

GitHub

ชนิดผู้ให้บริการ Git ชนิดตัวให้บริการเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป
ownerName

string

maxLength: 100

ชื่อเจ้าของ ความยาวสูงสุดคือ 100 อักขระ
repositoryName

string

maxLength: 128

ชื่อที่เก็บ ความยาวสูงสุดคือ 128 อักขระ

GitProviderType

การแจงนับ

ชนิดผู้ให้บริการ Git ชนิดตัวให้บริการเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
AzureDevOps

ผู้ให้บริการ Azure DevOps
GitHub

ผู้ให้บริการ GitHub