Items - Get Lakehouse
Returns properties of the specified lakehouse.
The caller must have viewer or higher workspace role.
Lakehouse.Read.All or Lakehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal | Yes |
Managed identities | Yes |
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}
Name | In | Required | Type | Description |
---|---|---|---|---|
lakehouse
|
path | True |
string uuid |
The lakehouse ID. |
workspace
|
path | True |
string uuid |
The workspace ID. |
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Sample request
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715
Sample response
{
"displayName": "Lakehouse_1",
"description": "A lakehouse description.",
"type": "Lakehouse",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"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"
}
}
}
Sample request
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715
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",
"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"
},
"defaultSchema": "dbo"
}
}
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. |
Sql |
An object containing the properties of the SQL endpoint. |
Sql |
The SQL endpoint provisioning status type. Additional |
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. |
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. |
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. |
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. |
KQLDashboard |
string |
A KQL dashboard. |
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. |
MirroredDatabase |
string |
A mirrored database. |
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. |
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. |
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. |
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. |
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. |