Compartilhar via

Items - Create Lakehouse

  • Referência
Serviço:
Lakehouse
Versão da API:
v1

Cria uma lakehouse no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Essa API não dá suporte à criação de um lakehouse com definição.

Permissões

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

Escopos delegados necessários

Lakehouse.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string

uuid

A ID do workspace.

Corpo da solicitação

Nome Obrigatório Tipo Description
displayName True

string

O nome de exibição do lakehouse. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
creationPayload

LakehouseCreationPayload

O conteúdo da criação do lakehouse.
description

string

A descrição da lakehouse. O comprimento máximo é de 256 caracteres.

Respostas

Nome Tipo Description
201 Created

Lakehouse

Criado com êxito
202 Accepted

Solicitação aceita, provisionamento de lakehouse em andamento.

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á está sendo usado.

  • CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Create a lakehouse example
Create a lakehouse with schema example

Create a lakehouse example

Solicitação de exemplo

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

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

Resposta de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Nome Description
CreateLakehouseRequest

Crie o conteúdo da 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 item adicionais podem ser adicionados ao longo do tempo.
Lakehouse

Um item de lakehouse.
LakehouseCreationPayload

(versão prévia) carga de item do Lakehouse. No momento, essa propriedade é necessária devido ao esquema habilitado para lakehouse estar em versão prévia. Ele pode se tornar redundante após GA (Disponibilidade Geral).
LakehouseProperties

As propriedades da lakehouse.
SqlEndpointProperties

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

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

CreateLakehouseRequest

Objeto

Crie o conteúdo da solicitação lakehouse.

Nome Tipo Description
creationPayload

LakehouseCreationPayload

O conteúdo da criação do lakehouse.
description

string

A descrição da lakehouse. O comprimento máximo é de 256 caracteres.
displayName

string

O nome de exibição do lakehouse. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemType

Enumeração

O tipo do item. Tipos de item 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

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
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 do Spark.
Warehouse

Um armazém.

Lakehouse

Objeto

Um item de lakehouse.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
properties

LakehouseProperties

As propriedades da lakehouse.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

LakehouseCreationPayload

Objeto

(versão prévia) carga de item do Lakehouse. No momento, essa propriedade é necessária devido ao esquema habilitado para lakehouse estar em versão prévia. Ele pode se tornar redundante após GA (Disponibilidade Geral).

Nome Tipo Description
enableSchemas

boolean

Crie um lakehouse habilitado para esquema quando definido como true. Somente "true" é permitido.

LakehouseProperties

Objeto

As propriedades da lakehouse.

Nome Tipo Description
defaultSchema

string

Esquema padrão da casa do lago. Essa propriedade é retornada apenas para lakehouse habilitado para esquema.
oneLakeFilesPath

string

Caminho do OneLake para o diretório de arquivos 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

Objeto

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

Nome Tipo Description
connectionString

string

Cadeia de conexão do ponto de extremidade DO SQL.
id

string

ID do ponto de extremidade do SQL.
provisioningStatus

SqlEndpointProvisioningStatus

O status de provisionamento do ponto de extremidade do SQL.

SqlEndpointProvisioningStatus

Enumeração

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

Valor Description
Failed

Falha no provisionamento de ponto de extremidade do SQL.
InProgress

O provisionamento de ponto de extremidade do SQL está em andamento.
Success

O provisionamento de ponto de extremidade do SQL foi bem-sucedido.