Items - Update Notebook

Tjänst:

Notebook

API-version:

v1

Uppdaterar egenskaperna för den angivna notebook-filen.

Behörigheter

Anroparen måste ha läs- och skrivbehörighet för notebook-filen.

Obligatoriska delegerade omfång

Notebook.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
notebookId	path	True	string (uuid)	Notebook-ID:t.
workspaceId	path	True	string (uuid)	Arbetsytans ID.

Begärandetext

Name	Typ	Description
description	string	Beskrivningen av anteckningsboken. Maximal längd är 256 tecken.
displayName	string	Anteckningsbokens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.

Svar

Name	Typ	Description
200 OK	Notebook	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte. InvalidRequest – Ogiltig uppdateringsbegäran

Exempel

Update a notebook example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
Notebook	Ett notebook-objekt.
SensitivityLabel	Representerar en känslighetsetikett som tillämpas på ett objekt.
UpdateNotebookRequest	Uppdatera notebook-begäran.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.

Notebook

Objekt

Ett notebook-objekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
sensitivityLabel	SensitivityLabel	Objektets känslighetsetikett.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

SensitivityLabel

Objekt

Representerar en känslighetsetikett som tillämpas på ett objekt.

Name	Typ	Description
id	string (uuid)	Känslighetsetikettens ID.

UpdateNotebookRequest

Objekt

Uppdatera notebook-begäran.

Name	Typ	Description
description	string	Beskrivningen av anteckningsboken. Maximal längd är 256 tecken.
displayName	string	Anteckningsbokens visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.