Compartir a través de

Items - Get Lakehouse

  • Referencia
Servicio:
Lakehouse
Versión de la API:
v1

Devuelve las propiedades del lago especificado.

Permisos

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

Lakehouse.Read.All o Lakehouse.ReadWrite.All o Item.Read.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

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
lakehouseId
 path True

string

uuid

Identificador de lakehouse.
workspaceId
 path True

string

uuid

Identificador del área de trabajo.

Respuestas

Nombre Tipo Description
200 OK

Lakehouse

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • ItemNotFound: no se encontró el elemento solicitado.

Ejemplos

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

Solicitud de ejemplo

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

Respuesta de muestra

status code:
200 
{
  "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"
    }
  }
}

Get a lakehouse with schema example

Solicitud de ejemplo

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses/5b218778-e7a5-4d73-8187-f10824047715

Respuesta de muestra

status code:
200 
{
  "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"
  }
}

Definiciones

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

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.

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.