Git - Update From Git

服務:

Core

API 版本:

v1

使用推送至連線分支的認可來更新工作區。
此 API 支援 長時間執行的作業 （LRO）。

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

更新只會影響工作區中那些認可中已變更的專案。 如果在 Connect 和 Initialize Connection API 之後呼叫，則會執行整個工作區的完整更新。

權限

呼叫者必須具有 參與者 或更高的工作區角色。

必要的委派範圍

Workspace.GitUpdate.All

Microsoft Entra 支援的身分識別

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

身份	支援
使用者	是的
服務主體 和 受控識別	只有在作業中涉及的所有 專案 都支援服務主體時才支援

介面

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

URI 參數

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

要求本文

名稱	必要	類型	Description
remoteCommitHash	True	string	遠端完整 SHA 認可哈希。
conflictResolution		WorkspaceConflictResolution	從 Git 作業更新中使用的衝突解決方式。 如果項目發生衝突且未指定衝突解決，更新作業將不會啟動。
options		UpdateOptions	從 Git 作業更新中使用的選項
workspaceHead		string	工作區同步處理的完整SHA哈希。 只有在初始化連接之後，這個值才會是 Null。 在其他情況下，系統會驗證指定的值是否與系統已知的前端對齊。

回應

名稱	類型	Description
200 OK		要求成功完成。
202 Accepted		要求已接受，請從 Git 進行更新。 標題 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： WorkspaceNotConnectedToGit - 工作區未連線到 git。 WorkspaceHasNoCapacityAssigned - 沒有指派給工作區的容量。 WorkspaceHeadMismatch - 要求中的前端不符合系統中的前端。 WorkspacePreviousOperationInProgress - 先前的作業仍在進行中。 MissingDependency - 更新作業中遺漏相依性。 PotentialDuplicateDisplayNameAndType - 更新作業將會建立重複的顯示名稱和類型。 DependencyDeletionFailed - 更新作業將會刪除硬式相依性。 InsufficientPrivileges - 呼叫端沒有足夠的工作區許可權。 PrincipalTypeNotSupported - 不支援呼叫端身分識別類型。

範例

Update a workspace using data from a Git example

範例要求

HTTP

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

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

範例回覆

狀態碼:

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

定義

名稱	Description
ConflictResolutionPolicy	衝突解決原則。 可能會隨著時間新增其他衝突解決原則。
ConflictResolutionType	衝突解決類型。 可能會隨著時間新增其他衝突解決類型。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
UpdateFromGitRequest	包含 Git 要求數據的更新。
UpdateOptions	包含從 Git 啟用更新的選項。
WorkspaceConflictResolution	基本衝突解決數據。

ConflictResolutionPolicy

列舉型別

衝突解決原則。 可能會隨著時間新增其他衝突解決原則。

值	Description
PreferRemote	偏好遠端 Git 端內容。
PreferWorkspace	偏好工作區端內容。

ConflictResolutionType

列舉型別

衝突解決類型。 可能會隨著時間新增其他衝突解決類型。

值	Description
Workspace	代表工作區層級的衝突解決方式。

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

UpdateFromGitRequest

Object

包含 Git 要求數據的更新。

名稱	類型	Description
conflictResolution	WorkspaceConflictResolution	從 Git 作業更新中使用的衝突解決方式。 如果項目發生衝突且未指定衝突解決，更新作業將不會啟動。
options	UpdateOptions	從 Git 作業更新中使用的選項
remoteCommitHash	string	遠端完整 SHA 認可哈希。
workspaceHead	string	工作區同步處理的完整SHA哈希。 只有在初始化連接之後，這個值才會是 Null。 在其他情況下，系統會驗證指定的值是否與系統已知的前端對齊。

UpdateOptions

Object

包含從 Git 啟用更新的選項。

名稱	類型	Description
allowOverrideItems	boolean	使用者同意在 Git 程式更新期間覆寫傳入專案。 當傳入專案存在且未指定允許覆寫專案或提供為 false 時，更新作業將不會啟動。 預設值為 False。

WorkspaceConflictResolution

Object

基本衝突解決數據。

名稱	類型	Description
conflictResolutionPolicy	ConflictResolutionPolicy	衝突解決原則。 可能會隨著時間新增其他衝突解決原則。
conflictResolutionType	ConflictResolutionType	衝突解決類型。 可能會隨著時間新增其他衝突解決類型。