通过

Items - Create Lakehouse

  • 参考
服务:
Lakehouse
API 版本:
v1

在指定的工作区中创建 lakehouse。
此 API 支持 长时间运行的作（LRO）。

此 API 不支持创建具有定义的 Lakehouse。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

Lakehouse.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string

uuid

工作区 ID。

请求正文

名称 必需 类型 说明
displayName True

string

Lakehouse 显示名称。 显示名称必须遵循项类型的命名规则。
creationPayload

LakehouseCreationPayload

湖屋创建有效负载。
description

string

湖屋描述。 最大长度为 256 个字符。

响应

名称 类型 说明
201 Created

Lakehouse

已成功创建
202 Accepted

请求已接受，正在进行 Lakehouse 预配。

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • InvalidItemType - 项类型无效

  • ItemDisplayNameAlreadyInUse - 项显示名称已被使用。

  • CorruptedPayload - 提供的有效负载已损坏。

示例

Create a lakehouse example
Create a lakehouse with schema example

Create a lakehouse example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses

{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description"
}

示例响应

状态代码:
201 
{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a lakehouse with schema example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses

{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "creationPayload": {
    "enableSchemas": true
  }
}

示例响应

状态代码:
201 
{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定义

名称 说明
CreateLakehouseRequest

创建 lakehouse 请求有效负载。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
ItemType

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

湖屋项。
LakehouseCreationPayload

（预览版） Lakehouse 项有效负载。 由于启用了架构的 Lakehouse 处于预览状态，因此当前需要此属性。 正式发布后，它可能会变得冗余。
LakehouseProperties

lakehouse 属性。
SqlEndpointProperties

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

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

CreateLakehouseRequest

Object

创建 lakehouse 请求有效负载。

名称 类型 说明
creationPayload

LakehouseCreationPayload

湖屋创建有效负载。
description

string

湖屋描述。 最大长度为 256 个字符。
displayName

string

Lakehouse 显示名称。 显示名称必须遵循项类型的命名规则。

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。

LakehouseCreationPayload

Object

（预览版） Lakehouse 项有效负载。 由于启用了架构的 Lakehouse 处于预览状态，因此当前需要此属性。 正式发布后，它可能会变得冗余。

名称 类型 说明
enableSchemas

boolean

设置为 true 时，创建已启用架构的 Lakehouse。 仅允许“true”。

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 终结点预配成功。