Partager via

Items - Get Lakehouse

  • Référence
Service:
Lakehouse
Version d'API:
v1

Retourne les propriétés de la lakehouse spécifiée.

Autorisations

L’appelant doit avoir visionneuse ou un rôle d’espace de travail supérieur.

Étendues déléguées requises

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

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
lakehouseId
 path True

string

uuid

ID lakehouse.
workspaceId
 path True

string

uuid

ID de l’espace de travail.

Réponses

Nom Type Description
200 OK

Lakehouse

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • ItemNotFound : l’élément demandé n’a pas été trouvé.

Exemples

Get a lakehouse example
Get a lakehouse with schema example

Get a lakehouse example

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
  }
}

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
ItemType

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
Lakehouse

Un élément lakehouse.
LakehouseProperties

Les propriétés du lac.
SqlEndpointProperties

Objet contenant les propriétés du point de terminaison SQL.
SqlEndpointProvisioningStatus

Type d’état d’approvisionnement du point de terminaison SQL. Des types SqlEndpointProvisioningStatus supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Dashboard

Tableau de bord PowerBI.
DataPipeline

Un pipeline de données.
Datamart

Datamart PowerBI.
Environment

Environnement.
Eventhouse

Un eventhouse.
Eventstream

Flux d’événements.
GraphQLApi

API pour l’élément GraphQL.
KQLDashboard

Tableau de bord KQL.
KQLDatabase

Base de données KQL.
KQLQueryset

Ensemble de requêtes KQL.
Lakehouse

Un lac.
MLExperiment

Une expérience de Machine Learning.
MLModel

Modèle Machine Learning.
MirroredDatabase

Une base de données mise en miroir.
MirroredWarehouse

Un entrepôt mis en miroir.
MountedDataFactory

Un MountedDataFactory.
Notebook

Un bloc-notes.
PaginatedReport

Rapport paginé PowerBI.
Reflex

Un réflexe.
Report

Rapport PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Point de terminaison SQL.
SemanticModel

Modèle sémantique PowerBI.
SparkJobDefinition

Définition d’un travail Spark.
Warehouse

Un entrepôt.

Lakehouse

Object

Un élément lakehouse.

Nom Type Description
description

string

Description de l’élément.
displayName

string

Nom complet de l’élément.
id

string

uuid

ID d’élément.
properties

LakehouseProperties

Les propriétés du lac.
type

ItemType

Type d’élément.
workspaceId

string

uuid

ID de l’espace de travail.

LakehouseProperties

Object

Les propriétés du lac.

Nom Type Description
defaultSchema

string

Schéma par défaut de la lakehouse. Cette propriété est retournée uniquement pour le lakehouse activé par le schéma.
oneLakeFilesPath

string

Chemin d’accès OneLake au répertoire des fichiers Lakehouse.
oneLakeTablesPath

string

Chemin d’accès OneLake au répertoire des tables Lakehouse.
sqlEndpointProperties

SqlEndpointProperties

Objet contenant les propriétés du point de terminaison SQL.

SqlEndpointProperties

Object

Objet contenant les propriétés du point de terminaison SQL.

Nom Type Description
connectionString

string

Chaîne de connexion de point de terminaison SQL.
id

string

ID de point de terminaison SQL.
provisioningStatus

SqlEndpointProvisioningStatus

État d’approvisionnement du point de terminaison SQL.

SqlEndpointProvisioningStatus

Énumération

Type d’état d’approvisionnement du point de terminaison SQL. Des types SqlEndpointProvisioningStatus supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Failed

Échec de l’approvisionnement de points de terminaison SQL.
InProgress

L’approvisionnement de points de terminaison SQL est en cours.
Success

L’approvisionnement de points de terminaison SQL a réussi.