Git - Get Connection

サービス:

Core

API バージョン:

v1

指定したワークスペースの Git 接続の詳細を返します。

権限

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

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

Workspace.Read.All または Workspace.ReadWrite.All

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

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

アイデンティティ	支援
ユーザー	イエス
サービス プリンシパルの とマネージド ID の	イエス

インターフェイス

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

URI パラメーター

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

応答

名前	型	説明
200 OK	GitConnection	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラー コード: UnknownError - エラーが発生しました。 InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。

例

Get Git connection details example

Workspace not connected to git example

Get Git connection details example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

応答のサンプル

状態コード:

200

{
  "gitProviderDetails": {
    "organizationName": "Test Organization",
    "projectName": "Test Project",
    "gitProviderType": "AzureDevOps",
    "repositoryName": "Test Repo",
    "branchName": "Test Branch",
    "directoryName": ""
  },
  "gitSyncDetails": {
    "head": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
    "lastSyncTime": "2021-11-20T09:26:43.153"
  },
  "gitConnectionState": "ConnectedAndInitialized"
}

Workspace not connected to git example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/connection

応答のサンプル

状態コード:

200

{
  "gitProviderDetails": null,
  "gitSyncDetails": null,
  "gitConnectionState": "NotConnected"
}

定義

名前	説明
AzureDevOpsDetails	Azure DevOps プロバイダーの詳細。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GitConnection	Git 接続の詳細が含まれています。
GitConnectionState	Git 接続の状態。 接続状態の種類は、時間の経過と同時に追加される場合があります。
GitHubDetails	GitHub プロバイダーの詳細。
GitProviderType	Git プロバイダーの種類。 プロバイダーの種類は、時間の経過と同時に追加される場合があります。
GitSyncDetails	同期の詳細が含まれています。

AzureDevOpsDetails

Object

Azure DevOps プロバイダーの詳細。

名前	型	説明
branchName	string maxLength: 250	ブランチ名。 最大長は 250 文字です。
directoryName	string maxLength: 256	ディレクトリへの相対パス。 最大長は 256 文字です。
gitProviderType	string: AzureDevOps	Git プロバイダーの種類。 プロバイダーの種類は、時間の経過と同時に追加される場合があります。
organizationName	string maxLength: 100	組織名。 最大長は 100 文字です。
projectName	string maxLength: 100	プロジェクト名。 最大長は 100 文字です。
repositoryName	string maxLength: 128	リポジトリ名。 最大長は 128 文字です。

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

GitConnection

Object

Git 接続の詳細が含まれています。

名前	型	説明
gitConnectionState	GitConnectionState	Git 接続の状態。 接続状態の種類は、時間の経過と同時に追加される場合があります。
gitProviderDetails	GitProviderDetails: AzureDevOpsDetails GitHubDetails	Git プロバイダーの詳細。
gitSyncDetails	GitSyncDetails	同期の詳細が含まれています。

GitConnectionState

列挙

Git 接続の状態。 接続状態の種類は、時間の経過と同時に追加される場合があります。

値	説明
NotConnected	接続されていない状態。
Connected	接続状態。
ConnectedAndInitialized	接続および初期化された状態。

GitHubDetails

Object

GitHub プロバイダーの詳細。

名前	型	説明
branchName	string maxLength: 250	ブランチ名。 最大長は 250 文字です。
directoryName	string maxLength: 256	ディレクトリへの相対パス。 最大長は 256 文字です。
gitProviderType	string: GitHub	Git プロバイダーの種類。 プロバイダーの種類は、時間の経過と同時に追加される場合があります。
ownerName	string maxLength: 100	所有者名。 最大長は 100 文字です。
repositoryName	string maxLength: 128	リポジトリ名。 最大長は 128 文字です。

GitProviderType

列挙

Git プロバイダーの種類。 プロバイダーの種類は、時間の経過と同時に追加される場合があります。

値	説明
AzureDevOps	Azure DevOps プロバイダー
GitHub	GitHub プロバイダー

GitSyncDetails

Object

同期の詳細が含まれています。

名前	型	説明
head	string	同期されたコミット ID の完全なセキュア ハッシュ アルゴリズム 1 (SHA-1)。
lastSyncTime	string (date-time)	最後の同期状態の日付と時刻。