編集

次の方法で共有

Items - Create Lakehouse

  • Reference
Service:
Lakehouse
API Version:
v1

Creates a lakehouse in the specified workspace.
This API supports long running operations (LRO).

This API does not support create a lakehouse with definition.

Permissions

The caller must have contributor or higher workspace role.

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string

uuid

The workspace ID.

Request Body

Name Required Type Description
displayName True

string

The lakehouse display name. The display name must follow naming rules according to item type.
creationPayload

LakehouseCreationPayload

The lakehouse creation payload.
description

string

The lakehouse description. Maximum length is 256 characters.

Responses

Name Type Description
201 Created

Lakehouse

Successfully created
202 Accepted

Request accepted, lakehouse provisioning in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid

  • ItemDisplayNameAlreadyInUse - Item display name is already used.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Create a lakehouse example
Create a lakehouse with schema example

Create a lakehouse example

Sample request

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

{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description"
}

Sample response

Status code:
201 
{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description",
  "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/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a lakehouse with schema example

Sample request

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

{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "creationPayload": {
    "enableSchemas": true
  }
}

Sample response

Status code:
201 
{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled 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/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name Description
CreateLakehouseRequest

Create lakehouse request payload.
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.
LakehouseCreationPayload

(Preview) Lakehouse item payload. This property is currently required due to the schema enabled lakehouse being in preview. It might become redundant upon General Availability (GA).
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.

CreateLakehouseRequest

Create lakehouse request payload.

Name Type Description
creationPayload

LakehouseCreationPayload

The lakehouse creation payload.
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.

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

string

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

LakehouseProperties

The lakehouse properties.
type

ItemType

The item type.
workspaceId

string

The workspace ID.

LakehouseCreationPayload

(Preview) Lakehouse item payload. This property is currently required due to the schema enabled lakehouse being in preview. It might become redundant upon General Availability (GA).

Name Type Description
enableSchemas

boolean

Create a schema enabled lakehouse when set to true. Only 'true' is allowed.

LakehouseProperties

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.

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.