Git - Update From Git

Service:: Core

API バージョン:: v1

接続されたブランチにプッシュされたコミットでワークスペースを更新します。

Note

この API でのデプロイ計画のサポートはベータリリースの一部であり、評価と開発のみを目的として提供されます。フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。この API の他のすべての機能は一般公開されています。 デプロイ計画のサポートを使用するには、呼び出し元はクエリパラメーター betaの値としてtrueを指定する必要があります。

この API は、実行時間の長い操作 (LRO)をサポートします。

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

更新プログラムは、これらのコミットで変更されたワークスペース内の項目にのみ影響します。 Connect API と Initialize Connection API の後に呼び出されると、ワークスペース全体の完全な更新が実行されます。

権限

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

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

Workspace.GitUpdate.All

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

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

アイデンティティ	支援
ユーザー	イエス
サービスプリンシパルのとマネージド ID の	操作に関係するすべての項目がサービスプリンシパルをサポートしている場合にのみサポートされます

インターフェイス

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

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit?beta={beta}

URI パラメーター

Name	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。
beta	query		boolean	デプロイ計画のサポートを含むベータ機能を有効にするには、 `true` に設定します。省略するか、 `false`に設定すると、一般公開されている機能にのみアクセスでき、展開計画の入力は受け入れられません。

要求本文

Name	必須	型	説明
remoteCommitHash	True	string	リモート完全 SHA コミットハッシュ。
conflictResolution		WorkspaceConflictResolution	Git 操作からの更新で使用される競合の解決。項目が競合していて、競合解決が指定されていない場合、更新操作は開始されません。
options		UpdateOptions	Git 操作からの更新で使用するオプション
workspaceHead		string	ワークスペースが同期されている完全な SHA ハッシュ。この値は、接続の初期化後にのみ null にすることができます。それ以外の場合、システムは、指定された値がシステムに認識されているヘッドと一致していることを検証します。

応答

Name	型	説明
200 OK		要求は正常に完了しました。
202 Accepted		承諾を要求し、進行中の Git から更新します。ヘッダー 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 - ワークスペースに割り当てられた容量がありません。 WorkspaceHeadMismatch - 要求のヘッドがシステム内のヘッドと一致しません。 WorkspacePreviousOperationInProgress - 前の操作はまだ進行中です。 MissingDependency - 更新操作に依存関係がありません。 PotentialDuplicateDisplayNameAndType - 更新操作では、重複する表示名と種類が作成されます。 DependencyDeletionFailed - 更新操作では、ハード依存関係が削除されます。 InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。 PrincipalTypeNotSupported - 呼び出し元 ID の種類はサポートされていません。

例

Update a workspace from Git with options example

Update a workspace using data from a Git example

Update a workspace using data from a Git with a deployment plan example

Update a workspace from Git with options example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "itemOptionsByLogicalId": [
      {
        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
        "options": {
          "validateOnly": true
        }
      }
    ]
  }
}

応答のサンプル

状態コード:: 200

状態コード:: 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

Update a workspace using data from a Git example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true
  }
}

応答のサンプル

状態コード:: 200

状態コード:: 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

Update a workspace using data from a Git with a deployment plan example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/updateFromGit

