Git - Get Status

Service:

Core

API バージョン:

v1

Git にコミットできるワークスペース内の項目の Git status を返します。
この API は、実行時間の長い操作 (LRO)をサポートします。

状態は、最後のワークスペースとリモート ブランチの同期以降の項目への変更を示します。リモート項目とワークスペース項目の両方が変更された場合、API は競合にフラグを設定します。 Git からの更新操作の実行中は、API を呼び出さないでください。

この API を使用するには、呼び出し元の Git 資格情報を Update My Git Credentials API を使用して構成する必要があります。 Get My Git Credentials API を使用して、Git 資格情報の構成を確認できます。

Permissions

呼び出し元には、 共同作成者 以上のワークスペース ロールが必要です。

必要な委任されたスコープ

Workspace.GitUpdate.All または Workspace.GitCommit.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity	Support
User	Yes
サービス プリンシパルとマネージド ID	Yes

Interface

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

省略可能なパラメーターを含む:

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

URI パラメーター

Name	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。
includeFilesDetails	query		boolean	true の場合、応答内の各項目の変更には、ファイルごとの変更の詳細を含む fileChanges 配列が含まれます。

応答

Name	型	説明
200 OK	GitStatusResponse	要求は正常に完了しました。
202 Accepted		要求は受け入れ済み、進行中の状態を取得します。 ヘッダー Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。 ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラー コード: WorkspaceNotConnectedToGit - ワークスペースが git に接続されていません。 WorkspaceHasNoCapacityAssigned - ワークスペースが容量にありません。 InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。 PrincipalTypeNotSupported - 呼び出し元 ID の種類はサポートされていません。

例

Get status example

Get status no changes example

Get status with conflict example

Get status with file details 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

Get status with file details example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
        },
        "itemType": "Notebook",
        "displayName": "MyNotebook"
      },
      "workspaceChange": "Modified",
      "remoteChange": "Modified",
      "conflictType": "Conflict",
      "fileChanges": [
        {
          "path": "notebook-content.py",
          "workspaceChange": "Modified",
          "remoteChange": "Modified",
          "conflictType": "Conflict"
        },
        {
          "path": "metadata.json",
          "workspaceChange": "Modified",
          "conflictType": "None"
        },
        {
          "path": "config/settings.json",
          "remoteChange": "Added",
          "conflictType": "None"
        }
      ]
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789"
        },
        "itemType": "Report",
        "displayName": "SalesReport"
      },
      "workspaceChange": "Modified",
      "conflictType": "None",
      "fileChanges": [
        {
          "path": "pages/page1.json",
          "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

定義

Name	説明
ChangeType	アイテムの変更。 変更された型は、時間の経過と同時に追加される可能性があります。
ConflictType	ワークスペースとリモートの両方の項目の変更。 変更された型は、時間の経過と同時に追加される可能性があります。
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GitFileChange	アイテム内のファイル レベルの変更に関する情報が含まれます。
GitStatusResponse	状態の応答を格納します。
ItemChange	アイテムの変更情報を格納します。
ItemIdentifier	アイテム識別子を格納します。 少なくとも 1 つのプロパティを定義する必要があります。
ItemMetadata	項目メタデータを格納します。
ItemType	アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

ChangeType

列挙

アイテムの変更。 変更された型は、時間の経過と同時に追加される可能性があります。

値	説明
Added	新しく作成された項目。
Deleted	アイテムが削除されました。
Modified	アイテムの内容が変更されました。

ConflictType

列挙

ワークスペースとリモートの両方の項目の変更。 変更された型は、時間の経過と同時に追加される可能性があります。

値	説明
None	項目に変更はありません。
Conflict	ワークスペースとリモート Git の項目には、さまざまな変更があります。
SameChanges	ワークスペースとリモート Git の項目に同じ変更があります。

ErrorParameter

Object

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name	型	説明
message	string	パラメーターの意味を人間が判読できる説明。
name	string	パラメータ識別子です。
value	string	パラメーターの値を指定します。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

Name	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

GitFileChange

Object

アイテム内のファイル レベルの変更に関する情報が含まれます。

Name	型	説明
conflictType	ConflictType	このファイルの競合状態。
path	string	項目ルートを基準としたファイル パス。 スラッシュを使用し、先頭にスラッシュはありません。
remoteChange	ChangeType	リモート Git 側で変更します。
workspaceChange	ChangeType	ワークスペース側で変更します。

GitStatusResponse

Object

状態の応答を格納します。

Name	型	説明
changes	ItemChange[]	指定されたワークスペースに適用されていないリモート Git の変更と、リモート Git に適用されていないワークスペース内の変更の一覧。
remoteCommitHash	string	リモート完全 SHA コミット ハッシュ。
workspaceHead	string	ワークスペースが同期されている完全な SHA ハッシュ。

ItemChange

Object

アイテムの変更情報を格納します。

Name	型	説明
conflictType	ConflictType	ワークスペース側とリモート Git 側の両方に変更がある場合。
fileChanges	GitFileChange[]	アイテム内のファイル レベルの変更の一覧。 includeFilesDetails クエリ パラメーターが true に設定されている場合にのみ設定されます。
itemMetadata	ItemMetadata	項目のメタデータ。
remoteChange	ChangeType	リモート Git 側で変更します。
workspaceChange	ChangeType	ワークスペース側で変更します。

ItemIdentifier

Object

アイテム識別子を格納します。 少なくとも 1 つのプロパティを定義する必要があります。

Name	型	説明
logicalId	string (uuid)	項目の論理 ID。 アイテムがまだワークスペースに追加されていないために論理 ID を使用できない場合は、オブジェクト ID を使用できます。
objectId	string (uuid)	項目のオブジェクト ID。 アイテムがワークスペースから削除されたためにオブジェクト ID を使用できない場合は、論理 ID を使用できます。

ItemMetadata

Object

項目メタデータを格納します。

Name	型	説明
displayName	string	アイテムの表示名。 ワークスペースアイテムが存在する場合は表示名を優先し、それ以外の場合は displayName はリモートアイテムの表示名を使用します。
itemIdentifier	ItemIdentifier	アイテム識別子。
itemType	ItemType	アイテムの種類。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値	説明
Dashboard	PowerBI ダッシュボード。
Report	PowerBI レポート。
SemanticModel	PowerBI セマンティック モデル。
PaginatedReport	PowerBI のページ分割されたレポート。
Datamart	PowerBI データマート。
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	Warehouse スナップショット。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog	ミラー化された Azure databricks カタログ。
Map	マップ。
AnomalyDetector	Anomaly Detector。
UserDataFunction	ユーザー データ関数。
GraphModel	GraphModel。
GraphQuerySet	Graph QuerySet。
SnowflakeDatabase	Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB データベース。
Ontology	オントロジ。
EventSchemaSet	EventSchemaSet。
DataAgent	DataAgent。
MirroredCatalog	MirroredCatalog。
PolicySet	PolicySet。
AppBackend	AppBackend。
OrgApp	組織アプリ。
OrgAppAudience	組織アプリの対象ユーザー。
DataBuildToolJob	DataBuildToolJob。
AzureDatabricksStorage	Azure Databricksの OneLake に基づくストレージ項目。
Plan	プラン。