Partilhar via

Items - List Notebooks

  • Referência
Serviço:
Notebook
Versão da API:
v1

Retorna uma lista de blocos de anotações do espaço de trabalho especificado.
Esta API suporta paginação.

Permissões

O chamador deve ter visualizador ou superior função de espaço de trabalho.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Suporte
Utilizador Sim
da entidade de serviço e identidades gerenciadas Sim

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks?continuationToken={continuationToken}

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string

uuid

O ID do espaço de trabalho.
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.

Respostas

Name Tipo Description
200 OK

Notebooks

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidItemType - Tipo de item inválido.

Exemplos

List notebooks in workspace example

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemType

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
Notebook

Um objeto de bloco de anotações.
Notebooks

Uma lista de blocos de notas.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Uma API para o item GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um caderno.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho de faísca.
Warehouse

Um armazém.

Notebook

Object

Um objeto de bloco de anotações.

Name Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

O ID do item.
type

ItemType

O tipo de item.
workspaceId

string

uuid

O ID do espaço de trabalho.

Notebooks

Object

Uma lista de blocos de notas.

Name Tipo Description
continuationToken

string

O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value

Notebook[]

Uma lista de blocos de notas.