Items - Get Warehouse

Служба:

Warehouse

Версия API:

v1

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

Разрешения

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

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

Warehouse.Read.All или Warehouse.ReadWrite.All или Item.Read.All или Item.ReadWrite.All

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

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

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

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}

Параметры URI

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

Ответы

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

Примеры

Get a warehouse example

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

HTTP

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

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

Код состояния:

200

{
  "displayName": "Warehouse 1",
  "description": "A warehouse description.",
  "type": "Warehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
    "createdDate": "2023-09-28T22:52:13.78",
    "lastUpdatedTime": "2023-10-04T22:56:33.283",
    "collationType": "Latin1_General_100_BIN2_UTF8"
  }
}

Определения

Имя	Описание
CollationType	Параметры сортировки хранилища. С течением времени можно добавить дополнительные collations.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Warehouse	Объект хранилища.
WarehouseProperties	Свойства элемента хранилища.

CollationType

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

Параметры сортировки хранилища. С течением времени можно добавить дополнительные collations.

Значение	Описание
Latin1_General_100_BIN2_UTF8	Значение по умолчанию — параметры сортировки с учетом регистра (CS)
Latin1_General_100_CI_AS_KS_WS_SC_UTF8	Параметры сортировки без учета регистра (CI)

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	Сведения об ошибках, связанных с ресурсом.

ItemType

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

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

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
DataPipeline	Конвейер данных.
Datamart	Datamart PowerBI.
Environment	Среда.
Eventhouse	Хранилище событий.
Eventstream	Поток событий.
GraphQLApi	API для элемента GraphQL.
KQLDashboard	Панель мониторинга KQL.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
Lakehouse	Озеро.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
MirroredDatabase	Зеркальная база данных.
MirroredWarehouse	Зеркальный склад.
MountedDataFactory	ПодключеннаяdataFactory.
Notebook	Записная книжка.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Reflex	Рефлекс.
Report	Отчет PowerBI.
SQLDatabase	База данных SQLDatabase.
SQLEndpoint	Конечная точка SQL.
SemanticModel	Семантическая модель PowerBI.
SparkJobDefinition	Определение задания Spark.
Warehouse	Склад.

Warehouse

Object

Объект хранилища.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
id	string uuid	Идентификатор элемента.
properties	WarehouseProperties	Свойства хранилища.
type	ItemType	Тип элемента.
workspaceId	string uuid	Идентификатор рабочей области.

WarehouseProperties

Object

Свойства элемента хранилища.

Имя	Тип	Описание
collationType	CollationType	Тип сортировки хранилища.
connectionString	string	Строка подключения SQL, подключенная к рабочей области, содержащей это хранилище.
createdDate	string date-time	Дата и время создания хранилища.
lastUpdatedTime	string date-time	Дата и время последнего обновления хранилища