Git - Get Connection Settings

服務:

Core

API 版本:

v1

取得連接 Git 工作區的連線設定。

Note

此 API 是預覽版的一部分，僅供評估和開發之用。 它可能會根據意見反應而變更，不建議用於生產環境。 了解更多。

回傳 Git 連接工作區的連線設定。

Permissions

呼叫者必須具有 參與者 或更高的工作區角色。

必要的委派範圍

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity	Support
使用者	Yes
服務主體 和 受控識別	Yes

Interface

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

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區識別碼。

回覆

名稱	類型	Description
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

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "additionalRolesAuthorizedToChangeBranch": "None"
}

定義

名稱	Description
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應的細節。
GitAdditionalBranchChangingRoles	除了管理員之外，還有其他工作區角色可以更改連接的 Git 分支。 隨著時間推移，可能會加入額外的數值。
GitConnectionSettings	包含 Git 連線設定。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱	類型	Description
message	string	一個人類可讀的參數意義描述。
name	string	參數識別碼。
value	string	這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable	boolean	若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message	string	以人類可讀格式呈現的錯誤訊息。
moreDetails	ErrorResponseDetails[]	其他錯誤詳情的清單。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。
requestId	string (uuid)	與錯誤相關聯的要求識別碼。

ErrorResponseDetails

Object

錯誤回應的細節。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	以人類可讀格式呈現的錯誤訊息。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。

GitAdditionalBranchChangingRoles

列舉型別

除了管理員之外，還有其他工作區角色可以更改連接的 Git 分支。 隨著時間推移，可能會加入額外的數值。

值	Description
None	除了行政之外，其他職務不能更換分支。 此為預設值。
MemberAndContributor	會員與貢獻者除了管理員外，也可以更換分支機構。

GitConnectionSettings

Object

包含 Git 連線設定。

名稱	類型	Description
additionalRolesAuthorizedToChangeBranch	GitAdditionalBranchChangingRoles	除了管理員之外，還有其他工作區角色可以更改連接的 Git 分支。