Compartilhar via

Items - Get Lakehouse

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

Retorna propriedades da lakehouse especificada.

Permissões

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

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

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
lakehouseId
 path True

string

uuid

A ID da lakehouse.
workspaceId
 path True

string

uuid

A ID do workspace.

Respostas

Nome Tipo Description
200 OK

Lakehouse

Solicitação concluída com êxito.
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

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Nome 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 item adicionais podem ser adicionados ao longo do tempo.
Lakehouse

Um item de lakehouse.
LakehouseProperties

As propriedades da lakehouse.
SqlEndpointProperties

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

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

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemType

Enumeração

O tipo do item. Tipos de item 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

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
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 do Spark.
Warehouse

Um armazém.

Lakehouse

Objeto

Um item de lakehouse.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
properties

LakehouseProperties

As propriedades da lakehouse.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

LakehouseProperties

Objeto

As propriedades da lakehouse.

Nome Tipo Description
defaultSchema

string

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

string

Caminho do OneLake para o diretório de arquivos 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

Objeto

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

Nome Tipo Description
connectionString

string

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

string

ID do ponto de extremidade do SQL.
provisioningStatus

SqlEndpointProvisioningStatus

O status de provisionamento do ponto de extremidade do SQL.

SqlEndpointProvisioningStatus

Enumeração

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

Valor Description
Failed

Falha no provisionamento de ponto de extremidade do SQL.
InProgress

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

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