Поделиться через

Items - Create Lakehouse

Служба:
Lakehouse
Версия API:
v1

Создает lakehouse в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).

Этот API не поддерживает создание lakehouse с определением.

Разрешения

Вызывающий объект должен иметь роль рабочей области участника .

Обязательные делегированные области

Lakehouse.ReadWrite.All или Item.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Тождество Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя Lakehouse. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
creationPayload

LakehouseCreationPayload

Полезные данные создания lakehouse.
description

string

Описание lakehouse. Максимальная длина — 256 символов.
folderId

string (uuid)

Идентификатор папки. Если не указано или не задано значение NULL, lakehouse создается с рабочей областью в качестве папки.

Ответы

Имя Тип Описание
201 Created

Lakehouse

Успешно создано
202 Accepted

Запрос принят, подготовка Lakehouse выполняется.

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • InvalidItemType — тип элемента недопустим

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.

  • Поврежденный Payload — предоставленные полезные данные повреждены.

  • WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a lakehouse example
Create a lakehouse with schema example

Create a lakehouse example

Образец запроса

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

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

Пример ответа

Код состояния:
201 
{
  "displayName": "Lakehouse_1",
  "description": "A lakehouse description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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"
}
Код состояния:
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

Определения

Имя Описание
CreateLakehouseRequest

Создание полезных данных запроса lakehouse.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
ItemTag

Представляет тег, примененный к элементу.
ItemType

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Lakehouse

Элемент Lakehouse.
LakehouseCreationPayload

(предварительная версия) полезных данных элемента Lakehouse. Это свойство в настоящее время требуется из-за включенной схемы lakehouse в предварительной версии. Она может стать избыточной при общедоступной доступности.
LakehouseProperties

Свойства lakehouse.
SqlEndpointProperties

Объект, содержащий свойства конечной точки SQL.
SqlEndpointProvisioningStatus

Тип состояния подготовки конечной точки SQL. С течением времени могут добавляться дополнительные SqlEndpointProvisioningStatus типы.

CreateLakehouseRequest

Object

Создание полезных данных запроса lakehouse.

Имя Тип Описание
creationPayload

LakehouseCreationPayload

Полезные данные создания lakehouse.
description

string

Описание lakehouse. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя Lakehouse. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId

string (uuid)

Идентификатор папки. Если не указано или не задано значение NULL, lakehouse создается с рабочей областью в качестве папки.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

ItemTag

Object

Представляет тег, примененный к элементу.

Имя Тип Описание
displayName

string

Имя тега.
id

string (uuid)

Идентификатор тега.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение Описание
ApacheAirflowJob

An ApacheAirflowJob.
CopyJob

Задание копирования.
Dashboard

Панель мониторинга PowerBI.
DataPipeline

Конвейер данных.
Dataflow

Поток данных.
Datamart

Datamart PowerBI.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Поток Конструктора цифровых двойников.
Environment

Среда.
Eventhouse

Хранилище событий.
Eventstream

Поток событий.
GraphQLApi

API для элемента GraphQL.
KQLDashboard

Панель мониторинга KQL.
KQLDatabase

База данных KQL.
KQLQueryset

Набор запросов KQL.
Lakehouse

Озеро.
MLExperiment

Эксперимент машинного обучения.
MLModel

Модель машинного обучения.
MirroredAzureDatabricksCatalog

Зеркальный каталог azure databricks.
MirroredDatabase

Зеркальная база данных.
MirroredWarehouse

Зеркальный склад.
MountedDataFactory

ПодключеннаяdataFactory.
Notebook

Записная книжка.
PaginatedReport

Отчет с разбивкой на страницы PowerBI.
Reflex

Рефлекс.
Report

Отчет PowerBI.
SQLDatabase

База данных SQLDatabase.
SQLEndpoint

Конечная точка SQL.
SemanticModel

Семантическая модель PowerBI.
SparkJobDefinition

Определение задания Spark.
VariableLibrary

ПеременнаяLibrary.
Warehouse

Склад.
WarehouseSnapshot

Моментальный снимок хранилища.

Lakehouse

Object

Элемент Lakehouse.

Имя Тип Описание
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
folderId

string (uuid)

Идентификатор папки.
id

string (uuid)

Идентификатор элемента.
properties

LakehouseProperties

Свойства lakehouse.
tags

ItemTag[]

Список примененных тегов.
type

ItemType

Тип элемента.
workspaceId

string (uuid)

Идентификатор рабочей области.

LakehouseCreationPayload

Object

(предварительная версия) полезных данных элемента Lakehouse. Это свойство в настоящее время требуется из-за включенной схемы lakehouse в предварительной версии. Она может стать избыточной при общедоступной доступности.

Имя Тип Описание
enableSchemas

boolean

Создайте схему, включенную lakehouse, если задано значение true. Допускается только значение true.

LakehouseProperties

Object

Свойства lakehouse.

Имя Тип Описание
defaultSchema

string

Схема озера по умолчанию. Это свойство возвращается только для озера с поддержкой схемы.
oneLakeFilesPath

string

Путь OneLake к каталогу файлов Lakehouse.
oneLakeTablesPath

string

Путь OneLake к каталогу таблиц Lakehouse.
sqlEndpointProperties

SqlEndpointProperties

Объект, содержащий свойства конечной точки SQL.

SqlEndpointProperties

Object

Объект, содержащий свойства конечной точки SQL.

Имя Тип Описание
connectionString

string

Строка подключения конечной точки SQL.
id

string

Идентификатор конечной точки SQL.
provisioningStatus

SqlEndpointProvisioningStatus

Состояние подготовки конечной точки SQL.

SqlEndpointProvisioningStatus

Перечисление

Тип состояния подготовки конечной точки SQL. С течением времени могут добавляться дополнительные SqlEndpointProvisioningStatus типы.

Значение Описание
Failed

Сбой подготовки конечной точки SQL.
InProgress

Подготовка конечной точки SQL выполняется.
Success

Подготовка конечной точки SQL завершилась успешно.