Items - List Lakehouses

Reference

Service:: Lakehouse

API Version:: v1

Returns a list of lakehouses from the specified workspace.
This API supports pagination.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.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

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

With optional parameters:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	Lakehouses	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Invalid item type

Name

Type

Description

200 OK

Lakehouses

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

InvalidItemType - Invalid item type

Examples

List lakehouses in workspace example

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse_1",
      "description": "A lakehouse description.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
        "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Files",
        "sqlEndpointProperties": {
          "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
          "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
          "provisioningStatus": "Success"
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Lakehouse_2",
      "description": "A lakehouse description.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/fc5d0537-1b22-4de1-a5e9-9b8bb58ed1e1/6dc325f6-46f6-4a2a-930b-10b96a463566/Tables",
        "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/fc5d0537-1b22-4de1-a5e9-9b8bb58ed1e1/6dc325f6-46f6-4a2a-930b-10b96a463566/Files",
        "sqlEndpointProperties": {
          "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
          "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
          "provisioningStatus": "Success"
        }
      }
    }
  ]
}

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.
Lakehouses	A list of lakehouses.
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.

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

ItemType

Enumeration

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

Value	Description
Dashboard	PowerBI dashboard.
DataPipeline	A data pipeline.
Datamart	PowerBI datamart.
Environment	An environment.
Eventhouse	An eventhouse.
Eventstream	An eventstream.
GraphQLApi	An API for GraphQL item.
KQLDashboard	A KQL dashboard.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
Lakehouse	A lakehouse.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
MirroredDatabase	A mirrored database.
MirroredWarehouse	A mirrored warehouse.
MountedDataFactory	A MountedDataFactory.
Notebook	A notebook.
PaginatedReport	PowerBI paginated report.
Reflex	A Reflex.
Report	PowerBI report.
SQLEndpoint	An SQL endpoint.
SemanticModel	PowerBI semantic model.
SparkJobDefinition	A spark job definition.
Warehouse	A warehouse.

Lakehouse

Object

A lakehouse item.

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

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.

Lakehouses

Object

A list of lakehouses.

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	Lakehouse[]	A list of lakehouses.

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
Failed	SQL endpoint provisioning failed.
InProgress	SQL endpoint provisioning is in progress.
Success	SQL endpoint provisioning succeeded.

Partager via

Items - List Lakehouses

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

List lakehouses in workspace example

Sample request

Sample response

Definitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseProperties

Lakehouses

SqlEndpointProperties

SqlEndpointProvisioningStatus

Ressources supplémentaires