Items - Get Item

Ссылка

Служба:: Admin

Версия API:: v1

Заметка

Этот API находится в предварительной версии.

Возвращает указанный элемент Fabric или PowerBI.

Разрешения

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

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

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

Ограничения

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

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

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

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

Интерфейс

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}

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

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}?type={type}

Параметры URI

Имя	В	Обязательно	Тип	Описание
itemId	path	True	string uuid	Идентификатор элемента
workspaceId	path	True	string uuid	Идентификатор рабочей области.
type	query		string	Тип элемента. При запросе для следующих типов этот параметр требуется: Сообщать Щиток SemanticModel Приложение Поток данных

Имя

Обязательно

Тип

Описание

itemId

path

True

string

uuid

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

workspaceId

path

True

string

uuid

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

type

query

string

Тип элемента. При запросе для следующих типов этот параметр требуется:

Сообщать
Щиток
SemanticModel
Приложение
Поток данных

Ответы

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

Имя

Тип

Описание

200 OK

Item

ХОРОШО

Other Status Codes

ErrorResponse

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

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

Примеры

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report

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

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

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Report",
  "name": "Test",
  "description": "Test Jacob's Report,",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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": "Jacob@example.com"
    }
  }
}

Get item details by ID example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48

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

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

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Kusto",
  "name": "Test",
  "description": "Test Jacob's notebook.",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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": "Jacob@example.com"
    }
  }
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
Item	Сведения о элементе.
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

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

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

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

Item

Object

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

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

ItemState

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

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

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

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	Склад.

Principal

Object

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

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

PrincipalType

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

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

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

ServicePrincipalDetails

Object

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

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

ServicePrincipalProfileDetails

Object

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

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

UserDetails

Object

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

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

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

Items - Get Item

Разрешения

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

Ограничения

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

Интерфейс

Параметры URI

Ответы

Примеры

Get item details by ID and type example

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

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

Get item details by ID example

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

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

Определения

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Дополнительные ресурсы