Dela via

Items - Get Lakehouse

  • Referens
Tjänst:
Lakehouse
API-version:
v1

Returnerar egenskaper för det angivna sjöhuset.

Behörigheter

Anroparen måste ha visningsprogram eller högre arbetsyteroll.

Obligatoriska delegerade omfång

Lakehouse.Read.All eller Lakehouse.ReadWrite.All eller Item.Read.All eller Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Stöd
Användare Ja
Tjänstens huvudnamn och hanterade identiteter Ja

Gränssnitt

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

URI-parametrar

Name I Obligatorisk Typ Description
lakehouseId
 path True

string

uuid

Lakehouse-ID:t.
workspaceId
 path True

string

uuid

Arbetsytans ID.

Svar

Name Typ Description
200 OK

Lakehouse

Begäran har slutförts.
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • ItemNotFound – Det begärda objektet hittades inte.

Exempel

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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"
  }
}

Definitioner

Name Description
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
ItemType

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
Lakehouse

Ett sjöhusobjekt.
LakehouseProperties

Sjöhusets fastigheter.
SqlEndpointProperties

Ett objekt som innehåller egenskaperna för SQL-slutpunkten.
SqlEndpointProvisioningStatus

Statustyp för SQL-slutpunktsetablering. Ytterligare SqlEndpointProvisioningStatus typer kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde Description
Dashboard

PowerBI-instrumentpanel.
DataPipeline

En datapipeline.
Datamart

PowerBI-datamart.
Environment

En miljö.
Eventhouse

Ett eventhouse.
Eventstream

En händelseström.
GraphQLApi

Ett API för GraphQL-objekt.
KQLDashboard

En KQL-instrumentpanel.
KQLDatabase

En KQL-databas.
KQLQueryset

En KQL-frågeuppsättning.
Lakehouse

Ett sjöhus.
MLExperiment

Ett maskininlärningsexperiment.
MLModel

En maskininlärningsmodell.
MirroredDatabase

En speglad databas.
MirroredWarehouse

Ett speglat lager.
MountedDataFactory

En MountedDataFactory.
Notebook

En notebook-fil.
PaginatedReport

Sidnumrerad PowerBI-rapport.
Reflex

En reflex.
Report

PowerBI-rapport.
SQLDatabase

En SQLDatabase.
SQLEndpoint

En SQL-slutpunkt.
SemanticModel

PowerBI-semantisk modell.
SparkJobDefinition

En definition för Spark-jobb.
Warehouse

Ett lager.

Lakehouse

Objekt

Ett sjöhusobjekt.

Name Typ Description
description

string

Objektbeskrivningen.
displayName

string

Objektets visningsnamn.
id

string

uuid

Objekt-ID:t.
properties

LakehouseProperties

Sjöhusets fastigheter.
type

ItemType

Objekttypen.
workspaceId

string

uuid

Arbetsytans ID.

LakehouseProperties

Objekt

Sjöhusets fastigheter.

Name Typ Description
defaultSchema

string

Standardschema för lakehouse. Den här egenskapen returneras endast för schemaaktiverat lakehouse.
oneLakeFilesPath

string

OneLake-sökväg till katalogen Lakehouse-filer.
oneLakeTablesPath

string

OneLake-sökväg till katalogen Lakehouse-tabeller.
sqlEndpointProperties

SqlEndpointProperties

Ett objekt som innehåller egenskaperna för SQL-slutpunkten.

SqlEndpointProperties

Objekt

Ett objekt som innehåller egenskaperna för SQL-slutpunkten.

Name Typ Description
connectionString

string

SQL-slutpunktsanslutningssträng.
id

string

SQL-slutpunkts-ID.
provisioningStatus

SqlEndpointProvisioningStatus

SQL-slutpunktsetableringsstatus.

SqlEndpointProvisioningStatus

Uppräkning

Statustyp för SQL-slutpunktsetablering. Ytterligare SqlEndpointProvisioningStatus typer kan läggas till över tid.

Värde Description
Failed

SQL-slutpunktsetablering misslyckades.
InProgress

SQL-slutpunktsetablering pågår.
Success

SQL-slutpunktsetablering lyckades.