Git - Get Connection Settings

Service:
Core
API バージョン:
v1

Git に接続されたワークスペースの接続設定を取得します。

Note

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

Git に接続されたワークスペースの接続設定を返します。

Permissions

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

必要な委任スコープ

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

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

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

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

Interface

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

URI パラメーター

Name / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

応答

Name 型 説明
200 OK

GitConnectionSettings

要求は正常に完了しました。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • UnknownError - エラーが発生しました。

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

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

例

Get connection settings example

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "additionalRolesAuthorizedToChangeBranch": "None"
}

定義

Name 説明
ErrorParameter

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GitAdditionalBranchChangingRoles

接続された Git ブランチの変更が許可されている管理者以外の追加のワークスペース ロール。 時間の経過と同時に追加の値が追加される場合があります。
GitConnectionSettings

Git 接続設定が含まれています。

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

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

GitAdditionalBranchChangingRoles

列挙

接続された Git ブランチの変更が許可されている管理者以外の追加のワークスペース ロール。 時間の経過と同時に追加の値が追加される場合があります。

値 説明
None

管理者以外の追加のロールはブランチを変更できません。 これが既定値です。
MemberAndContributor

メンバーと共同作成者は、管理者に加えてブランチを変更することもできます。

GitConnectionSettings

Object

Git 接続設定が含まれています。

Name 型 説明
additionalRolesAuthorizedToChangeBranch

GitAdditionalBranchChangingRoles

接続された Git ブランチの変更が許可されている管理者以外の追加のワークスペース ロール。