Items - Create Lakehouse
Creates a lakehouse in the specified workspace.
This API supports long running operations (LRO).
To create lakehouse with a public definition, refer to Lakehouse definition article.
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. |
||
| definition |
The lakehouse public definition. |
||
| 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
|
|
| 429 Too Many Requests |
The service rate limit was exceeded. The server returns a Headers Retry-After: integer |
|
| Other Status Codes |
Common error codes:
|
Examples
| Create a lakehouse example |
| Create a lakehouse with definition 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 definition example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses
{
"displayName": "Lakehouse_created_with_definition",
"description": "Example lakehouse with definition",
"definition": {
"format": "LakehouseDefinitionV1",
"parts": [
{
"path": "lakehouse.metadata.json",
"payload": "eyJkZWZhdWx0U2NoZW1hIjoiZGJvIn0=",
"payloadType": "InlineBase64"
},
{
"path": "shortcuts.metadata.json",
"payload": "WwogIHsKICAgICJuYW1lIjogIk55Y1RheGkiLAogICAgInBhdGgiOiAiL1RhYmxlcyIsCiAgICAidGFyZ2V0IjogewogICAgICAidHlwZSI6ICJPbmVMYWtlIiwKICAgICAgIm9uZUxha2UiOiB7CiAgICAgICAgInBhdGgiOiAiRmlsZXMvTnljVGF4aSIsCiAgICAgICAgIml0ZW1JZCI6ICIxNzBjYzY3Ni1hYzFhLTkwNmUtNDE5Mi0zZGJlZGM1MmYwMWUiLAogICAgICAgICJ3b3Jrc3BhY2VJZCI6ICJjZmFmYmViMS04MDM3LTRkMGMtODk2ZS1hNDZmYjI3ZmYyMjkiLAogICAgICAgICJhcnRpZmFjdFR5cGUiOiAiTGFrZWhvdXNlIgogICAgICB9CiAgICB9CiAgfQpd",
"payloadType": "InlineBase64"
},
{
"path": "data-access-roles.json",
"payload": "Ww0KICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgIm5hbWUiOiAiZGltZW5zaW9ucnVsZXJlbmFtZSIsDQogICAgICAgICAgICAgICAgImtpbmQiOiAiUG9saWN5IiwNCiAgICAgICAgICAgICAgICAiZGVjaXNpb25SdWxlcyI6IFsNCiAgICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICAgImVmZmVjdCI6ICJQZXJtaXQiLA0KICAgICAgICAgICAgICAgICAgICAicGVybWlzc2lvbiI6IFsNCiAgICAgICAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICAgICAiYXR0cmlidXRlTmFtZSI6ICJQYXRoIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICJhdHRyaWJ1dGVWYWx1ZUluY2x1ZGVkSW4iOiBbDQogICAgICAgICAgICAgICAgICAgICAgICAgICIvVGFibGVzL2Riby9kaW1lbnNpb25fY2l0eSIsDQogICAgICAgICAgICAgICAgICAgICAgICAgICIvVGFibGVzL2Riby9kaW1lbnNpb25fY3VzdG9tZXIiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAiL1RhYmxlcy9kYm8vZGltZW5zaW9uX2RhdGUiLA0KICAgICAgICAgICAgICAgICAgICAgICAgICAiL1RhYmxlcy9kYm8vZGltZW5zaW9uX2VtcGxveWVlIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgIi9UYWJsZXMvZGJvL2RpbWVuc2lvbl9zdG9ja19pdGVtIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICAgIi9UYWJsZXMvYnJvbnplIg0KICAgICAgICAgICAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgICAgICAgICAgIH0sDQogICAgICAgICAgICAgICAgICAgICAgew0KICAgICAgICAgICAgICAgICAgICAgICAgImF0dHJpYnV0ZU5hbWUiOiAiQWN0aW9uIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICJhdHRyaWJ1dGVWYWx1ZUluY2x1ZGVkSW4iOiBbDQogICAgICAgICAgICAgICAgICAgICAgICAgICJSZWFkIg0KICAgICAgICAgICAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgICAgICAgICAgXSwNCiAgICAgICAgICAgICAgICAgICAgImNvbnN0cmFpbnRzIjoge30NCiAgICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgICAgICBdLA0KICAgICAgICAgICAgICAgICJtZW1iZXJzIjogew0KICAgICAgICAgICAgICAgICAgImZhYnJpY0l0ZW1NZW1iZXJzIjogW10sDQogICAgICAgICAgICAgICAgICAgICJtaWNyb3NvZnRFbnRyYU1lbWJlcnMiOiBbDQogICAgICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICAgICAidGVuYW50SWQiOiAiMWU4NTAwMGUtZWUzNS00MTEyLWJkNDYtMmYwMGIzZDk0MTU0IiwNCiAgICAgICAgICAgICAgICAgICAgICAib2JqZWN0SWQiOiAiNWYzZWZkMzctYTZkMi00MzJmLTk5ZmEtNmFkYzI4NDhhNDBhIg0KICAgICAgICAgICAgICAgICAgICB9DQogICAgICAgICAgICAgICAgICBdDQogICAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgICB9LA0KICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgIm5hbWUiOiAiRGVmYXVsdFJlYWRlciIsDQogICAgICAgICAgICAgICAgImtpbmQiOiAiUG9saWN5IiwNCiAgICAgICAgICAgICAgICAiZGVjaXNpb25SdWxlcyI6IFsNCiAgICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICAgImVmZmVjdCI6ICJQZXJtaXQiLA0KICAgICAgICAgICAgICAgICAgICAicGVybWlzc2lvbiI6IFsNCiAgICAgICAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICAgICAiYXR0cmlidXRlTmFtZSI6ICJBY3Rpb24iLA0KICAgICAgICAgICAgICAgICAgICAgICAgImF0dHJpYnV0ZVZhbHVlSW5jbHVkZWRJbiI6IFsNCiAgICAgICAgICAgICAgICAgICAgICAgICAgIlJlYWQiDQogICAgICAgICAgICAgICAgICAgICAgICBdDQogICAgICAgICAgICAgICAgICAgICAgfSwNCiAgICAgICAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICAgICAiYXR0cmlidXRlTmFtZSI6ICJQYXRoIiwNCiAgICAgICAgICAgICAgICAgICAgICAgICJhdHRyaWJ1dGVWYWx1ZUluY2x1ZGVkSW4iOiBbDQogICAgICAgICAgICAgICAgICAgICAgICAgICIqIg0KICAgICAgICAgICAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgICAgIF0sDQogICAgICAgICAgICAgICAgIm1lbWJlcnMiOiB7DQogICAgICAgICAgICAgICAgICAiZmFicmljSXRlbU1lbWJlcnMiOiBbDQogICAgICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICAgICAiaXRlbUFjY2VzcyI6IFsNCiAgICAgICAgICAgICAgICAgICAgICAgICJSZWFkQWxsIg0KICAgICAgICAgICAgICAgICAgICAgIF0sDQogICAgICAgICAgICAgICAgICAgICAgInNvdXJjZVBhdGgiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwLzAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCINCiAgICAgICAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgICAgfQ0KICAgICAgICAgICAgXQ==",
"payloadType": "InlineBase64"
},
{
"path": "alm.settings.json",
"payload": "ew0KICAgICAgICAgICJ2ZXJzaW9uIjogIjEuMC4xIiwNCiAgICAgICAgICAib2JqZWN0VHlwZXMiOiBbDQogICAgICAgICAgICB7DQogICAgICAgICAgICAgICJuYW1lIjogIlNob3J0Y3V0cyIsDQogICAgICAgICAgICAgICJzdGF0ZSI6ICJFbmFibGVkIiwNCiAgICAgICAgICAgICAgInN1Yk9iamVjdFR5cGVzIjogWw0KICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICJuYW1lIjogIlNob3J0Y3V0cy5PbmVMYWtlIiwNCiAgICAgICAgICAgICAgICAgICJzdGF0ZSI6ICJFbmFibGVkIg0KICAgICAgICAgICAgICAgIH0sDQogICAgICAgICAgICAgICAgew0KICAgICAgICAgICAgICAgICAgIm5hbWUiOiAiU2hvcnRjdXRzLkFkbHNHZW4yIiwNCiAgICAgICAgICAgICAgICAgICJzdGF0ZSI6ICJFbmFibGVkIg0KICAgICAgICAgICAgICAgIH0sDQogICAgICAgICAgICAgICAgew0KICAgICAgICAgICAgICAgICAgIm5hbWUiOiAiU2hvcnRjdXRzLkRhdGF2ZXJzZSIsDQogICAgICAgICAgICAgICAgICAic3RhdGUiOiAiRW5hYmxlZCINCiAgICAgICAgICAgICAgICB9LA0KICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICJuYW1lIjogIlNob3J0Y3V0cy5BbWF6b25TMyIsDQogICAgICAgICAgICAgICAgICAic3RhdGUiOiAiRW5hYmxlZCINCiAgICAgICAgICAgICAgICB9LA0KICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICJuYW1lIjogIlNob3J0Y3V0cy5TM0NvbXBhdGlibGUiLA0KICAgICAgICAgICAgICAgICAgInN0YXRlIjogIkVuYWJsZWQiDQogICAgICAgICAgICAgICAgfSwNCiAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAibmFtZSI6ICJTaG9ydGN1dHMuR29vZ2xlQ2xvdWRTdG9yYWdlIiwNCiAgICAgICAgICAgICAgICAgICJzdGF0ZSI6ICJFbmFibGVkIg0KICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgICAgXQ0KICAgICAgICAgICAgfSwNCiAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgIm5hbWUiOiAiRGF0YUFjY2Vzc1JvbGVzIiwNCiAgICAgICAgICAgICAgInN0YXRlIjogIkVuYWJsZWQiDQogICAgICAgICAgICB9DQogICAgICAgICAgXQ0KICAgICAgICB9",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkxha2Vob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiTGFrZWhvdXNlX2NyZWF0ZWRfd2l0aF9kZWZpbml0aW9uIiwKICAgICJkZXNjcmlwdGlvbiI6ICJFeGFtcGxlIGxha2Vob3VzZSB3aXRoIGRlZmluaXRpb24iCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiN2Q2NDE0ZDEtMmM1Ni04OWI2LTQ4NzQtOWM4NDUwMzgxZDJiIgogIH0KfQ==",
"payloadType": "InlineBase64"
}
]
}
}
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
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 |
Lakehouse public definition object. Refer to this article for more details on how to craft a lakehouse definition. |
|
Lakehouse |
Lakehouse definition part object. |
|
Lakehouse |
The lakehouse properties. |
|
Payload |
The type of the definition part payload. Additional payload types may be added over time. |
|
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. |
|
| definition |
The lakehouse public definition. |
|
| 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 (uuid) |
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. |
| Map |
A Map. |
| AnomalyDetector |
An Anomaly Detector. |
| UserDataFunction |
A User Data Function. |
| GraphModel |
A GraphModel. |
| GraphQuerySet |
A Graph QuerySet. |
| SnowflakeDatabase |
A Snowflake Database to store Iceberg tables created from Snowflake account. |
| OperationsAgent |
A OperationsAgent. |
| CosmosDBDatabase |
A Cosmos DB Database. |
| Ontology |
An Ontology. |
| EventSchemaSet |
An EventSchemaSet. |
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. |
LakehouseDefinition
Lakehouse public definition object. Refer to this article for more details on how to craft a lakehouse definition.
| Name | Type | Description |
|---|---|---|
| format |
string |
The format of the item definition. |
| parts |
A list of definition parts. |
LakehouseDefinitionPart
Lakehouse definition part object.
| Name | Type | Description |
|---|---|---|
| path |
string |
The lakehouse part path. |
| payload |
string |
The lakehouse part payload. |
| payloadType |
The payload type. |
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. |
PayloadType
The type of the definition part payload. Additional payload types may be added over time.
| Value | Description |
|---|---|
| InlineBase64 |
Inline Base 64. |
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. |