Git - Initialize Connection

服務:

Core

API 版本:

v1

初始化連線至 Git 之工作區的連線。
此 API 支援 長時間執行的作業 （LRO）。

若要使用此 API，呼叫端的 Git 認證必須使用 更新我的 Git 認證 API 來設定。 您可以使用 取得我的 Git 認證 API 來檢查 Git 認證組態。

成功呼叫 Connect API 之後，應該呼叫此 API。 若要完成工作區的完整同步處理，請使用 必要的動作 作業來呼叫相關的同步作業，即 認可至 Git 或 從 Git 更新。

Permissions

呼叫端必須具有 系統管理員 工作區角色。

必要的委派範圍

Workspace.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity	Support
User	Yes
服務主體 和 受控識別	Yes

Interface

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

URI 參數

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

要求本文

名稱	類型	Description
initializationStrategy	InitializationStrategy	當內容同時存在於遠端和工作區端時，初始化程式所需的策略。 可能會隨著時間新增其他策略。

回應

名稱	類型	Description
200 OK	InitializeGitConnectionResponse	要求成功完成。
202 Accepted		要求已接受，初始化進行中的連線。 標題 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： WorkspaceNotConnectedToGit - 工作區未連線到 git。 WorkspaceHasNoCapacityAssigned - 沒有指派給 Workspace 的容量。 MissingInitializationPolicy - 遺漏初始化原則。 InsufficientPrivileges - 呼叫端在工作區上沒有足夠的許可權。 PrincipalTypeNotSupported - 不支援呼叫端身分識別類型。

範例

Initialize the connection of a workspace connected to a Git example

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "requiredAction": "UpdateFromGit",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}

狀態碼:

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

定義

名稱	Description
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
InitializationStrategy	當內容同時存在於遠端和工作區端時，初始化程式所需的策略。 可能會隨著時間新增其他策略。
InitializeGitConnectionRequest	包含初始化 Git 連線要求數據。
InitializeGitConnectionResponse	包含初始化 Git 連線回應數據。
RequiredAction	初始化程式完成之後的必要動作。 可能會隨著時間新增其他動作。

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	錯誤相關的資源詳細數據。

InitializationStrategy

列舉型別

當內容同時存在於遠端和工作區端時，初始化程式所需的策略。 可能會隨著時間新增其他策略。

值	Description
None	未定義任何策略。
PreferRemote	偏好遠端 Git 端內容。
PreferWorkspace	偏好工作區端內容。

InitializeGitConnectionRequest

Object

包含初始化 Git 連線要求數據。

名稱	類型	Description
initializationStrategy	InitializationStrategy	當內容同時存在於遠端和工作區端時，初始化程式所需的策略。 可能會隨著時間新增其他策略。

InitializeGitConnectionResponse

Object

包含初始化 Git 連線回應數據。

名稱	類型	Description
remoteCommitHash	string	遠端完整 SHA 認可哈希。
requiredAction	RequiredAction	初始化程式完成之後的必要動作。 可能會隨著時間新增其他動作。
workspaceHead	string	工作區同步處理的完整SHA哈希。

RequiredAction

列舉型別

初始化程式完成之後的必要動作。 可能會隨著時間新增其他動作。

值	Description
None	不需要採取任何動作。
UpdateFromGit	需要從 Git 更新。
CommitToGit	需要認可至 Git。