{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "conflictResolution": {
    "conflictResolutionType": "Workspace",
    "conflictResolutionPolicy": "PreferWorkspace"
  },
  "options": {
    "allowOverrideItems": true,
    "deploymentPlan": {
      "referenceType": "ByLogicalId",
      "logicalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

応答のサンプル

状態コード:: 200

状態コード:: 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	説明
ConflictResolutionPolicy	競合解決ポリシー。競合解決ポリシーが時間の経過と同時に追加される場合があります。
ConflictResolutionType	競合解決の種類。競合解決の種類が時間の経過と同時に追加される場合があります。
DeploymentPlanReferenceByItemId	項目 ID による展開計画の参照。
DeploymentPlanReferenceByLogicalId	論理 ID によるデプロイ計画の参照。
DeploymentPlanReferenceType	展開計画の参照の種類。追加の `DeploymentPlanReferenceType` 型は、時間の経過と同時に追加される場合があります。
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
ItemOptionsByLogicalIdEntry	論理 ID で項目を対象とする項目ごとのオプションエントリ。対象となる各アイテムは、最大で 1 回表示される場合があります。
UpdateFromGitRequest	Git 要求データからの更新が含まれています。
UpdateOptions	Git からの更新に対して有効になっているオプションが含まれています。
WorkspaceConflictResolution	基本的な競合解決データ。

ConflictResolutionPolicy

列挙

競合解決ポリシー。競合解決ポリシーが時間の経過と同時に追加される場合があります。

値	説明
PreferRemote	リモート Git 側のコンテンツを優先します。
PreferWorkspace	ワークスペース側のコンテンツを優先します。

ConflictResolutionType

列挙

競合解決の種類。競合解決の種類が時間の経過と同時に追加される場合があります。

値	説明
Workspace	ワークスペースレベルを表す競合解決。

DeploymentPlanReferenceByItemId

Object

項目 ID による展開計画の参照。

Name	型	説明
itemId	string (uuid)	展開計画項目の項目 ID。
referenceType	string: ByItemId	展開計画の参照の種類。

DeploymentPlanReferenceByLogicalId

Object

論理 ID によるデプロイ計画の参照。

Name	型	説明
logicalId	string (uuid)	展開計画項目の論理 ID。
referenceType	string: ByLogicalId	展開計画の参照の種類。

DeploymentPlanReferenceType

列挙

展開計画の参照の種類。追加の DeploymentPlanReferenceType 型は、時間の経過と同時に追加される場合があります。

値	説明
ByItemId	展開計画は、その項目 ID によって参照されます。
ByLogicalId	デプロイ計画は、その論理 ID によって参照されます。

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	エラー関連のリソースの詳細。

ItemOptionsByLogicalIdEntry

Object

論理 ID で項目を対象とする項目ごとのオプションエントリ。対象となる各アイテムは、最大で 1 回表示される場合があります。

Name	型	説明
logicalId	string (uuid)	ターゲット項目の論理 ID。
options	object	対象となる項目のオプション。プロパティ名は、項目の種類に対して有効なオプション名です。値はオプション値です。特定の項目の種類でサポートされるオプションについては、その項目の種類の `Update-Definition` API のドキュメントを参照してください。

UpdateFromGitRequest

Object

Git 要求データからの更新が含まれています。

Name	型	説明
conflictResolution	WorkspaceConflictResolution	Git 操作からの更新で使用される競合の解決。項目が競合していて、競合解決が指定されていない場合、更新操作は開始されません。
options	UpdateOptions	Git 操作からの更新で使用するオプション
remoteCommitHash	string	リモート完全 SHA コミットハッシュ。
workspaceHead	string	ワークスペースが同期されている完全な SHA ハッシュ。この値は、接続の初期化後にのみ null にすることができます。それ以外の場合、システムは、指定された値がシステムに認識されているヘッドと一致していることを検証します。

UpdateOptions

Object

Git からの更新に対して有効になっているオプションが含まれています。

Name	型	説明
allowOverrideItems	boolean	Git プロセスからの更新中に受信項目をオーバーライドすることにユーザーの同意。受信項目が存在し、許可オーバーライド項目が指定されていないか、false として指定されている場合、更新操作は開始されません。既定値は false です。
deploymentPlan	DeploymentPlanReference: DeploymentPlanReferenceByItemId DeploymentPlanReferenceByLogicalId	デプロイを調整するための展開計画項目への参照。指定すると、プランは項目の展開順序を制御し、配置前/配置後のアクションを実行します。存在しない場合、または null の場合、操作は今日のように動作します。現時点では、 `ByLogicalId` 参照型のみがサポートされています。デプロイ計画のサポートは現在ベータ版です。このプロパティは、クエリパラメーター `beta` が `true` に設定され、フィードバックに基づいて変更される可能性がある場合にのみ使用できます。
itemOptionsByLogicalId	ItemOptionsByLogicalIdEntry[]	項目ごとの更新オプション。各エントリは、論理 ID で項目を対象とし、その項目にそのオプションを適用します。

WorkspaceConflictResolution

Object

基本的な競合解決データ。

Name	型	説明
conflictResolutionPolicy	ConflictResolutionPolicy	競合解決ポリシー。競合解決ポリシーが時間の経過と同時に追加される場合があります。
conflictResolutionType	ConflictResolutionType	競合解決の種類。競合解決の種類が時間の経過と同時に追加される場合があります。