Freigeben über

Items - Update Notebook Definition

Dienst:
Notebook
API-Version:
v1

Überschreibt die Definition für das angegebene Notizbuch.
Diese API unterstützt LRO-.

Das Aktualisieren der Notizbuchdefinition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für das Notizbuch besitzen.

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ützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
notebookId
 path True

string (uuid)

Die Notizbuch-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
updateMetadata
 query

boolean

Wenn sie auf "true" festgelegt ist und die PLATTFORM-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der PLATTFORM-Datei aktualisiert.

Anforderungstext

Name Erforderlich Typ Beschreibung
definition True

NotebookDefinition

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Die Updatedefinition wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a notebook definition in fabricGitSource format example
Update a notebook definition in ipynb format example

Update a notebook definition in fabricGitSource format example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200
Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200
Statuscode:
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

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
NotebookDefinition

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.
NotebookDefinitionPart

Notizbuchdefinitionsteilobjekt.
PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
UpdateNotebookDefinitionRequest

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung des Notizbuchs.

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.

NotebookDefinition

Objekt

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.

Name Typ Beschreibung
format

string

Das Format der Notizbuchdefinition. Unterstütztes Format: ipynb und fabricGitSource. Wenn kein Format bereitgestellt wird, fabricGitSource wird dieses verwendet.
parts

NotebookDefinitionPart[]

Eine Liste der Definitionsteile.

NotebookDefinitionPart

Objekt

Notizbuchdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Notizbuchteilpfad. Unterstützte Notizbuchinhaltserweiterungen: .ipynb für ipynb format; .py, .scala, , .r.sql für fabricGitSource format.
payload

string

Die Nutzlast des Notizbuchteils.
payloadType

PayloadType

Der Nutzlasttyp.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.

UpdateNotebookDefinitionRequest

Objekt

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung des Notizbuchs.

Name Typ Beschreibung
definition

NotebookDefinition

Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zum Erstellen einer öffentlichen Notizbuchdefinition finden Sie in diesem Artikel.