Git - Get Connection

บริการ:

Core

เวอร์ชัน API:

v1

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

สิทธิ์

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

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

Workspace.Read.All หรือ Workspace.ReadWrite.All

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

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

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

อิน เทอร์ เฟซ

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

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

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

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	GitConnection	คําขอเสร็จสมบูรณ์
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด ไม่เพียงพอ Privileges - ผู้เรียกไม่มีสิทธิ์พื้นที่ทํางานเพียงพอ

ตัวอย่าง

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

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

รหัสสถานะ:

200

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

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

รหัสสถานะ:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

คำจำกัดความ

ชื่อ	คำอธิบาย
AzureDevOpsDetails	รายละเอียดผู้ให้บริการ Azure DevOps
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
GitConnection	ประกอบด้วยรายละเอียดการเชื่อมต่อ Git
GitConnectionState	สถานะการเชื่อมต่อ Git คุณสามารถเพิ่มชนิดสถานะการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป
GitHubDetails	รายละเอียดผู้ให้บริการ GitHub
GitProviderType	ชนิดผู้ให้บริการ Git ชนิดตัวให้บริการเพิ่มเติมอาจถูกเพิ่มเมื่อเวลาผ่านไป
GitSyncDetails	ประกอบด้วยรายละเอียดการซิงค์

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 อักขระ

ErrorRelatedResource

ออบเจ็กต์

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

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

ErrorResponse

ออบเจ็กต์

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

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

ErrorResponseDetails

ออบเจ็กต์

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

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

GitConnection

ออบเจ็กต์

ประกอบด้วยรายละเอียดการเชื่อมต่อ Git

ชื่อ	พิมพ์	คำอธิบาย
gitConnectionState	GitConnectionState	สถานะการเชื่อมต่อ Git คุณสามารถเพิ่มชนิดสถานะการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	รายละเอียดผู้ให้บริการ Git
gitSyncDetails	GitSyncDetails	ประกอบด้วยรายละเอียดการซิงค์

GitConnectionState

การแจงนับ

สถานะการเชื่อมต่อ Git คุณสามารถเพิ่มชนิดสถานะการเชื่อมต่อเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
NotConnected	ไม่ได้เชื่อมต่อสถานะ
Connected	สถานะที่เชื่อมต่อแล้ว
ConnectedAndInitialized	สถานะเชื่อมต่อและเตรียมใช้งาน

GitHubDetails

ออบเจ็กต์

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

ชื่อ	พิมพ์	คำอธิบาย
branchName	string maxLength: 250	ชื่อสาขา ความยาวสูงสุดคือ 250 อักขระ
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

GitSyncDetails

ออบเจ็กต์

ประกอบด้วยรายละเอียดการซิงค์

ชื่อ	พิมพ์	คำอธิบาย
head	string	อัลกอริทึมแฮชที่ปลอดภัยฉบับเต็ม 1 (SHA-1) ของ ID การยอมรับที่ซิงค์อยู่
lastSyncTime	string (date-time)	วันที่และเวลาของสถานะการซิงค์ครั้งล่าสุด