Partilhar via

Items - Get Lakehouse

  • Referência
Serviço:
Lakehouse
Versão da API:
v1

Retorna propriedades da casa do lago especificada.

Permissões

O chamador deve ter visualizador ou superior função de espaço de trabalho.

Escopos delegados necessários

Lakehouse.Read.All ou Lakehouse.ReadWrite.All ou Item.Read.All ou Item.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Suporte
Utilizador Sim
da entidade de serviço e identidades gerenciadas Sim

Interface

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

Parâmetros do URI

Name Em Necessário Tipo Description
lakehouseId
 path True

string

uuid

O ID da casa do lago.
workspaceId
 path True

string

uuid

O ID do espaço de trabalho.

Respostas

Name Tipo Description
200 OK

Lakehouse

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

Exemplos

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
  }
}

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemType

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
Lakehouse

Um item de casa de lago.
LakehouseProperties

As propriedades da casa do lago.
SqlEndpointProperties

Um objeto que contém as propriedades do ponto de extremidade SQL.
SqlEndpointProvisioningStatus

O tipo de status de provisionamento de ponto de extremidade SQL. Tipos de SqlEndpointProvisioningStatus adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Uma API para o item GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um caderno.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho de faísca.
Warehouse

Um armazém.

Lakehouse

Object

Um item de casa de lago.

Name Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

O ID do item.
properties

LakehouseProperties

As propriedades da casa do lago.
type

ItemType

O tipo de item.
workspaceId

string

uuid

O ID do espaço de trabalho.

LakehouseProperties

Object

As propriedades da casa do lago.

Name Tipo Description
defaultSchema

string

Esquema padrão da casa do lago. Esta propriedade é retornada somente para lakehouse habilitado para esquema.
oneLakeFilesPath

string

Caminho do OneLake para o diretório de arquivos do Lakehouse.
oneLakeTablesPath

string

Caminho do OneLake para o diretório de tabelas Lakehouse.
sqlEndpointProperties

SqlEndpointProperties

Um objeto que contém as propriedades do ponto de extremidade SQL.

SqlEndpointProperties

Object

Um objeto que contém as propriedades do ponto de extremidade SQL.

Name Tipo Description
connectionString

string

Cadeia de conexão de ponto de extremidade SQL.
id

string

ID do ponto de extremidade SQL.
provisioningStatus

SqlEndpointProvisioningStatus

O status de provisionamento do ponto de extremidade SQL.

SqlEndpointProvisioningStatus

Enumeração

O tipo de status de provisionamento de ponto de extremidade SQL. Tipos de SqlEndpointProvisioningStatus adicionais podem ser adicionados ao longo do tempo.

Valor Description
Failed

Falha no provisionamento do ponto de extremidade SQL.
InProgress

O provisionamento de ponto de extremidade SQL está em andamento.
Success

O provisionamento de ponto de extremidade SQL foi bem-sucedido.