Git - Create Workspace Relation

服务:

Core

API 版本:

v1

创建指定工作区与相关工作区之间的工作区关系。

注释

此 API 是预览版的一部分，仅用于评估和开发目的。 它可能会根据反馈进行更改，不建议将其用于生产。

在分支工作区与其基本工作区之间创建分支关系。

权限

调用方必须在分支工作区上具有 管理员 角色，并且具有基础工作区的 参与者 或更高角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	支持
User	是的
服务主体和托管标识	是的

Interface

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
relatedWorkspaceId	True	string (uuid)	相关的工作区 ID。
relationType	True	WorkspaceRelationType	在关系中创建的相关工作区的类型。 仅适用于 Base 创建并且 Branch 有效。

响应

名称	类型	说明
201 Created	WorkspaceRelation	已成功创建。
429 Too Many Requests	ErrorResponse	超出服务速率限制。 服务器返回一个 Retry-After 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。 标头 Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： InsufficientPrivileges - 调用方没有足够的工作区权限。 WorkspaceNotFound - 找不到指定的工作区。 WorkspaceRelationAlreadyExists - 指定的工作区之间的关系已存在。 WorkspaceRelationBidirectionalExists - 这些工作区之间的关系已相反。 WorkspaceRelationInvalidArgument - 为工作区关系操作提供的参数无效。 WorkspaceRelationInvalidType - 工作区关系类型无效。 WorkspaceRelationSelfReferencing - 工作区不能与自身相关。 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"
}

定义

名称	说明
CreateWorkspaceRelationRequest	用于创建工作区关系的请求有效负载。
ErrorParameter	一个结构化参数，提供有关错误的附加计算机可读上下文。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
WorkspaceRelation	工作区关系对象。
WorkspaceRelationType	关系中相关工作区的类型。 可能会随着时间的推移添加其他相关的工作区类型。

CreateWorkspaceRelationRequest

对象

用于创建工作区关系的请求有效负载。

名称	类型	说明
relatedWorkspaceId	string (uuid)	相关的工作区 ID。
relationType	WorkspaceRelationType	在关系中创建的相关工作区的类型。 仅适用于 Base 创建并且 Branch 有效。

ErrorParameter

对象

一个结构化参数，提供有关错误的附加计算机可读上下文。

名称	类型	说明
message	string	参数含义的可读说明。
name	string	参数标识符。
value	string	参数值。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
isRetriable	boolean	如果为 true，可以重试请求。 Retry-After使用响应标头确定延迟（如果可用）。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
parameters	ErrorParameter[]	提供有关错误的其他计算机可读上下文的结构化参数。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string (uuid)	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
parameters	ErrorParameter[]	提供有关错误的其他计算机可读上下文的结构化参数。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

WorkspaceRelation

对象

工作区关系对象。

名称	类型	说明
id	string (uuid)	工作区关系 ID。
relatedWorkspaceId	string (uuid)	相关的工作区 ID。
relationType	WorkspaceRelationType	关系中相关工作区的类型。
workspaceId	string (uuid)	工作区 ID。

WorkspaceRelationType

枚举

关系中相关工作区的类型。 可能会随着时间的推移添加其他相关的工作区类型。

值	说明
Base	相关工作区是基本工作区（源）工作区。
Branch	相关工作区是分支工作区。
RelatedWorkspace	相关工作区具有一般关系。