Items - Get Lakehouse

Служба:: Lakehouse

Версия API:: v1

Возвращает свойства указанного lakehouse.

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
lakehouseId	path	True	string (uuid)	Идентификатор lakehouse.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Ответы

Имя	Тип	Описание
200 OK	Lakehouse	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден.

Имя

Тип

Описание

200 OK

Lakehouse

Запрос успешно завершен.

Other Status Codes

ErrorResponse

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

ItemNotFound — запрошенный элемент не найден.

Примеры

Get a lakehouse example

Get a lakehouse with schema example

Get a lakehouse example

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

HTTP

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

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

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

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

HTTP

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

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

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

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Lakehouse	Элемент Lakehouse.
LakehouseProperties	Свойства lakehouse.
SqlEndpointProperties	Объект, содержащий свойства конечной точки SQL.
SqlEndpointProvisioningStatus	Тип состояния подготовки конечной точки SQL. С течением времени могут добавляться дополнительные `SqlEndpointProvisioningStatus` типы.

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)	Идентификатор рабочей области.

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 завершилась успешно.

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

Items - Get Lakehouse

Разрешения

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

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

Интерфейс

Параметры URI

Ответы

Примеры

Get a lakehouse example

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

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

Get a lakehouse with schema example

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

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

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Lakehouse

LakehouseProperties

SqlEndpointProperties

SqlEndpointProvisioningStatus