Git - Create Workspace Relation

サービス:

Core

API バージョン:

v1

指定したワークスペースと関連するワークスペースの間にワークスペースの関係を作成します。

Note

この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。

ブランチ ワークスペースとその基本ワークスペースの間に分岐関係を作成します。

Permissions

呼び出し元には、ブランチ ワークスペースの 管理者 ロールと、基本ワークスペースの 共同作成者 以上のロールが必要です。

必要な委任スコープ

Workspace.ReadWrite.All

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

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

Identity	Support
ユーザー	はい
サービス プリンシパルとマネージド ID	はい

Interface

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

URI パラメーター

名前	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	必須	型	説明
relatedWorkspaceId	True	string (uuid)	関連するワークスペース ID。
relationType	True	WorkspaceRelationType	リレーションシップで作成する関連ワークスペースの種類。 BaseとBranchのみが作成可能です。

応答

名前	型	説明
201 Created	WorkspaceRelation	正常に作成されました。
429 Too Many Requests	ErrorResponse	サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。 ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラー コード: InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。 WorkspaceNotFound - 指定されたワークスペースが見つかりませんでした。 WorkspaceRelationAlreadyExists - 指定されたワークスペース間のリレーションシップが既に存在します。 WorkspaceRelationBidirectionalExists - これらのワークスペース間の関係は、既に反対方向に存在します。 WorkspaceRelationInvalidArgument - ワークスペースリレーションシップ操作に無効な引数が指定されました。 WorkspaceRelationInvalidType - ワークスペースの関係の種類が無効です。 WorkspaceRelationSelfReferencing - ワークスペースをそれ自体に関連付けることはできません。 WorkspaceRelationBaseIsBranch - ベース ワークスペースは既に別のワークスペースのブランチです。 WorkspaceRelationTargetHasBranches - ターゲット ワークスペースには既にブランチ ワークスペースがあります。 WorkspaceRelationDifferentBase - ターゲット ワークスペースには別の基本ワークスペースがあります。 WorkspaceRelationRootDirectoryMismatch - ワークスペースが同じ Git リポジトリ ルートに接続されていません。

例

Create a workspace relation example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/55555555-5555-5555-5555-555555555555/git/workspaceRelations

{
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

応答のサンプル

状態コード:

201

{
  "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "workspaceId": "55555555-5555-5555-5555-555555555555",
  "relatedWorkspaceId": "33333333-3333-3333-3333-333333333333",
  "relationType": "Base"
}

定義

名前	説明
CreateWorkspaceRelationRequest	ワークスペース関係を作成するための要求ペイロード。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
WorkspaceRelation	ワークスペース関係オブジェクト。
WorkspaceRelationType	リレーションシップ内の関連するワークスペースの種類。 関連するワークスペースの種類が時間の経過と同時に追加される場合があります。

CreateWorkspaceRelationRequest

Object

ワークスペース関係を作成するための要求ペイロード。

名前	型	説明
relatedWorkspaceId	string (uuid)	関連するワークスペース ID。
relationType	WorkspaceRelationType	リレーションシップで作成する関連ワークスペースの種類。 BaseとBranchのみが作成可能です。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

WorkspaceRelation

Object

ワークスペース関係オブジェクト。

名前	型	説明
id	string (uuid)	ワークスペースの関係 ID。
relatedWorkspaceId	string (uuid)	関連するワークスペース ID。
relationType	WorkspaceRelationType	リレーションシップ内の関連するワークスペースの種類。
workspaceId	string (uuid)	ワークスペース ID。

WorkspaceRelationType

列挙

リレーションシップ内の関連するワークスペースの種類。 関連するワークスペースの種類が時間の経過と同時に追加される場合があります。

値	説明
Base	関連するワークスペースは、基本 (ソース) ワークスペースです。
Branch	関連するワークスペースはブランチ ワークスペースです。
RelatedWorkspace	関連するワークスペースには、一般的な関係があります。