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


Items - List Notebooks

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

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
path True

string

uuid

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

continuationToken
query

string

Маркер получения следующей страницы результатов.

Ответы

Имя Тип Описание
200 OK

Notebooks

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

Other Status Codes

ErrorResponse

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

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

Примеры

List notebooks in workspace example

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

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

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

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Notebook Name 1",
      "description": "A notebook description.",
      "type": "Notebook",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

Определения

Имя Описание
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.

ErrorResponse

Ответ на ошибку.

ErrorResponseDetails

Сведения об ответе на ошибку.

ItemType

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

Notebook

Объект записной книжки.

Notebooks

Список записных книжек.

ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.

resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.

message

string

Удобочитаемое представление ошибки.

moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.

relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Сведения об ответе на ошибку.

Имя Тип Описание
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

Склад.

Notebook

Объект записной книжки.

Имя Тип Описание
description

string

Описание элемента.

displayName

string

Отображаемое имя элемента.

id

string

uuid

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

type

ItemType

Тип элемента.

workspaceId

string

uuid

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

Notebooks

Список записных книжек.

Имя Тип Описание
continuationToken

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.

continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.

value

Notebook[]

Список записных книжек.