Condividi tramite

Items - Get Notebook

  • Riferimento
Servizio:
Notebook
Versione API:
v1

Restituisce le proprietà del notebook specificato.

Autorizzazioni

Il chiamante deve avere ruolo visualizzatore o superiore.

Ambiti delegati obbligatori

Notebook.Read.All o Notebook.ReadWrite.All o Item.Read.All o Item.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Appoggiare
Utente Sì
'entità servizio e identità gestite Sì

Interfaccia

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
notebookId
 path True

string

uuid

ID del notebook.
workspaceId
 path True

string

uuid

ID dell'area di lavoro.

Risposte

Nome Tipo Descrizione
200 OK

Notebook

Richiesta completata correttamente.
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

Get a notebook example

Esempio di richiesta

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715

Risposta di esempio

Codice di stato:
200 
{
  "displayName": "Notebook 1",
  "description": "A notebook description.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definizioni

Nome Descrizione
ErrorRelatedResource

Oggetto dettagli risorsa correlato all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
ItemType

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
Notebook

Oggetto notebook.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string

ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

ItemType

Enumeration

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore Descrizione
Dashboard

Dashboard di Power BI.
DataPipeline

Una pipeline di dati.
Datamart

Datamart di PowerBI.
Environment

Un ambiente.
Eventhouse

Una casa eventi.
Eventstream

Flusso di eventi.
GraphQLApi

API per l'elemento GraphQL.
KQLDashboard

Dashboard KQL.
KQLDatabase

Un database KQL.
KQLQueryset

Set di query KQL.
Lakehouse

Una lakehouse.
MLExperiment

Esperimento di Machine Learning.
MLModel

Modello di Machine Learning.
MirroredDatabase

Database con mirroring.
MirroredWarehouse

Magazzino con mirroring.
MountedDataFactory

Oggetto MountedDataFactory.
Notebook

Un notebook.
PaginatedReport

Report impaginato di Power BI.
Reflex

Un riflesso.
Report

Report di Power BI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Endpoint SQL.
SemanticModel

Modello semantico di PowerBI.
SparkJobDefinition

Definizione di processo Spark.
Warehouse

Un magazzino.

Notebook

Object

Oggetto notebook.

Nome Tipo Descrizione
description

string

Descrizione dell'elemento.
displayName

string

Nome visualizzato dell'elemento.
id

string

uuid

ID elemento.
type

ItemType

Tipo di elemento.
workspaceId

string

uuid

ID dell'area di lavoro.