Git - Get Status

服务:: Core

API 版本:: v1

返回工作区中可提交到 Git 的项 Git status。
此 API 支持长时间运行的作（LRO）。

状态指示自上次工作区和远程分支同步以来对项所做的更改。如果同时修改了远程项和工作区项，则 API 会标记冲突。

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

Permissions

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

所需的委派范围

Workspace.GitUpdate.All 或 Workspace.GitCommit.All

Microsoft Entra 支持的标识

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

Identity	Support
User	Yes
服务主体和托管标识	Yes

Interface

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

URI 参数

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

响应

名称	类型	说明
200 OK	GitStatusResponse	请求成功完成。
202 Accepted		请求已接受，获取正在进行的状态。标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： WorkspaceNotConnectedToGit - 工作区未连接到 git。 WorkspaceHasNoCapacityAssigned - 工作区不在容量上。 InsufficientPrivileges - 调用方没有足够的工作区权限。 PrincipalTypeNotSupported - 不支持调用方标识类型。

名称

类型

说明

200 OK

GitStatusResponse

请求成功完成。

202 Accepted

请求已接受，获取正在进行的状态。

标头

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

常见错误代码：

WorkspaceNotConnectedToGit - 工作区未连接到 git。
WorkspaceHasNoCapacityAssigned - 工作区不在容量上。
InsufficientPrivileges - 调用方没有足够的工作区权限。
PrincipalTypeNotSupported - 不支持调用方标识类型。

示例

Get status example

Get status no changes example

Get status with conflict example

Get status example

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
        },
        "itemType": "SemanticModel",
        "displayName": "My new dataset in the workspace"
      },
      "workspaceChange": "Added",
      "conflictType": "None"
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "1423f3b4-dba5-44c1-a94f-6ae4d776369a"
        },
        "itemType": "Report",
        "displayName": "My deleted report in Git"
      },
      "remoteChange": "Deleted",
      "conflictType": "None"
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
          "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
        },
        "itemType": "SemanticModel",
        "displayName": "Modified dataset in the workspace"
      },
      "workspaceChange": "Modified",
      "conflictType": "None"
    }
  ]
}

状态代码:: 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

Get status no changes example

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "changes": []
}

状态代码:: 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

Get status with conflict example

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "222e8d7b-4a95-4c02-8ccd-6faef5ba1bd2",
          "objectId": "8853f3b4-dbb8-33c1-a84f-6ae4d776362a"
        },
        "itemType": "Report",
        "displayName": "Modified report on both sides"
      },
      "remoteChange": "Modified",
      "workspaceChange": "Modified",
      "conflictType": "Conflict"
    }
  ]
}

状态代码:: 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

定义

名称	说明
ChangeType	项的更改。可能会随着时间的推移添加其他更改的类型。
ConflictType	工作区和远程中的项更改。可能会随着时间的推移添加其他更改的类型。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GitStatusResponse	包含状态响应。
ItemChange	包含项的更改信息。
ItemIdentifier	包含项标识符。必须至少定义一个属性。
ItemMetadata	包含项元数据。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。

ChangeType

枚举

项的更改。可能会随着时间的推移添加其他更改的类型。

值	说明
Added	新建的项。
Deleted	项已被删除。
Modified	项内容已修改。

ConflictType

枚举

工作区和远程中的项更改。可能会随着时间的推移添加其他更改的类型。

值	说明
None	项没有更改。
Conflict	工作区和远程 Git 中的项存在不同的更改。
SameChanges	工作区和远程 Git 中的项具有相同的更改。

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

GitStatusResponse

Object

包含状态响应。

名称	类型	说明
changes	ItemChange[]	远程 Git 中未应用于给定工作区的更改列表，以及未应用于远程 Git 的工作区中的更改。
remoteCommitHash	string	远程完整 SHA 提交哈希。
workspaceHead	string	工作区要同步到的完整 SHA 哈希。

ItemChange

Object

包含项的更改信息。

名称	类型	说明
conflictType	ConflictType	工作区端和远程 Git 端发生更改时。
itemMetadata	ItemMetadata	项元数据。
remoteChange	ChangeType	在远程 Git 端更改。
workspaceChange	ChangeType	在工作区端更改。

ItemIdentifier

Object

包含项标识符。必须至少定义一个属性。

名称	类型	说明
logicalId	string (uuid)	项的逻辑 ID。如果逻辑 ID 不可用，因为该项尚未添加到工作区，则可以使用对象 ID。
objectId	string (uuid)	项的对象 ID。当对象 ID 由于从工作区中删除了项而不可用时，可以使用逻辑 ID。

ItemMetadata

Object

包含项元数据。

名称	类型	说明
displayName	string	项的显示名称。如果工作区项存在，则首选工作区项的显示名称，否则 displayName 使用远程项的显示名称。
itemIdentifier	ItemIdentifier	项标识符。
itemType	ItemType	项类型。

ItemType

枚举

项的类型。可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
Report	PowerBI 报表。
SemanticModel	PowerBI 语义模型。
PaginatedReport	PowerBI 分页报表。
Datamart	PowerBI Datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	环境。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
KQLDashboard	KQL 仪表板。
DataPipeline	数据管道。
Notebook	笔记本。
SparkJobDefinition	spark 作业定义。
MLExperiment	机器学习试验。
MLModel	机器学习模型。
Warehouse	仓库。
Eventstream	事件流。
SQLEndpoint	SQL 终结点。
MirroredWarehouse	镜像仓库。
MirroredDatabase	镜像数据库。
Reflex	反射。
GraphQLApi	GraphQL 项的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	复制作业。
VariableLibrary	VariableLibrary。
Dataflow	数据流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	仓库快照。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
Map	地图。
AnomalyDetector	异常检测器。
UserDataFunction	用户数据函数。

通过

Git - Get Status

Permissions

所需的委派范围

Microsoft Entra 支持的标识

Interface

URI 参数

响应

示例

Get status example

示例请求

示例响应

Get status no changes example

示例请求

示例响应

Get status with conflict example

示例请求

示例响应

定义

ChangeType

ConflictType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GitStatusResponse

ItemChange

ItemIdentifier

ItemMetadata

ItemType