Items - List Items

Служба:: Admin

Версия API:: v1

Возвращает список активных элементов Fabric и PowerBI.

Note

Этот API является частью предварительного выпуска и предоставляется только для оценки и разработки. Он может измениться на основе отзывов и не рекомендуется для использования в рабочей среде.

Этот API поддерживает разбивки на страницы. Для каждого запроса можно вернуть не более 10 000 записей. С помощью непрерывного маркера, предоставленного в ответе, можно получить следующие 10 000 записей.

Порядок страниц:

Элементы структуры
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

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

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

Tenant.Read.All или Tenant.ReadWrite.All

Limitations

Максимум 200 запросов в час.

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

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

Identity	Support
User	Yes
Представитель службы и управляемые удостоверения	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/items

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

GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

Параметры URI

Имя	В	Тип	Описание
capacityId	query	string (uuid)	Идентификатор емкости рабочей области.
continuationToken	query	string	Непрерывный маркер, используемый для получения следующих элементов страницы.
state	query	string	Состояние элемента. Поддерживаемые состояния активны.
type	query	string	Тип элемента.
workspaceId	query	string (uuid)	Идентификатор рабочей области.

Ответы

Имя	Тип	Описание
200 OK	Items	Операция прошла успешно.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — идентификатор элемента не существует. InvalidItemType — тип элемента недействителен. InvalidItemState — состояние элемента недопустимо.

Имя

Тип

Описание

200 OK

Items

Операция прошла успешно.

Other Status Codes

ErrorResponse

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

ItemNotFound — идентификатор элемента не существует.
InvalidItemType — тип элемента недействителен.
InvalidItemState — состояние элемента недопустимо.

Примеры

Get a list of items using type query parameter example

Get all items in the tenant example

Get list of datamarts using type query parameter example

Get a list of items using type query parameter example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

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

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

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Report",
      "name": "Test Report",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "[email protected]"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items

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

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

{
  "itemEntities": [
    {
      "id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "Notebook",
      "name": "Test",
      "description": "Test notebook.",
      "state": "Active",
      "lastUpdatedDate": "2022-04-29T17:47:29.98673",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "[email protected]"
        }
      }
    },
    {
      "id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "KQLDatabase",
      "name": "TestKusto",
      "description": "Test KQL database.",
      "state": "Active",
      "lastUpdatedDate": "2022-06-30T17:47:29.98673",
      "workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "[email protected]"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Get list of datamarts using type query parameter example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

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

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

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Lakehouse",
      "name": "Lakehouse 2022-03-16T21:42:38.442Z",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "[email protected]"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
Item	Сведения о элементе.
Items	Список элементов.
ItemState	Состояние элемента. С течением времени могут добавляться дополнительные состояния элементов.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
Principal	Представляет удостоверение или группу Microsoft Entra.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

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

GroupDetails

Object

Группировка конкретных сведений. Применимо, если тип субъекта Group.

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

GroupType

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

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

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

Item

Object

Сведения о элементе.

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор емкости рабочей области.
creatorPrincipal	Principal	Владелец элемента.
description	string	Сведения о элементе, включая тип элемента и использование элемента.
folderId	string (uuid)	Идентификатор папки элемента.
id	string (uuid)	Идентификатор элемента.
lastUpdatedDate	string (date-time)	Последняя обновленная дата и время.
name	string	Имя элемента.
state	ItemState	Состояние элемента.
type	ItemType	Тип элемента. Включает такие значения, как Synapse, Notebook, Kqldatabase и SynapseWorkbook.
workspaceId	string (uuid)	Идентификатор рабочей области элемента.

Items

Object

Список элементов.

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

ItemState

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

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

Значение	Описание
Active	Активный элемент.

ItemType

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

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

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

Principal

Object

Представляет удостоверение или группу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

PrincipalType

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

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

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.

ServicePrincipalDetails

Object

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalProfileDetails

Object

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal	Родительский субъект профиля субъекта-службы.

UserDetails

Object

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Имя участника-пользователя.

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

Items - List Items

Permissions

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

Limitations

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

Interface

Параметры URI

Ответы

Примеры

Get a list of items using type query parameter example

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

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

Get all items in the tenant example

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

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

Get list of datamarts using type query parameter example

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

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

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails