Items - List Lakehouses
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
Interface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses?continuationToken={continuationToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
continuation
|
query |
string |
A token for retrieving the next page of results. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Examples
List lakehouses in workspace example
Sample request
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses
Sample response
{
"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 |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
The type of the item. Additional item types may be added over time. |
Lakehouse |
A lakehouse item. |
Lakehouse |
The lakehouse properties. |
Lakehouses |
A list of lakehouses. |
Sql |
An object containing the properties of the SQL endpoint. |
Sql |
The SQL endpoint provisioning status type. Additional |
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. |
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. |
Environment |
string |
An environment. |
Eventhouse |
string |
An eventhouse. |
Eventstream |
string |
An eventstream. |
KQLDatabase |
string |
A KQL database. |
KQLQueryset |
string |
A KQL queryset. |
Lakehouse |
string |
A lakehouse. |
MLExperiment |
string |
A machine learning experiment. |
MLModel |
string |
A machine learning model. |
MirroredWarehouse |
string |
A mirrored warehouse. |
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. |
Lakehouse
A lakehouse item.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
properties |
The lakehouse properties. |
|
type |
The item 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 |
An object containing the properties of the SQL endpoint. |
Lakehouses
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 |
A list of lakehouses. |
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.
Name | Type | Description |
---|---|---|
Failed |
string |
SQL endpoint provisioning failed. |
InProgress |
string |
SQL endpoint provisioning is in progress. |
Success |
string |
SQL endpoint provisioning succeeded. |