Items - Create Lakehouse

Référence

Service:: Lakehouse

Version d'API:: v1

Crée un lakehouse dans l’espace de travail spécifié.
Cette API prend en charge opérations longues (LRO).

Cette API ne prend pas en charge la création d’un lakehouse avec une définition.

Autorisations

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Lakehouse.ReadWrite.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

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string uuid	ID de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
displayName	True	string	Nom complet de lakehouse. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
creationPayload		LakehouseCreationPayload	Charge utile de création de lakehouse.
description		string	Description du lac. La longueur maximale est de 256 caractères.

Réponses

Nom	Type	Description
201 Created	Lakehouse	Création réussie
202 Accepted		Demande acceptée, provisionnement lakehouse en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidItemType - Le type d’élément n’est pas valide ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé. CorruptedPayload : la charge utile fournie est endommagée.

Nom

Type

Description

201 Created

Lakehouse

Création réussie

202 Accepted

Demande acceptée, provisionnement lakehouse en cours.

En-têtes

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidItemType - Le type d’élément n’est pas valide
ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé.
CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Create a lakehouse example

Create a lakehouse with schema example

Create a lakehouse example

Exemple de requête

HTTP

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

{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description"
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Code d’état:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a lakehouse with schema example

Exemple de requête

HTTP

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

{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "creationPayload": {
    "enableSchemas": true
  }
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "Lakehouse_created_with_schema",
  "description": "A schema enabled lakehouse.",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Code d’état:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Définitions

Nom	Description
CreateLakehouseRequest	Créez une charge utile de requête lakehouse.
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.
LakehouseCreationPayload	(préversion) charge utile de l’élément Lakehouse. Cette propriété est actuellement requise en raison du schéma activé lakehouse en préversion. Il peut devenir redondant lors de la disponibilité générale (GA).
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.

CreateLakehouseRequest

Object

Créez une charge utile de requête lakehouse.

Nom	Type	Description
creationPayload	LakehouseCreationPayload	Charge utile de création de lakehouse.
description	string	Description du lac. La longueur maximale est de 256 caractères.
displayName	string	Nom complet de lakehouse. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.

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.

LakehouseCreationPayload

Object

(préversion) charge utile de l’élément Lakehouse. Cette propriété est actuellement requise en raison du schéma activé lakehouse en préversion. Il peut devenir redondant lors de la disponibilité générale (GA).

Nom	Type	Description
enableSchemas	boolean	Créez un lakehouse activé pour un schéma lorsqu’il est défini sur true. Seule la valeur « true » est autorisée.

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.

Partager via

Items - Create Lakehouse

Autorisations

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Create a lakehouse example

Exemple de requête

Exemple de réponse

Create a lakehouse with schema example

Exemple de requête

Exemple de réponse

Définitions

CreateLakehouseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseCreationPayload

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus

Ressources supplémentaires