Items - Update Notebook Definition

Tjeneste:

Notebook

API-version:

v1

Tilsidesætter definitionen for den angivne notesbog.
Denne API understøtter LRO-handlinger (Long Running Operations).

Opdatering af notesbogens definition påvirker ikke dens følsomhedsmærkat.

Tilladelser

Den, der ringer op, skal have læse- og skriverettigheder til notesbogen.

Påkrævede delegerede områder

Notebook.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Brugergrænseflade

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

Med valgfrie parametre:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/updateDefinition?updateMetadata={updateMetadata}

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
notebookId	path	True	string (uuid)	Notesbog-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
updateMetadata	query		boolean	Når den er angivet til true, og .platform-filen er angivet som en del af definitionen, opdateres elementets metadata ved hjælp af metadataene i .platform-filen

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
definition	True	NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.

Svar

Name	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Opdateringsdefinitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element. CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Update a notebook definition in fabricGitSource format example

Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Eksempelsvar

Statuskode:

200

Statuskode:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Update a notebook definition in ipynb format example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "ipynb",
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv...",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Eksempelsvar

Statuskode:

200

Statuskode:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.
NotebookDefinitionPart	Objekt for notesbogdefinitionsdel.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
UpdateNotebookDefinitionRequest	Opdater nyttedata for anmodning om offentlig definition af notesbog.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

NotebookDefinition

Objekt

Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.

Name	Type	Beskrivelse
format	string	Formatet af notesbogdefinitionen. Understøttet format: ipynb og fabricGitSource. Hvis der ikke er angivet et format, fabricGitSource bruges .
parts	NotebookDefinitionPart[]	En liste over definitionsdele.

NotebookDefinitionPart

Objekt

Objekt for notesbogdefinitionsdel.

Name	Type	Beskrivelse
path	string	Stien til notesbogdelen. Understøttede udvidelser til notesbogindhold: .ipynb for ipynb format; .py, .scala, .rfor .sqlfabricGitSource format.
payload	string	Nyttedata for notesbogdelen.
payloadType	PayloadType	Nyttedatatypen.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

UpdateNotebookDefinitionRequest

Objekt

Opdater nyttedata for anmodning om offentlig definition af notesbog.

Name	Type	Beskrivelse
definition	NotebookDefinition	Offentlig definition af notesbogobjekt. Se denne artikel for at få flere oplysninger om, hvordan du opretter en offentlig definition af en notesbog.