Partager via

Items - Update Notebook

  • Référence
Service:
Notebook
Version d'API:
v1

Met à jour les propriétés du bloc-notes spécifié.

Autorisations

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Notebook.ReadWrite.All ou Item.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
notebookId
 path True

string

uuid

ID du bloc-notes.
workspaceId
 path True

string

uuid

ID de l’espace de travail.

Corps de la demande

Nom Type Description
description

string

Description du bloc-notes. La longueur maximale est de 256 caractères.
displayName

string

Nom complet du bloc-notes. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.

Réponses

Nom Type Description
200 OK

Notebook

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • ItemNotFound : l’élément demandé n’a pas été trouvé.

  • InvalidRequest - Demande de mise à jour non valide

Exemples

Update a notebook example

Exemple de requête

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."
}

Exemple de réponse

Code d’état:
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"
}

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
ItemType

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
Notebook

Objet notebook.
UpdateNotebookRequest

Mettre à jour la demande de bloc-notes.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Dashboard

Tableau de bord PowerBI.
DataPipeline

Un pipeline de données.
Datamart

Datamart PowerBI.
Environment

Environnement.
Eventhouse

Un eventhouse.
Eventstream

Flux d’événements.
GraphQLApi

API pour l’élément GraphQL.
KQLDashboard

Tableau de bord KQL.
KQLDatabase

Base de données KQL.
KQLQueryset

Ensemble de requêtes KQL.
Lakehouse

Un lac.
MLExperiment

Une expérience de Machine Learning.
MLModel

Modèle Machine Learning.
MirroredDatabase

Une base de données mise en miroir.
MirroredWarehouse

Un entrepôt mis en miroir.
MountedDataFactory

Un MountedDataFactory.
Notebook

Un bloc-notes.
PaginatedReport

Rapport paginé PowerBI.
Reflex

Un réflexe.
Report

Rapport PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Point de terminaison SQL.
SemanticModel

Modèle sémantique PowerBI.
SparkJobDefinition

Définition d’un travail Spark.
Warehouse

Un entrepôt.

Notebook

Object

Objet notebook.

Nom Type Description
description

string

Description de l’élément.
displayName

string

Nom complet de l’élément.
id

string

uuid

ID d’élément.
type

ItemType

Type d’élément.
workspaceId

string

uuid

ID de l’espace de travail.

UpdateNotebookRequest

Object

Mettre à jour la demande de bloc-notes.

Nom Type Description
description

string

Description du bloc-notes. La longueur maximale est de 256 caractères.
displayName

string

Nom complet du bloc-notes. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.