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 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區標識碼。

回應

名稱	類型	Description
200 OK	GitConnection	要求成功完成。
Other Status Codes	ErrorResponse	常見的錯誤碼： UnknownError - 發生錯誤。 InsufficientPrivileges - 呼叫端沒有足夠的工作區許可權。

範例

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"
}

定義

名稱	Description
AzureDevOpsDetails	Azure DevOps 提供者詳細數據。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
GitConnection	包含 Git 連線詳細數據。
GitConnectionState	Git 連線狀態。 可能會隨著時間新增其他連線狀態類型。
GitHubDetails	GitHub 提供者詳細數據。
GitProviderType	Git 提供者類型。 可能會隨著時間新增其他提供者類型。
GitSyncDetails	包含同步詳細數據。

AzureDevOpsDetails

Object

Azure DevOps 提供者詳細數據。

名稱	類型	Description
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

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

GitConnection

Object

包含 Git 連線詳細數據。

名稱	類型	Description
gitConnectionState	GitConnectionState	Git 連線狀態。 可能會隨著時間新增其他連線狀態類型。
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Git 提供者詳細數據。
gitSyncDetails	GitSyncDetails	包含同步詳細數據。

GitConnectionState

列舉型別

Git 連線狀態。 可能會隨著時間新增其他連線狀態類型。

值	Description
Connected	線上狀態。
ConnectedAndInitialized	已連線和初始化的狀態。
NotConnected	未連線狀態。

GitHubDetails

Object

GitHub 提供者詳細數據。

名稱	類型	Description
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 提供者類型。 可能會隨著時間新增其他提供者類型。

值	Description
AzureDevOps	Azure DevOps 提供者
GitHub	GitHub 提供者

GitSyncDetails

Object

包含同步詳細數據。

名稱	類型	Description
head	string	已同步認可標識碼的完整安全哈希演算法 1 （SHA-1）。
lastSyncTime	string (date-time)	上次同步狀態的日期和時間。