通过

Git - Get Connection

  • 参考
服务:
Core
API 版本:
v1

返回指定工作区的 git 连接详细信息。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connection

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

响应

名称 类型 说明
200 OK

GitConnection

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

  • InsufficientPrivileges - 调用方没有足够的工作区权限。

示例

Get Git connection details example
Workspace not connected to git example

Get Git connection details example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

示例响应

状态代码:
200 
{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

示例响应

状态代码:
200 
{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

定义

名称 说明
AzureDevOpsDetails

Azure DevOps 提供程序详细信息。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
GitConnection

包含 Git 连接详细信息。
GitConnectionState

Git 连接状态。 可能会随着时间的推移添加其他连接状态类型。
GitHubDetails

GitHub 提供程序详细信息。
GitProviderType

Git 提供程序类型。 可能会随着时间的推移添加其他提供程序类型。
GitSyncDetails

包含同步详细信息。

AzureDevOpsDetails

Object

Azure DevOps 提供程序详细信息。

名称 类型 说明
branchName

string

maxLength: 250

分支名称。 最大长度为 250 个字符。
directoryName

string

maxLength: 256

目录的相对路径。 最大长度为 256 个字符。
gitProviderType string:

AzureDevOps

Git 提供程序类型。 可能会随着时间的推移添加其他提供程序类型。
organizationName

string

maxLength: 100

组织名称。 最大长度为 100 个字符。
projectName

string

maxLength: 100

项目名称。 最大长度为 100 个字符。
repositoryName

string

maxLength: 128

存储库名称。 最大长度为 128 个字符。

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

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

GitConnection

Object

包含 Git 连接详细信息。

名称 类型 说明
gitConnectionState

GitConnectionState

Git 连接状态。 可能会随着时间的推移添加其他连接状态类型。
gitProviderDetails GitProviderDetails:

Git 提供程序详细信息。
gitSyncDetails

GitSyncDetails

包含同步详细信息。

GitConnectionState

枚举

Git 连接状态。 可能会随着时间的推移添加其他连接状态类型。

值 说明
Connected

已连接状态。
ConnectedAndInitialized

已连接和初始化状态。
NotConnected

未连接状态。

GitHubDetails

Object

GitHub 提供程序详细信息。

名称 类型 说明
branchName

string

maxLength: 250

分支名称。 最大长度为 250 个字符。
directoryName

string

maxLength: 256

目录的相对路径。 最大长度为 256 个字符。
gitProviderType string:

GitHub

Git 提供程序类型。 可能会随着时间的推移添加其他提供程序类型。
ownerName

string

maxLength: 100

所有者名称。 最大长度为 100 个字符。
repositoryName

string

maxLength: 128

存储库名称。 最大长度为 128 个字符。

GitProviderType

枚举

Git 提供程序类型。 可能会随着时间的推移添加其他提供程序类型。

值 说明
AzureDevOps

Azure DevOps 提供程序
GitHub

GitHub 提供程序

GitSyncDetails

Object

包含同步详细信息。

名称 类型 说明
head

string

同步提交 ID 的完整安全哈希算法 1（SHA-1）。
lastSyncTime

string (date-time)

上次同步状态的日期和时间。