Items - List Lakehouses

Referens

Tjänst:: Lakehouse

API-version:: v1

Returnerar en lista över lakehouses från den angivna arbetsytan.
Det här API:et stöder sidnumrering.

Behörigheter

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

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.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

Med valfria parametrar:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses?continuationToken={continuationToken}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string uuid	Arbetsytans ID.
continuationToken	query		string	En token för att hämta nästa sida med resultat.

Svar

Name	Typ	Description
200 OK	Lakehouses	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Ogiltig objekttyp

Name

Typ

Description

200 OK

Lakehouses

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Ogiltig objekttyp

Exempel

List lakehouses in workspace example

Exempelbegäran

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/lakehouses

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Lakehouse_1",
      "description": "A lakehouse description.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "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"
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Lakehouse_2",
      "description": "A lakehouse description.",
      "type": "Lakehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/fc5d0537-1b22-4de1-a5e9-9b8bb58ed1e1/6dc325f6-46f6-4a2a-930b-10b96a463566/Tables",
        "oneLakeFilesPath": "https://onelake.dfs.fabric.microsoft.com/fc5d0537-1b22-4de1-a5e9-9b8bb58ed1e1/6dc325f6-46f6-4a2a-930b-10b96a463566/Files",
        "sqlEndpointProperties": {
          "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
          "id": "37dc8a41-dea9-465d-b528-3e95043b2356",
          "provisioningStatus": "Success"
        }
      }
    }
  ]
}

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.
Lakehouses	En lista över sjöhus.
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.

Lakehouses

Objekt

En lista över sjöhus.

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	Lakehouse[]	En lista över sjöhus.

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.

Dela via

Items - List Lakehouses

Behörigheter

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svar

Exempel

List lakehouses in workspace example

Exempelbegäran

Exempelsvar

Definitioner

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseProperties

Lakehouses

SqlEndpointProperties

SqlEndpointProvisioningStatus

Ytterligare resurser