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 参数

名称	在	必需	类型	说明
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	错误响应详细信息。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
Lakehouse	湖屋项。
LakehouseProperties	lakehouse 属性。
SqlEndpointProperties	包含 SQL 终结点属性的对象。
SqlEndpointProvisioningStatus	SQL 终结点预配状态类型。可能会随着时间的推移添加其他 `SqlEndpointProvisioningStatus` 类型。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

错误响应。

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

ErrorResponseDetails

Object

错误响应详细信息。

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

ItemType

Enumeration

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

值	说明
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
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

湖屋项。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
id	string uuid	项 ID。
properties	LakehouseProperties	lakehouse 属性。
type	ItemType	项类型。
workspaceId	string uuid	工作区 ID。

LakehouseProperties

Object

lakehouse 属性。

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

SqlEndpointProperties

Object

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

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

SqlEndpointProvisioningStatus

Enumeration

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

值	说明
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

其他资源