Freigeben über

Items - Get Notebook Definition

Dienst:
Notebook
API-Version:
v1

Gibt die angegebene öffentliche Notizbuchdefinition zurück.
Diese API unterstützt LRO-.

Wenn Sie die öffentliche Definition eines Notizbuchs erhalten, ist die Vertraulichkeitsbezeichnung nicht Teil der Definition.

Erlaubnisse

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

Erforderliche delegierte Bereiche

Notebook.ReadWrite.All oder Item.ReadWrite.All

Einschränkungen

Diese API wird für ein Notizbuch mit einer verschlüsselten Vertraulichkeitsbezeichnung blockiert.

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}/getDefinition
Mit optionalen Parametern: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

URI-Parameter

Name In Erforderlich Typ Beschreibung
notebookId
 path True

string (uuid)

Die Notizbuch-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
format
 query

string

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

Antworten

Name Typ Beschreibung
200 OK

NotebookDefinitionResponse

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Das Abrufen der Definition 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.

Beispiele

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

Get a notebook definition in fabricGitSource format example

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Beispiel für eine Antwort

Statuscode:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

Beispiel für eine Antwort

Statuscode:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
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.
NotebookDefinitionResponse

Antwort auf öffentliche Notizbücher.
PayloadType

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

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.

NotebookDefinitionResponse

Objekt

Antwort auf öffentliche Notizbücher.

Name Typ Beschreibung
definition

NotebookDefinition

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

PayloadType

Enumeration

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

Wert Beschreibung
InlineBase64

Inlinebasis 64.