Items - Create Lakehouse

Referência

Serviço:: Lakehouse

Versão da API:: v1

Cria uma casa de lago no espaço de trabalho especificado.
Esta API suporta operações de longa duração (LRO).

Esta API não suporta a criação de uma lakehouse com definição.

Permissões

O chamador deve ter função de colaborador ou superior do espaço de trabalho.

Escopos delegados necessários

Lakehouse.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string uuid	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string	O nome de exibição da casa do lago. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
creationPayload		LakehouseCreationPayload	A carga útil de criação da casa do lago.
description		string	A descrição da casa do lago. O comprimento máximo é de 256 caracteres.

Respostas

Name	Tipo	Description
201 Created	Lakehouse	Criado com sucesso
202 Accepted		Pedido aceite, aprovisionamento lakehouse em curso. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType - O tipo de item é inválido ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado. CorruptedPayload - A carga fornecida está corrompida.

Name

Tipo

Description

201 Created

Lakehouse

Criado com sucesso

202 Accepted

Pedido aceite, aprovisionamento lakehouse em curso.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType - O tipo de item é inválido
ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado.
CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Create a lakehouse example

Create a lakehouse with schema example

Create a lakehouse example

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 201

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

Código de estado:: 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

Pedido de amostra

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
  }
}

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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

Definições

Name	Description
CreateLakehouseRequest	Crie carga útil de solicitação lakehouse.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
Lakehouse	Um item de casa de lago.
LakehouseCreationPayload	(Pré-visualização) carga útil do item Lakehouse. Esta propriedade é atualmente necessária devido ao esquema habilitado lakehouse estar em visualização. Pode tornar-se redundante após a disponibilidade geral (GA).
LakehouseProperties	As propriedades da casa do lago.
SqlEndpointProperties	Um objeto que contém as propriedades do ponto de extremidade SQL.
SqlEndpointProvisioningStatus	O tipo de status de provisionamento de ponto de extremidade SQL. Tipos de `SqlEndpointProvisioningStatus` adicionais podem ser adicionados ao longo do tempo.

CreateLakehouseRequest

Object

Crie carga útil de solicitação lakehouse.

Name	Tipo	Description
creationPayload	LakehouseCreationPayload	A carga útil de criação da casa do lago.
description	string	A descrição da casa do lago. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição da casa do lago. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Uma API para o item GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um caderno.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho de faísca.
Warehouse	Um armazém.

Lakehouse

Object

Um item de casa de lago.

Name	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
id	string uuid	O ID do item.
properties	LakehouseProperties	As propriedades da casa do lago.
type	ItemType	O tipo de item.
workspaceId	string uuid	O ID do espaço de trabalho.

LakehouseCreationPayload

Object

(Pré-visualização) carga útil do item Lakehouse. Esta propriedade é atualmente necessária devido ao esquema habilitado lakehouse estar em visualização. Pode tornar-se redundante após a disponibilidade geral (GA).

Name	Tipo	Description
enableSchemas	boolean	Crie um esquema habilitado para lakehouse quando definido como true. Apenas 'true' é permitido.

LakehouseProperties

Object

As propriedades da casa do lago.

Name	Tipo	Description
defaultSchema	string	Esquema padrão da casa do lago. Esta propriedade é retornada somente para lakehouse habilitado para esquema.
oneLakeFilesPath	string	Caminho do OneLake para o diretório de arquivos do Lakehouse.
oneLakeTablesPath	string	Caminho do OneLake para o diretório de tabelas Lakehouse.
sqlEndpointProperties	SqlEndpointProperties	Um objeto que contém as propriedades do ponto de extremidade SQL.

SqlEndpointProperties

Object

Um objeto que contém as propriedades do ponto de extremidade SQL.

Name	Tipo	Description
connectionString	string	Cadeia de conexão de ponto de extremidade SQL.
id	string	ID do ponto de extremidade SQL.
provisioningStatus	SqlEndpointProvisioningStatus	O status de provisionamento do ponto de extremidade SQL.

SqlEndpointProvisioningStatus

Enumeração

O tipo de status de provisionamento de ponto de extremidade SQL. Tipos de SqlEndpointProvisioningStatus adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Failed	Falha no provisionamento do ponto de extremidade SQL.
InProgress	O provisionamento de ponto de extremidade SQL está em andamento.
Success	O provisionamento de ponto de extremidade SQL foi bem-sucedido.

Partilhar via

Items - Create Lakehouse

Permissões

Escopos delegados necessários

Identidades suportadas pelo Microsoft Entra

Interface

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create a lakehouse example

Pedido de amostra

Resposta da amostra

Create a lakehouse with schema example

Pedido de amostra

Resposta da amostra

Definições

CreateLakehouseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

Lakehouse

LakehouseCreationPayload

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus

Recursos adicionais