Git - Update Connection Settings

服务:

Core

API 版本:

v1

Note

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

更新已连接 Git 的工作区的连接设置。 仅更新请求正文中包含的属性;省略的属性保持不变。

Permissions

调用方必须具有工作区的 管理员 角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connectionSettings

URI 参数

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

请求正文

名称	类型	说明
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	允许更改连接的 Git 分支的管理员以外的其他工作区角色。

响应

名称	类型	说明
200 OK	GitConnectionSettings	请求成功完成。
429 Too Many Requests	ErrorResponse	超出服务速率限制。 服务器返回一个 Retry-After 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。 标头 Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。 InsufficientPrivileges - 调用方没有工作区的管理员角色。 WorkspaceNotConnectedToGit - 工作区未连接到 git。

示例

Update connection settings example

示例请求

HTTP

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

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

示例响应

状态代码:

200

{
  "additionalRolesAuthorizedToChangeBranch": "MemberAndContributor"
}

定义

名称	说明
ErrorParameter	一个结构化参数，提供有关错误的附加计算机可读上下文。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GitAdditionalBranchChangingRoles	允许更改连接的 Git 分支的管理员以外的其他工作区角色。 可能会随着时间的推移添加其他值。
GitConnectionSettings	包含 Git 连接设置。
UpdateGitConnectionSettingsRequest	包含用于更新 Git 连接设置的请求数据。

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	与错误相关的资源详细信息。

GitAdditionalBranchChangingRoles

枚举

允许更改连接的 Git 分支的管理员以外的其他工作区角色。 可能会随着时间的推移添加其他值。

值	说明
None	除了管理员之外，没有其他角色可以更改分支。 这是默认值。
MemberAndContributor	除了管理员之外，成员和参与者还可以更改分支。

GitConnectionSettings

对象

包含 Git 连接设置。

名称	类型	说明
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	允许更改连接的 Git 分支的管理员以外的其他工作区角色。

UpdateGitConnectionSettingsRequest

对象

包含用于更新 Git 连接设置的请求数据。

名称	类型	说明
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	允许更改连接的 Git 分支的管理员以外的其他工作区角色。