Items - Create Lakehouse
Creates a lakehouse in the specified workspace.
This API supports long running operations (LRO).
This API does not support create a lakehouse with definition.
Permissions
The caller must have a contributor workspace role.
Required Delegated Scopes
Lakehouse.ReadWrite.All or Item.ReadWrite.All
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal and Managed identities | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string (uuid) |
The workspace ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
displayName | True |
string |
The lakehouse display name. The display name must follow naming rules according to item type. |
creationPayload |
The lakehouse creation payload. |
||
description |
string |
The lakehouse description. Maximum length is 256 characters. |
|
folderId |
string (uuid) |
The folder ID. If not specified or null, the lakehouse is created with the workspace as its folder. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Successfully created |
|
202 Accepted |
Request accepted, lakehouse provisioning in progress. Headers
|
|
Other Status Codes |
Common error codes:
|
Examples
Create a lakehouse example |
Create a lakehouse with schema example |
Create a lakehouse example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses
{
"displayName": "Lakehouse_1",
"description": "A lakehouse description"
}
Sample response
{
"displayName": "Lakehouse_1",
"description": "A lakehouse description",
"type": "Lakehouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
Sample request
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
}
}
Sample response
{
"displayName": "Lakehouse_created_with_schema",
"description": "A schema enabled lakehouse.",
"type": "Lakehouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
Definitions
Name | Description |
---|---|
Create |
Create lakehouse request payload. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
Represents a tag applied on an item. |
Item |
The type of the item. Additional item types may be added over time. |
Lakehouse |
A lakehouse item. |
Lakehouse |
(Preview) Lakehouse item payload. This property is currently required due to the schema enabled lakehouse being in preview. It might become redundant upon General Availability (GA). |
Lakehouse |
The lakehouse properties. |
Sql |
An object containing the properties of the SQL endpoint. |
Sql |
The SQL endpoint provisioning status type. Additional |
CreateLakehouseRequest
Create lakehouse request payload.
Name | Type | Description |
---|---|---|
creationPayload |
The lakehouse creation payload. |
|
description |
string |
The lakehouse description. Maximum length is 256 characters. |
displayName |
string |
The lakehouse display name. The display name must follow naming rules according to item type. |
folderId |
string (uuid) |
The folder ID. If not specified or null, the lakehouse is created with the workspace as its folder. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
ItemTag
Represents a tag applied on an item.
Name | Type | Description |
---|---|---|
displayName |
string |
The name of the tag. |
id |
string (uuid) |
The tag ID. |
ItemType
The type of the item. Additional item types may be added over time.
Value | Description |
---|---|
Dashboard |
PowerBI dashboard. |
Report |
PowerBI report. |
SemanticModel |
PowerBI semantic model. |
PaginatedReport |
PowerBI paginated report. |
Datamart |
PowerBI datamart. |
Lakehouse |
A lakehouse. |
Eventhouse |
An eventhouse. |
Environment |
An environment. |
KQLDatabase |
A KQL database. |
KQLQueryset |
A KQL queryset. |
KQLDashboard |
A KQL dashboard. |
DataPipeline |
A data pipeline. |
Notebook |
A notebook. |
SparkJobDefinition |
A spark job definition. |
MLExperiment |
A machine learning experiment. |
MLModel |
A machine learning model. |
Warehouse |
A warehouse. |
Eventstream |
An eventstream. |
SQLEndpoint |
An SQL endpoint. |
MirroredWarehouse |
A mirrored warehouse. |
MirroredDatabase |
A mirrored database. |
Reflex |
A Reflex. |
GraphQLApi |
An API for GraphQL item. |
MountedDataFactory |
A MountedDataFactory. |
SQLDatabase |
A SQLDatabase. |
CopyJob |
A Copy job. |
VariableLibrary |
A VariableLibrary. |
Dataflow |
A Dataflow. |
ApacheAirflowJob |
An ApacheAirflowJob. |
WarehouseSnapshot |
A Warehouse snapshot. |
DigitalTwinBuilder |
A DigitalTwinBuilder. |
DigitalTwinBuilderFlow |
A Digital Twin Builder Flow. |
MirroredAzureDatabricksCatalog |
A mirrored azure databricks catalog. |
Lakehouse
A lakehouse item.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
folderId |
string (uuid) |
The folder ID. |
id |
string (uuid) |
The item ID. |
properties |
The lakehouse properties. |
|
tags |
Item |
List of applied tags. |
type |
The item type. |
|
workspaceId |
string (uuid) |
The workspace ID. |
LakehouseCreationPayload
(Preview) Lakehouse item payload. This property is currently required due to the schema enabled lakehouse being in preview. It might become redundant upon General Availability (GA).
Name | Type | Description |
---|---|---|
enableSchemas |
boolean |
Create a schema enabled lakehouse when set to true. Only 'true' is allowed. |
LakehouseProperties
The lakehouse properties.
Name | Type | Description |
---|---|---|
defaultSchema |
string |
Default schema of the lakehouse. This property is returned only for schema enabled lakehouse. |
oneLakeFilesPath |
string |
OneLake path to the Lakehouse files directory. |
oneLakeTablesPath |
string |
OneLake path to the Lakehouse tables directory. |
sqlEndpointProperties |
An object containing the properties of the SQL endpoint. |
SqlEndpointProperties
An object containing the properties of the SQL endpoint.
Name | Type | Description |
---|---|---|
connectionString |
string |
SQL endpoint connection string. |
id |
string |
SQL endpoint ID. |
provisioningStatus |
The SQL endpoint provisioning status. |
SqlEndpointProvisioningStatus
The SQL endpoint provisioning status type. Additional SqlEndpointProvisioningStatus
types may be added over time.
Value | Description |
---|---|
InProgress |
SQL endpoint provisioning is in progress. |
Success |
SQL endpoint provisioning succeeded. |
Failed |
SQL endpoint provisioning failed. |