次の方法で共有

Git - Commit To Git

サービス:
Core
API バージョン:
v1

ワークスペースで行われた変更を、接続されたリモート ブランチにコミットします。
この API は、実行時間の長い操作 (LRO)をサポートします。

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

すべての変更をコミットすることも、特定の変更された項目のみをコミットすることもできます。 ワークスペースを初めて同期するには、 接続 API と Initialize Connection API の後にこの API を使用します。

権限

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

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

Workspace.GitCommit.All。

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 必須 型 説明
mode True

CommitMode

コミット操作のモード。
comment

string

maxLength: 300

このコミットの呼び出し元なしのコメント。 最大長は 300 文字です。 呼び出し元からコメントが指定されていない場合は、既定の Git プロバイダー コメントを使用します。
items

ItemIdentifier[]

コミットする特定の項目。 これは、選択的コミット モードにのみ関連します。 項目は Git Status API から取得できます。
workspaceHead

string

ワークスペースが同期されている完全な SHA ハッシュ。 ハッシュは Git Status API から取得できます。

応答

名前 型 説明
200 OK

要求は正常に完了しました。
202 Accepted

承諾を要求し、進行中の Git にコミットします。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • WorkspaceNotConnectedToGit - ワークスペースが git に接続されていません。

  • WorkspaceHasNoCapacityAssigned - ワークスペースに割り当てられた容量はありません。

  • WorkspaceHeadMismatch - 要求のヘッドがシステム内のヘッドと一致しません。

  • WorkspacePreviousOperationInProgress - 前の操作はまだ進行中です。

  • InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。

  • PrincipalTypeNotSupported - 呼び出し元 ID の種類はサポートされていません。

例

Commit all to Git example
Commit selective items to Git example

Commit all to Git example

要求のサンプル

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

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

応答のサンプル

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

Commit selective items to Git example

要求のサンプル

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

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

応答のサンプル

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

定義

名前 説明
CommitMode

コミット操作のモード。 時間の経過と伴って追加のモードが追加される場合があります。
CommitToGitRequest

コミット要求を格納します。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ItemIdentifier

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

CommitMode

列挙

コミット操作のモード。 時間の経過と伴って追加のモードが追加される場合があります。

値 説明
All

コミットされていないすべての変更をコミットします。 呼び出し元は、コミットする項目の一覧を指定する必要はありません。
Selective

コミットされていない変更を含む指定された項目リストをコミットします。

CommitToGitRequest

Object

コミット要求を格納します。

名前 型 説明
comment

string

maxLength: 300

このコミットの呼び出し元なしのコメント。 最大長は 300 文字です。 呼び出し元からコメントが指定されていない場合は、既定の Git プロバイダー コメントを使用します。
items

ItemIdentifier[]

コミットする特定の項目。 これは、選択的コミット モードにのみ関連します。 項目は Git Status API から取得できます。
mode

CommitMode

コミット操作のモード。
workspaceHead

string

ワークスペースが同期されている完全な SHA ハッシュ。 ハッシュは Git Status API から取得できます。

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

エラー関連のリソースの詳細。

ItemIdentifier

Object

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

名前 型 説明
logicalId

string (uuid)

項目の論理 ID。 アイテムがまだワークスペースに追加されていないために論理 ID を使用できない場合は、オブジェクト ID を使用できます。
objectId

string (uuid)

項目のオブジェクト ID。 アイテムがワークスペースから削除されたためにオブジェクト ID を使用できない場合は、論理 ID を使用できます。