Items - Update Notebook
Updates the properties of the specified notebook.
Permissions
The caller must have contributor or higher workspace role.
Required Delegated Scopes
Notebook.ReadWrite.All or Item.ReadWrite.All
Interface
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
notebook
|
path | True |
string uuid |
The notebook ID. |
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Type | Description |
---|---|---|
description |
string |
The notebook description. Maximum length is 256 characters. |
displayName |
string |
The notebook display name. The display name must follow naming rules according to item type. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Examples
Update a notebook example
Sample request
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."
}
Sample response
{
"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"
}
Definitions
Name | Description |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
The type of the item. Additional item types may be added over time. |
Notebook |
A notebook object. |
Update |
Update notebook request. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
ItemType
The type of the item. Additional item types may be added over time.
Name | Type | Description |
---|---|---|
Dashboard |
string |
PowerBI dashboard. |
DataPipeline |
string |
A data pipeline. |
Datamart |
string |
PowerBI datamart. |
Environment |
string |
An environment. |
Eventhouse |
string |
An eventhouse. |
Eventstream |
string |
An eventstream. |
KQLDatabase |
string |
A KQL database. |
KQLQueryset |
string |
A KQL queryset. |
Lakehouse |
string |
A lakehouse. |
MLExperiment |
string |
A machine learning experiment. |
MLModel |
string |
A machine learning model. |
MirroredWarehouse |
string |
A mirrored warehouse. |
Notebook |
string |
A notebook. |
PaginatedReport |
string |
PowerBI paginated report. |
Report |
string |
PowerBI report. |
SQLEndpoint |
string |
An SQL endpoint. |
SemanticModel |
string |
PowerBI semantic model. |
SparkJobDefinition |
string |
A spark job definition. |
Warehouse |
string |
A warehouse. |
Notebook
A notebook object.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
type |
The item type. |
|
workspaceId |
string |
The workspace ID. |
UpdateNotebookRequest
Update notebook request.
Name | Type | Description |
---|---|---|
description |
string |
The notebook description. Maximum length is 256 characters. |
displayName |
string |
The notebook display name. The display name must follow naming rules according to item type. |