Git - Initialize Connection

服务:

Core

API 版本:

v1

初始化连接到 Git 的工作区的连接。
此 API 支持 长时间运行的作（LRO）。

若要使用此 API，必须使用 更新我的 Git 凭据 API 配置调用方 Git 凭据。 可以使用 “获取我的 Git 凭据 API”来检查 Git 凭据配置。

成功调用 Connect API 后，应调用此 API。 若要完成工作区的完全同步，请使用 “所需作 ”作调用相关的同步作，即 “提交到 Git ”或 “从 Git 更新”。

权限

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

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

身份	支持
用户	是的
服务主体 和 托管标识	仅当 Git 提供程序为 GitHub 时才受支持

接口

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

URI 参数

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

请求正文

名称	类型	说明
initializationStrategy	InitializationStrategy	当内容同时存在于远程端和工作区端时，初始化过程所需的策略。 可能会随着时间的推移添加其他策略。

响应

名称	类型	说明
200 OK	InitializeGitConnectionResponse	请求成功完成。
202 Accepted		请求已接受，正在初始化连接。 标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： WorkspaceNotConnectedToGit - 工作区未连接到 git。 WorkspaceHasNoCapacityAssigned - 没有分配给工作区的容量。 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

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
InitializationStrategy	当内容同时存在于远程端和工作区端时，初始化过程所需的策略。 可能会随着时间的推移添加其他策略。
InitializeGitConnectionRequest	包含初始化 Git 连接请求数据。
InitializeGitConnectionResponse	包含初始化 Git 连接响应数据。
RequiredAction	初始化过程完成后的必需作。 可能会随着时间的推移添加其他作。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

InitializationStrategy

枚举

当内容同时存在于远程端和工作区端时，初始化过程所需的策略。 可能会随着时间的推移添加其他策略。

值	说明
None	未定义任何策略。
PreferRemote	首选远程 Git 端内容。
PreferWorkspace	首选工作区端内容。

InitializeGitConnectionRequest

Object

包含初始化 Git 连接请求数据。

名称	类型	说明
initializationStrategy	InitializationStrategy	当内容同时存在于远程端和工作区端时，初始化过程所需的策略。 可能会随着时间的推移添加其他策略。

InitializeGitConnectionResponse

Object

包含初始化 Git 连接响应数据。

名称	类型	说明
remoteCommitHash	string	远程完整 SHA 提交哈希。
requiredAction	RequiredAction	初始化过程完成后的必需作。 可能会随着时间的推移添加其他作。
workspaceHead	string	工作区要同步到的完整 SHA 哈希。

RequiredAction

枚举

初始化过程完成后的必需作。 可能会随着时间的推移添加其他作。

值	说明
CommitToGit	需要提交到 Git。
None	无需执行任何操作。
UpdateFromGit	需要从 Git 进行更新。