Git - Create Workspace Relation

服務:

Core

API 版本:

v1

建立指定工作區與相關工作區之間的工作區關係。

Note

此 API 是預覽版的一部分，僅供評估和開發之用。 它可能會根據意見反應而變更，不建議用於生產環境。

建立分支工作區與其基礎工作區之間的分支關係。

許可

呼叫者必須在分支工作區擁有 管理員 角色，並在基礎工作 區擁有貢獻 者或更高角色。

必要的委派範圍

Workspace.ReadWrite.All

Microsoft Entra 支援的身份識別

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

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

Interface

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

URI 參數

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

要求本文

名稱	必要	類型	Description
relatedWorkspaceId	True	string (uuid)	相關的工作區 ID。
relationType	True	WorkspaceRelationType	關聯中要建立的相關工作區類型。 只有 Base 和 Branch 才是創造時有效的。

回覆

名稱	類型	Description
201 Created	WorkspaceRelation	已成功建立。
429 Too Many Requests	ErrorResponse	服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。 標題 Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： InsufficientPrivileges - 呼叫端沒有足夠的工作區許可權。 WorkspaceNotFound - 指定的工作空間未被找到。 WorkspaceRelationAlalready Exists - 指定工作區之間已經存在關係。 工作區關係雙向存在 - 這些工作空間之間已經存在相反方向的關係。 WorkspaceRelationInvalidArgument - 為工作空間關係操作提供無效參數。 WorkspaceRelationInvalidType - 無效的工作區關係類型。 工作區關係自參照 - 工作區不能與自身相關聯。 WorkspaceRelationBaseIsBranch - 基礎工作區已經是另一個工作區的分支。 WorkspaceRelationTargetHasBranches - 目標工作區已經有分支工作區。 WorkspaceRelationDifferentBase - 目標工作區有不同的基礎工作區。 WorkspaceRelationRootDirectoryMismatch - 這些工作區不連接到同一個 Git 倉庫的根目錄。

範例

Create a workspace relation example

範例要求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations

{
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

範例回覆

狀態碼:

201

{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

定義

名稱	Description
CreateWorkspaceRelationRequest	建立工作空間關聯的請求有效載荷。
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應的細節。
WorkspaceRelation	一個工作空間關係物件。
WorkspaceRelationType	關聯中相關工作空間的類型。 隨著時間推移，可能會新增更多相關的工作區類型。

CreateWorkspaceRelationRequest

Object

建立工作空間關聯的請求有效載荷。

名稱	類型	Description
relatedWorkspaceId	string (uuid)	相關的工作區 ID。
relationType	WorkspaceRelationType	關聯中要建立的相關工作區類型。 只有 Base 和 Branch 才是創造時有效的。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱	類型	Description
message	string	一個人類可讀的參數意義描述。
name	string	參數識別碼。
value	string	這是參數值。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable	boolean	若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message	string	以人類可讀格式呈現的錯誤訊息。
moreDetails	ErrorResponseDetails[]	其他錯誤詳情的清單。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。
requestId	string (uuid)	與錯誤相關聯的要求識別碼。

ErrorResponseDetails

Object

錯誤回應的細節。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	以人類可讀格式呈現的錯誤訊息。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。

WorkspaceRelation

Object

一個工作空間關係物件。

名稱	類型	Description
id	string (uuid)	工作區關係 ID。
relatedWorkspaceId	string (uuid)	相關的工作區 ID。
relationType	WorkspaceRelationType	關聯中相關工作空間的類型。
workspaceId	string (uuid)	工作區識別碼。

WorkspaceRelationType

列舉型別

關聯中相關工作空間的類型。 隨著時間推移，可能會新增更多相關的工作區類型。

值	Description
Base	相關的工作區是基礎（來源）工作區。
Branch	相關的工作區是分支工作區。
RelatedWorkspace	相關的工作空間有一般的關聯。