Git - Initialize Connection
Git に接続されているワークスペースの接続を初期化します。
この API は、実行時間の長い操作 (LRO)をサポートします。
この API を使用するには、呼び出し元の Git 資格情報を Update My Git Credentials API を使用して構成する必要があります。 Get My Git Credentials API を使用して、Git 資格情報の構成を確認できます。
この API は、 Connect API を正常に呼び出した後に呼び出す必要があります。 ワークスペースの完全同期を完了するには、 必要なアクション 操作を使用して、関連する同期操作 ( Git へのコミット または Git からの更新) を呼び出します。
権限
呼び出し元には 管理者 ワークスペース ロールが必要です。
必要な委任されたスコープ
Workspace.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
アイデンティティ | 支援 |
---|---|
ユーザー | イエス |
サービス プリンシパルの とマネージド ID の |
インターフェイス
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/initializeConnection
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
initializationStrategy |
リモート側とワークスペース側の両方にコンテンツが存在する場合の初期化プロセスに必要な戦略。 時間の経過と伴って追加の戦略が追加される場合があります。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は正常に完了しました。 |
|
202 Accepted |
要求は受け入れ、進行中の接続を初期化します。 ヘッダー
|
|
Other Status Codes |
一般的なエラー コード:
|
例
Initialize the connection of a workspace connected to a Git example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/initializeConnection
応答のサンプル
{
"requiredAction": "UpdateFromGit",
"workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
"remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705"
}
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
定義
名前 | 説明 |
---|---|
Error |
エラー関連のリソース詳細オブジェクト。 |
Error |
エラー応答。 |
Error |
エラー応答の詳細。 |
Initialization |
リモート側とワークスペース側の両方にコンテンツが存在する場合の初期化プロセスに必要な戦略。 時間の経過と伴って追加の戦略が追加される場合があります。 |
Initialize |
初期化 Git 接続要求データを格納します。 |
Initialize |
初期化 Git 接続応答データを格納します。 |
Required |
初期化プロセスが完了した後に必要なアクション。 時間の経過と伴って追加のアクションが追加される場合があります。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
エラーに関係するリソース ID。 |
resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
moreDetails |
その他のエラーの詳細の一覧。 |
|
relatedResource |
エラー関連のリソースの詳細。 |
|
requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
relatedResource |
エラー関連のリソースの詳細。 |
InitializationStrategy
リモート側とワークスペース側の両方にコンテンツが存在する場合の初期化プロセスに必要な戦略。 時間の経過と伴って追加の戦略が追加される場合があります。
値 | 説明 |
---|---|
None |
戦略が定義されていません。 |
PreferRemote |
リモート Git 側のコンテンツを優先します。 |
PreferWorkspace |
ワークスペース側のコンテンツを優先します。 |
InitializeGitConnectionRequest
初期化 Git 接続要求データを格納します。
名前 | 型 | 説明 |
---|---|---|
initializationStrategy |
リモート側とワークスペース側の両方にコンテンツが存在する場合の初期化プロセスに必要な戦略。 時間の経過と伴って追加の戦略が追加される場合があります。 |
InitializeGitConnectionResponse
初期化 Git 接続応答データを格納します。
名前 | 型 | 説明 |
---|---|---|
remoteCommitHash |
string |
リモート完全 SHA コミット ハッシュ。 |
requiredAction |
初期化プロセスが完了した後に必要なアクション。 時間の経過と伴って追加のアクションが追加される場合があります。 |
|
workspaceHead |
string |
ワークスペースが同期されている完全な SHA ハッシュ。 |
RequiredAction
初期化プロセスが完了した後に必要なアクション。 時間の経過と伴って追加のアクションが追加される場合があります。
値 | 説明 |
---|---|
CommitToGit |
Git へのコミットが必要です。 |
None |
アクションは必要ありません。 |
UpdateFromGit |
Git からの更新が必要です。 |