Freigeben über

Items - Update Notebook

  • Referenz
Dienst:
Notebook
API-Version:
v1

Aktualisiert die Eigenschaften des angegebenen Notizbuchs.

Erlaubnisse

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Notebook.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
notebookId
 path True

string

uuid

Die Notizbuch-ID.
workspaceId
 path True

string

uuid

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
description

string

Die Notizbuchbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Notizbuchs. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.

Antworten

Name Typ Beschreibung
200 OK

Notebook

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

  • InvalidRequest – Ungültige Updateanforderung

Beispiele

Update a notebook example

Beispielanforderung

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

{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook."
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "displayName": "Notebook's New name",
  "description": "A new description for notebook.",
  "type": "Notebook",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
Notebook

Ein Notizbuchobjekt.
UpdateNotebookRequest

Aktualisieren sie die Notizbuchanforderung.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
DataPipeline

Eine Datenpipeline.
Datamart

PowerBI datamart.
Environment

Eine Umgebung.
Eventhouse

Ein Eventhouse.
Eventstream

Ein Ereignisstream.
GraphQLApi

Eine API für GraphQL-Element.
KQLDashboard

Ein KQL-Dashboard.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
Lakehouse

Ein Seehaus.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
MirroredDatabase

Eine gespiegelte Datenbank.
MirroredWarehouse

Ein gespiegeltes Lager.
MountedDataFactory

Eine MountedDataFactory.
Notebook

Ein Notizbuch.
PaginatedReport

PowerBI-Paginated-Bericht.
Reflex

Ein Reflex.
Report

PowerBI-Bericht.
SQLDatabase

Eine SQLDatabase.
SQLEndpoint

Ein SQL-Endpunkt.
SemanticModel

PowerBI-Semantikmodell.
SparkJobDefinition

Eine Sparkauftragsdefinition.
Warehouse

Ein Lagerhaus.

Notebook

Objekt

Ein Notizbuchobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
id

string

uuid

Die Element-ID.
type

ItemType

Der Elementtyp.
workspaceId

string

uuid

Die Arbeitsbereichs-ID.

UpdateNotebookRequest

Objekt

Aktualisieren sie die Notizbuchanforderung.

Name Typ Beschreibung
description

string

Die Notizbuchbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename des Notizbuchs. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.