Items - Get Lakehouse

服务:: Lakehouse

API 版本:: v1

返回指定 Lakehouse 的属性。

权限

调用方必须具有 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 参数

名称	在	必需	类型	说明
lakehouseId	path	True	string (uuid)	湖屋 ID。
workspaceId	path	True	string (uuid)	工作区 ID。

响应

名称	类型	说明
200 OK	Lakehouse	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 找不到请求的项目。

名称

类型

说明

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"
  }
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemTag	表示应用于项的标记。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
Lakehouse	湖屋项。
LakehouseProperties	lakehouse 属性。
SqlEndpointProperties	包含 SQL 终结点属性的对象。
SqlEndpointProvisioningStatus	SQL 终结点预配状态类型。可能会随着时间的推移添加其他 `SqlEndpointProvisioningStatus` 类型。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemTag

对象

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项的类型。可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
Report	PowerBI 报表。
SemanticModel	PowerBI 语义模型。
PaginatedReport	PowerBI 分页报表。
Datamart	PowerBI Datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	环境。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
KQLDashboard	KQL 仪表板。
DataPipeline	数据管道。
Notebook	笔记本。
SparkJobDefinition	spark 作业定义。
MLExperiment	机器学习试验。
MLModel	机器学习模型。
Warehouse	仓库。
Eventstream	事件流。
SQLEndpoint	SQL 终结点。
MirroredWarehouse	镜像仓库。
MirroredDatabase	镜像数据库。
Reflex	反射。
GraphQLApi	GraphQL 项的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	复制作业。
VariableLibrary	VariableLibrary。
Dataflow	数据流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	仓库快照。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
Map	地图。
AnomalyDetector	异常检测器。
UserDataFunction	用户数据函数。
GraphModel	GraphModel。
GraphQuerySet	图形查询集。
SnowflakeDatabase	用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent	OperationsAgent。
CosmosDBDatabase	Cosmos DB 数据库。

Lakehouse

对象

湖屋项。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
folderId	string (uuid)	文件夹 ID。
id	string (uuid)	项 ID。
properties	LakehouseProperties	lakehouse 属性。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项类型。
workspaceId	string (uuid)	工作区 ID。

LakehouseProperties

对象

lakehouse 属性。

名称	类型	说明
defaultSchema	string	Lakehouse 的默认架构。此属性仅针对已启用架构的 Lakehouse 返回。
oneLakeFilesPath	string	Lakehouse 文件目录的 OneLake 路径。
oneLakeTablesPath	string	Lakehouse 表目录的 OneLake 路径。
sqlEndpointProperties	SqlEndpointProperties	包含 SQL 终结点属性的对象。

SqlEndpointProperties

对象

包含 SQL 终结点属性的对象。

名称	类型	说明
connectionString	string	SQL 终结点连接字符串。
id	string	SQL 终结点 ID。
provisioningStatus	SqlEndpointProvisioningStatus	SQL 终结点预配状态。

SqlEndpointProvisioningStatus

枚举

SQL 终结点预配状态类型。可能会随着时间的推移添加其他 SqlEndpointProvisioningStatus 类型。

值	说明
InProgress	SQL 终结点预配正在进行中。
Success	SQL 终结点预配成功。
Failed	SQL 终结点预配失败。

通过

Items - Get Lakehouse

权限

所需的委派范围

Microsoft Entra 支持的标识

接口

URI 参数

响应

示例

Get a lakehouse example

示例请求

示例响应

Get a lakehouse with schema example

示例请求

示例响应

定义

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Lakehouse

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus