Git - Get Status
傳回工作區中可認可至 Git 的專案 Git status
。
此 API 支援 長時間執行的作業 (LRO)。
狀態表示自上一個工作區和遠端分支同步之後的項目變更。如果修改了這兩個位置,API 會標幟衝突。
權限
呼叫者必須具有 參與者 或更高的工作區角色。
必要的委派範圍
Workspace.GitUpdate.All 或 Workspace.GitCommit.All
Microsoft Entra 支援的身分識別
此 API 支援本節中列出的Microsoft 身分識別。
身份 | 支援 |
---|---|
使用者 | 是的 |
服務主體 和 受控識別 | 不 |
介面
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
工作區標識碼。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
要求成功完成。 |
|
202 Accepted |
要求已接受,取得進行中的狀態。 標題
|
|
Other Status Codes |
常見的錯誤碼:
|
範例
Get status example |
Get status no changes example |
Get status with conflict example |
Get status example
範例要求
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
範例回覆
{
"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"
}
]
}
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
範例要求
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
範例回覆
{
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"changes": []
}
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
範例要求
GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status
範例回覆
{
"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"
}
]
}
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
定義
名稱 | Description |
---|---|
Change |
項目的變更。 可能會隨著時間新增其他已變更的類型。 |
Conflict |
工作區和遠端中的項目變更。 可能會隨著時間新增其他已變更的類型。 |
Error |
錯誤相關的資源詳細資料物件。 |
Error |
錯誤回應。 |
Error |
錯誤回應詳細數據。 |
Git |
包含狀態回應。 |
Item |
包含專案的變更資訊。 |
Item |
包含項目識別碼。 至少必須定義其中一個屬性。 |
Item |
包含專案元數據。 |
Item |
專案的型別。 可能會隨著時間新增其他項目類型。 |
ChangeType
項目的變更。 可能會隨著時間新增其他已變更的類型。
值 | Description |
---|---|
Added |
新建立的專案。 |
Deleted |
項目已刪除。 |
Modified |
已修改項目內容。 |
ConflictType
工作區和遠端中的項目變更。 可能會隨著時間新增其他已變更的類型。
值 | Description |
---|---|
Conflict |
工作區和遠端 Git 中的專案有不同的變更。 |
None |
項目沒有任何變更。 |
SameChanges |
工作區和遠端 Git 中的專案有相同的變更。 |
ErrorRelatedResource
錯誤相關的資源詳細資料物件。
名稱 | 類型 | Description |
---|---|---|
resourceId |
string |
發生錯誤的資源識別碼。 |
resourceType |
string |
發生錯誤的資源類型。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
message |
string |
錯誤的人類可讀取表示法。 |
moreDetails |
其他錯誤詳細數據的清單。 |
|
relatedResource |
錯誤相關的資源詳細數據。 |
|
requestId |
string |
與錯誤相關聯的要求標識碼。 |
ErrorResponseDetails
錯誤回應詳細數據。
名稱 | 類型 | Description |
---|---|---|
errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
message |
string |
錯誤的人類可讀取表示法。 |
relatedResource |
錯誤相關的資源詳細數據。 |
GitStatusResponse
包含狀態回應。
名稱 | 類型 | Description |
---|---|---|
changes |
遠端 Git 中未套用至指定工作區的變更清單,以及未套用至遠端 Git 的工作區變更。 |
|
remoteCommitHash |
string |
遠端完整 SHA 認可哈希。 |
workspaceHead |
string |
工作區同步處理的完整SHA哈希。 |
ItemChange
包含專案的變更資訊。
名稱 | 類型 | Description |
---|---|---|
conflictType |
當工作區端和遠端 Git 端都有變更時。 |
|
itemMetadata |
專案元數據。 |
|
remoteChange |
在遠端 Git 端變更。 |
|
workspaceChange |
在工作區端變更。 |
ItemIdentifier
包含項目識別碼。 至少必須定義其中一個屬性。
名稱 | 類型 | Description |
---|---|---|
logicalId |
string uuid |
項目的邏輯標識碼。 當邏輯識別碼無法使用,因為專案尚未新增至工作區時,您可以使用對象識別碼。 |
objectId |
string uuid |
項目的物件識別碼。 因為專案從工作區中刪除,因此無法使用物件識別碼時,您可以使用邏輯標識碼。 |
ItemMetadata
包含專案元數據。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
項目的顯示名稱。 如果工作區項目的顯示名稱存在,則偏好使用工作區項目的顯示名稱,否則 displayName 會使用遠端專案的顯示名稱。 |
itemIdentifier |
項目標識碼。 |
|
itemType |
項目類型。 |
ItemType
專案的型別。 可能會隨著時間新增其他項目類型。
值 | Description |
---|---|
Dashboard |
PowerBI 儀錶板。 |
DataPipeline |
數據管線。 |
Datamart |
PowerBI datamart。 |
Environment |
環境。 |
Eventhouse |
事件屋。 |
Eventstream |
eventstream。 |
GraphQLApi |
GraphQL 專案的 API。 |
KQLDashboard |
KQL 儀錶板。 |
KQLDatabase |
KQL 資料庫。 |
KQLQueryset |
KQL 查詢集。 |
Lakehouse |
湖屋 |
MLExperiment |
機器學習實驗。 |
MLModel |
機器學習模型。 |
MirroredDatabase |
鏡像資料庫。 |
MirroredWarehouse |
鏡像倉儲。 |
MountedDataFactory |
MountedDataFactory。 |
Notebook |
筆記本。 |
PaginatedReport |
PowerBI 編頁報表。 |
Reflex |
反射。 |
Report |
PowerBI 報表。 |
SQLDatabase |
SQLDatabase。 |
SQLEndpoint |
SQL 端點。 |
SemanticModel |
PowerBI 語意模型。 |
SparkJobDefinition |
Spark 作業定義。 |
Warehouse |
倉儲。 |