Items - List Warehouses

Служба:: Warehouse

Версия API:: v1

Возвращает список складов из указанной рабочей области.
Этот API поддерживает разбивки на страницы.

Разрешения

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

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

Workspace.Read.All или Workspace.ReadWrite.All

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

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

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

Интерфейс

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

С использованием необязательных параметров:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses?continuationToken={continuationToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
continuationToken	query		string	Маркер получения следующей страницы результатов.

Ответы

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

Имя

Тип

Описание

200 OK

Warehouses

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

Other Status Codes

ErrorResponse

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

InvalidItemType — недопустимый тип элемента.

Примеры

List warehouses in workspace example

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

HTTP

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

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

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

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Warehouse Name 1",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "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_CI_AS_KS_WS_SC_UTF8"
      }
    },
    {
      "id": "6281bf94-81b9-46b2-b8d3-79bb868fc822",
      "displayName": "Warehouse Name 2",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-11-21T13:14:30.54",
        "lastUpdatedTime": "2023-12-04T20:03:43.110",
        "collationType": "Latin1_General_100_BIN2_UTF8"
      }
    }
  ]
}

Определения

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

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

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	Моментальный снимок хранилища.

Warehouse

Object

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

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

WarehouseProperties

Object

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

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

Warehouses

Object

Список складов.

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	Warehouse[]	Список складов.

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

Items - List Warehouses

Разрешения

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

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

Интерфейс

Параметры URI

Ответы

Примеры

List warehouses in workspace example

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

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

Определения

CollationType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

Warehouse

WarehouseProperties

Warehouses