Condividi tramite

Items - Get Lakehouse

  • Riferimento
Servizio:
Lakehouse
Versione API:
v1

Restituisce le proprietà del lakehouse specificato.

Autorizzazioni

Il chiamante deve avere ruolo visualizzatore o superiore.

Ambiti delegati obbligatori

Lakehouse.Read.All o Lakehouse.ReadWrite.All o Item.Read.All o Item.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Appoggiare
Utente Sì
'entità servizio e identità gestite Sì

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
lakehouseId
 path True

string

uuid

ID lakehouse.
workspaceId
 path True

string

uuid

ID dell'area di lavoro.

Risposte

Nome Tipo Descrizione
200 OK

Lakehouse

Richiesta completata correttamente.
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
  }
}

Definizioni

Nome Descrizione
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
ItemType

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
Lakehouse

Un elemento lakehouse.
LakehouseProperties

Proprietà del lago.
SqlEndpointProperties

Oggetto contenente le proprietà dell'endpoint SQL.
SqlEndpointProvisioningStatus

Tipo di stato del provisioning dell'endpoint SQL. È possibile aggiungere altri tipi di SqlEndpointProvisioningStatus nel tempo.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string

ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

ItemType

Enumeration

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore Descrizione
Dashboard

Dashboard di Power BI.
DataPipeline

Una pipeline di dati.
Datamart

Datamart di PowerBI.
Environment

Un ambiente.
Eventhouse

Una casa eventi.
Eventstream

Flusso di eventi.
GraphQLApi

API per l'elemento GraphQL.
KQLDashboard

Dashboard KQL.
KQLDatabase

Un database KQL.
KQLQueryset

Set di query KQL.
Lakehouse

Una lakehouse.
MLExperiment

Esperimento di Machine Learning.
MLModel

Modello di Machine Learning.
MirroredDatabase

Database con mirroring.
MirroredWarehouse

Magazzino con mirroring.
MountedDataFactory

Oggetto MountedDataFactory.
Notebook

Un notebook.
PaginatedReport

Report impaginato di Power BI.
Reflex

Un riflesso.
Report

Report di Power BI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Endpoint SQL.
SemanticModel

Modello semantico di PowerBI.
SparkJobDefinition

Definizione di processo Spark.
Warehouse

Un magazzino.

Lakehouse

Object

Un elemento lakehouse.

Nome Tipo Descrizione
description

string

Descrizione dell'elemento.
displayName

string

Nome visualizzato dell'elemento.
id

string

uuid

ID elemento.
properties

LakehouseProperties

Proprietà del lago.
type

ItemType

Tipo di elemento.
workspaceId

string

uuid

ID dell'area di lavoro.

LakehouseProperties

Object

Proprietà del lago.

Nome Tipo Descrizione
defaultSchema

string

Schema predefinito della lakehouse. Questa proprietà viene restituita solo per la lakehouse abilitata per lo schema.
oneLakeFilesPath

string

Percorso di OneLake alla directory dei file Lakehouse.
oneLakeTablesPath

string

Percorso di OneLake alla directory tabelle Lakehouse.
sqlEndpointProperties

SqlEndpointProperties

Oggetto contenente le proprietà dell'endpoint SQL.

SqlEndpointProperties

Object

Oggetto contenente le proprietà dell'endpoint SQL.

Nome Tipo Descrizione
connectionString

string

Stringa di connessione dell'endpoint SQL.
id

string

ID endpoint SQL.
provisioningStatus

SqlEndpointProvisioningStatus

Stato del provisioning dell'endpoint SQL.

SqlEndpointProvisioningStatus

Enumeration

Tipo di stato del provisioning dell'endpoint SQL. È possibile aggiungere altri tipi di SqlEndpointProvisioningStatus nel tempo.

Valore Descrizione
Failed

Provisioning dell'endpoint SQL non riuscito.
InProgress

Il provisioning degli endpoint SQL è in corso.
Success

Provisioning dell'endpoint SQL completato.