Items - Create Lakehouse

Referencia

Servicio:: Lakehouse

Versión de la API:: v1

Crea una instancia de Lakehouse en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Esta API no admite la creación de una instancia de Lakehouse con definición.

Permisos

El autor de la llamada debe tener rol de colaborador o superior.

Ámbitos delegados necesarios

Lakehouse.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string uuid	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string	Nombre para mostrar de lakehouse. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
creationPayload		LakehouseCreationPayload	Carga de creación de lakehouse.
description		string	Descripción de la casa del lago. La longitud máxima es de 256 caracteres.

Respuestas

Nombre	Tipo	Description
201 Created	Lakehouse	Creado correctamente
202 Accepted		Solicitud aceptada, aprovisionamiento de Lakehouse en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: el tipo de elemento no es válido ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento. CorruptedPayload: la carga proporcionada está dañada.

Nombre

Tipo

Description

201 Created

Lakehouse

Creado correctamente

202 Accepted

Solicitud aceptada, aprovisionamiento de Lakehouse en curso.

Encabezados

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: el tipo de elemento no es válido
ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento.
CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Create a lakehouse example

Create a lakehouse with schema example

Create a lakehouse example

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CreateLakehouseRequest	Cree una carga de solicitud de Lakehouse.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
Lakehouse	Un elemento lakehouse.
LakehouseCreationPayload	(versión preliminar) carga de elementos de Lakehouse. Esta propiedad es necesaria actualmente debido a que el lakehouse habilitado para el esquema está en versión preliminar. Puede ser redundante en disponibilidad general (GA).
LakehouseProperties	Las propiedades de lakehouse.
SqlEndpointProperties	Objeto que contiene las propiedades del punto de conexión de SQL.
SqlEndpointProvisioningStatus	Tipo de estado de aprovisionamiento del punto de conexión de SQL. Se pueden agregar tipos de `SqlEndpointProvisioningStatus` adicionales a lo largo del tiempo.

CreateLakehouseRequest

Object

Cree una carga de solicitud de Lakehouse.

Nombre	Tipo	Description
creationPayload	LakehouseCreationPayload	Carga de creación de lakehouse.
description	string	Descripción de la casa del lago. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar de lakehouse. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Datamart	Datamart de PowerBI.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
Warehouse	Un almacén.

Lakehouse

Object

Un elemento lakehouse.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
id	string uuid	Identificador del elemento.
properties	LakehouseProperties	Las propiedades de lakehouse.
type	ItemType	Tipo de elemento.
workspaceId	string uuid	Identificador del área de trabajo.

LakehouseCreationPayload

Object

(versión preliminar) carga de elementos de Lakehouse. Esta propiedad es necesaria actualmente debido a que el lakehouse habilitado para el esquema está en versión preliminar. Puede ser redundante en disponibilidad general (GA).

Nombre	Tipo	Description
enableSchemas	boolean	Cree un lakehouse habilitado para el esquema cuando se establezca en true. Solo se permite 'true'.

LakehouseProperties

Object

Las propiedades de lakehouse.

Nombre	Tipo	Description
defaultSchema	string	Esquema predeterminado de lakehouse. Esta propiedad solo se devuelve para lakehouse habilitado para el esquema.
oneLakeFilesPath	string	Ruta de acceso de OneLake al directorio de archivos de Lakehouse.
oneLakeTablesPath	string	Ruta de acceso de OneLake al directorio de tablas de Lakehouse.
sqlEndpointProperties	SqlEndpointProperties	Objeto que contiene las propiedades del punto de conexión de SQL.

SqlEndpointProperties

Object

Objeto que contiene las propiedades del punto de conexión de SQL.

Nombre	Tipo	Description
connectionString	string	Cadena de conexión del punto de conexión de SQL.
id	string	Identificador del punto de conexión de SQL.
provisioningStatus	SqlEndpointProvisioningStatus	Estado de aprovisionamiento del punto de conexión de SQL.

SqlEndpointProvisioningStatus

Enumeración

Tipo de estado de aprovisionamiento del punto de conexión de SQL. Se pueden agregar tipos de SqlEndpointProvisioningStatus adicionales a lo largo del tiempo.

Valor	Description
Failed	Error en el aprovisionamiento del punto de conexión de SQL.
InProgress	El aprovisionamiento de puntos de conexión de SQL está en curso.
Success	El aprovisionamiento de puntos de conexión de SQL se realizó correctamente.

Compartir a través de

Items - Create Lakehouse

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a lakehouse example

Solicitud de ejemplo

Respuesta de muestra

Create a lakehouse with schema example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateLakehouseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseCreationPayload

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus

Recursos adicionales