Items - Update Lakehouse

Service:

Lakehouse

API Version:

v1

Updates the properties of the specified lakehouse.

Permissions

The caller must have contributor or higher role on the workspace.

Required Delegated Scopes

Lakehouse.ReadWrite.All or Item.ReadWrite.All

Interface

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

URI Parameters

Name	In	Required	Type	Description
lakehouseId	path	True	string uuid	The lakehouse ID.
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Type	Description
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.

Responses

Name	Type	Description
200 OK	Lakehouse	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found InvalidRequest - Invalid update request

Examples

Update a lakehouse example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Lakehouse_New_Name",
  "description": "A new description for lakehouse."
}

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

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
Lakehouse	A lakehouse item.
LakehouseProperties	The lakehouse properties.
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.
UpdateLakehouseRequest	Update lakehouse request.

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	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	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	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream item.
KQLDataConnection	string	A KQL data connection.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	Lakehouse item.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredWarehouse	string	A MirroredWarehouse item.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse item.

Lakehouse

A lakehouse item.

Name	Type	Description
description	string	The lakehouse description.
displayName	string	The lakehouse display name.
id	string	The lakehouse ID.
properties	LakehouseProperties	The lakehouse properties.
type	ItemType	The lakehouse type.
workspaceId	string	The workspace ID.

LakehouseProperties

The lakehouse properties.

Name	Type	Description
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.

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	SqlEndpointProvisioningStatus	The SQL endpoint provisioning status.

SqlEndpointProvisioningStatus

The SQL endpoint provisioning status type. Additional SqlEndpointProvisioningStatus types may be added over time.

Name	Type	Description
Failed	string	SQL endpoint provisioning failed.
InProgress	string	SQL endpoint provisioning is in progress.
Success	string	SQL endpoint provisioning succeeded.

UpdateLakehouseRequest

Update lakehouse request.

Name	Type	Description
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.