Items - Get Lakehouse

參考

服務:: Lakehouse

API 版本:: v1

傳回指定之 Lakehouse 的屬性。

權限

呼叫端必須具有 查看器 或更高的工作區角色。

必要的委派範圍

Lakehouse.Read.All 或 Lakehouse.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支援的身分識別

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

身份	支援
使用者	是的
服務主體和受控識別	是的

介面

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}

URI 參數

名稱	位於	必要	類型	Description
lakehouseId	path	True	string uuid	Lakehouse 標識符。
workspaceId	path	True	string uuid	工作區標識碼。

回應

名稱	類型	Description
200 OK	Lakehouse	要求成功完成。
Other Status Codes	ErrorResponse	常見的錯誤碼： ItemNotFound - 找不到要求的專案。

名稱

類型

Description

200 OK

Lakehouse

要求成功完成。

Other Status Codes

ErrorResponse

常見的錯誤碼：

ItemNotFound - 找不到要求的專案。

範例

Get a lakehouse example

Get a lakehouse with schema example

Get a lakehouse example

範例要求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

範例回覆

狀態碼:: 200

{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Files",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
      "provisioningStatus": "Success"
    }
  }
}

Get a lakehouse with schema example

範例要求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

範例回覆

狀態碼:: 200

{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Files",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
      "provisioningStatus": "Success"
    },
    "defaultSchema": "dbo"
  }
}

定義

名稱	Description
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
ItemType	專案的型別。可能會隨著時間新增其他項目類型。
Lakehouse	Lakehouse 專案。
LakehouseProperties	Lakehouse 屬性。
SqlEndpointProperties	物件，包含 SQL 端點的屬性。
SqlEndpointProvisioningStatus	SQL 端點布建狀態類型。可能會隨著時間新增其他 `SqlEndpointProvisioningStatus` 類型。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

ItemType

Enumeration

專案的型別。可能會隨著時間新增其他項目類型。

值	Description
Dashboard	PowerBI 儀錶板。
DataPipeline	數據管線。
Datamart	PowerBI datamart。
Environment	環境。
Eventhouse	事件屋。
Eventstream	eventstream。
GraphQLApi	GraphQL 專案的 API。
KQLDashboard	KQL 儀錶板。
KQLDatabase	KQL 資料庫。
KQLQueryset	KQL 查詢集。
Lakehouse	湖屋
MLExperiment	機器學習實驗。
MLModel	機器學習模型。
MirroredDatabase	鏡像資料庫。
MirroredWarehouse	鏡像倉儲。
MountedDataFactory	MountedDataFactory。
Notebook	筆記本。
PaginatedReport	PowerBI 編頁報表。
Reflex	反射。
Report	PowerBI 報表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 端點。
SemanticModel	PowerBI 語意模型。
SparkJobDefinition	Spark 作業定義。
Warehouse	倉儲。

Lakehouse

Object

Lakehouse 專案。

名稱	類型	Description
description	string	專案描述。
displayName	string	項目顯示名稱。
id	string uuid	項目標識碼。
properties	LakehouseProperties	Lakehouse 屬性。
type	ItemType	項目類型。
workspaceId	string uuid	工作區標識碼。

LakehouseProperties

Object

Lakehouse 屬性。

名稱	類型	Description
defaultSchema	string	Lakehouse 的默認架構。此屬性只會針對已啟用架構的 Lakehouse 傳回。
oneLakeFilesPath	string	Lakehouse 檔案目錄的 OneLake 路徑。
oneLakeTablesPath	string	Lakehouse 資料表目錄的 OneLake 路徑。
sqlEndpointProperties	SqlEndpointProperties	物件，包含 SQL 端點的屬性。

SqlEndpointProperties

Object

物件，包含 SQL 端點的屬性。

名稱	類型	Description
connectionString	string	SQL 端點連接字串。
id	string	SQL 端點標識碼。
provisioningStatus	SqlEndpointProvisioningStatus	SQL 端點布建狀態。

SqlEndpointProvisioningStatus

Enumeration

SQL 端點布建狀態類型。可能會隨著時間新增其他 SqlEndpointProvisioningStatus 類型。

值	Description
Failed	SQL 端點布建失敗。
InProgress	SQL 端點布建正在進行中。
Success	SQL 端點布建成功。

共用方式為

Items - Get Lakehouse

權限

必要的委派範圍

Microsoft Entra 支援的身分識別

介面

URI 參數

回應

範例

Get a lakehouse example

範例要求

範例回覆

Get a lakehouse with schema example

範例要求

範例回覆

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus

其他資源