Items - Update Lakehouse Definition

Service:: Lakehouse

API Version:: v1

Overrides the definition for the specified lakehouse.
This API supports long running operations (LRO).

Updating the lakehouse's definition does not affect its sensitivity label.

Permissions

The caller must have read and write permissions for the lakehouse.

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/{lakehouseId}/updateDefinition

With optional parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/updateDefinition?updateMetadata={updateMetadata}

URI Parameters

Name	In	Required	Type	Description
lakehouseId	path	True	string (uuid)	The lakehouse ID.
workspaceId	path	True	string (uuid)	The workspace ID.
updateMetadata	query		boolean	When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file

Request Body

Name	Required	Type	Description
definition	True	LakehouseDefinition	Lakehouse public definition object. Refer to this article for more details on how to craft a lakehouse definition.

Responses

Name	Type	Description
200 OK	Lakehouse	Request completed successfully.
202 Accepted		Request accepted. Update definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item. CorruptedPayload - The provided payload is corrupted.

Examples

Update a lakehouse public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Status code:: 200

{
  "displayName": "Lakehouse_New_Name",
  "description": "A new description for lakehouse.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
Lakehouse	A lakehouse item.
LakehouseDefinition	Lakehouse public definition object. Refer to this article for more details on how to craft a lakehouse definition.
LakehouseDefinitionPart	Lakehouse definition part object.
LakehouseProperties	The lakehouse properties.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
SensitivityLabel	Represents a sensitivity label applied to an item.
SqlEndpointProperties	An object containing the properties of the SQL endpoint.
SqlEndpointProvisioningStatus	The SQL endpoint provisioning status type. Additional `SqlEndpointProvisioningStatus` types may be added over time.
UpdateLakehouseDefinitionRequest	Update Lakehouse public definition request payload.

ErrorRelatedResource

Object

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

Object

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	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

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	ErrorRelatedResource	The error related resource details.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

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.
DataAgent	A DataAgent.

Lakehouse

Object

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	LakehouseProperties	The lakehouse properties.
sensitivityLabel	SensitivityLabel	The item sensitivity label.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

LakehouseDefinition

Object

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	LakehouseDefinitionPart[]	A list of definition parts.

LakehouseDefinitionPart

Object

Lakehouse definition part object.

Name	Type	Description
path	string	The lakehouse part path.
payload	string	The lakehouse part payload.
payloadType	PayloadType	The payload type.

LakehouseProperties

Object

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	SqlEndpointProperties	An object containing the properties of the SQL endpoint.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.

SensitivityLabel

Object

Represents a sensitivity label applied to an item.

Name	Type	Description
id	string (uuid)	The sensitivity label ID.

SqlEndpointProperties

Object

An object containing the properties of the SQL endpoint.

Name	Type	Description
connectionString	string	SQL endpoint connection string.
id	string	SQL endpoint ID.
provisioningStatus	SqlEndpointProvisioningStatus	The SQL endpoint provisioning status.

SqlEndpointProvisioningStatus

Enumeration

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.

UpdateLakehouseDefinitionRequest

Object

Update Lakehouse public definition request payload.

Name	Type	Description
definition	LakehouseDefinition	Lakehouse public definition object. Refer to this article for more details on how to craft a lakehouse definition.

Share via

Items - Update Lakehouse Definition

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Update a lakehouse public definition example

Sample request

Sample response

Definitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Lakehouse

LakehouseDefinition

LakehouseDefinitionPart

LakehouseProperties

PayloadType

SensitivityLabel

SqlEndpointProperties

SqlEndpointProvisioningStatus

UpdateLakehouseDefinitionRequest