Items - Get Connection String

服務:

Warehouse

API 版本:

v1

傳回指定倉儲的 SQL 連接字串。

Permissions

呼叫端必須具有倉儲的 讀取 權限。 呼叫者必須具有 檢視者 或更高的工作區角色。

必要的委派範圍

Warehouse.Read.All 或 Warehouse.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支援的身分識別

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

身份	Support
User	Yes
服務主體 和 受控識別	Yes

界面

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString

含選擇性參數:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI 參數

名稱	位於	必要	類型	Description
warehouseId	path	True	string (uuid)	倉儲 ID。
workspaceId	path	True	string (uuid)	工作區識別碼。
guestTenantId	query		string (uuid)	如果使用者的租用戶與倉儲租用戶不同，則客體租用戶 ID。
privateLinkType	query		PrivateLinkType	指出此連接字串使用的私人連結類型。 隨著時間的推移，可能會添加其他 privateLinkType 類型。

回應

名稱	類型	Description
200 OK	ConnectionStringResponse	請求已成功完成。
429 Too Many Requests	ErrorResponse	服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。 標題 Retry-After: integer
Other Status Codes	ErrorResponse	常見錯誤碼： ItemNotFound - 找不到要求的專案。 InvalidGuestTenantId - 提供的客體租用戶識別碼不存在。

範例

Get connection string example

範例要求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765

範例回覆

狀態碼:

200

{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

定義

名稱	Description
ConnectionStringResponse	包含此倉儲之工作區的 SQL 連接字串。
ErrorRelatedResource	錯誤相關資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細資料。
PrivateLinkType	指出此連接字串使用的私人連結類型。 隨著時間的推移，可能會添加其他 privateLinkType 類型。

ConnectionStringResponse

Object

包含此倉儲之工作區的 SQL 連接字串。

名稱	類型	Description
connectionString	string	包含此倉儲之工作區的 SQL 連接字串。

ErrorRelatedResource

Object

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

名稱	類型	Description
resourceId	string	錯誤中涉及的資源識別碼。
resourceType	string	錯誤中涉及的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供有關錯誤情況資訊的特定識別碼，允許我們的服務與其使用者之間進行標準化通訊。
message	string	錯誤的人類可讀表示。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細資料清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細資料。
requestId	string (uuid)	與錯誤相關聯之要求的識別碼。

ErrorResponseDetails

Object

錯誤回應詳細資料。

名稱	類型	Description
errorCode	string	提供有關錯誤情況資訊的特定識別碼，允許我們的服務與其使用者之間進行標準化通訊。
message	string	錯誤的人類可讀表示。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細資料。

PrivateLinkType

列舉型別

指出此連接字串使用的私人連結類型。 隨著時間的推移，可能會添加其他 privateLinkType 類型。

值	Description
None	沒有私人連結 （預設）。
Workspace	Workspace private Link。