Items - Get Notebook Definition
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
Um die Definition eines Notizbuchelements abzurufen, das durch eine verschlüsselte Vertraulichkeitsbezeichnung geschützt ist, muss der Aufrufer über ausreichende Nutzungsrechte verfügen, um die Bezeichnung zu entfernen, wie in Microsoft Purview konfiguriert.
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
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
notebook
|
path | True |
string (uuid) |
Die Notizbuch-ID. |
|
workspace
|
path | True |
string (uuid) |
Die Arbeitsbereichs-ID. |
|
format
|
query |
string |
Das Format der öffentlichen Notizbuchdefinition. Unterstütztes Format: |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung wurde erfolgreich abgeschlossen. |
|
| 202 Accepted |
Anforderung angenommen. Das Abrufen der Definition wird ausgeführt. Header
|
|
| 429 Too Many Requests |
Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Header Retry-After: integer |
|
| Other Status Codes |
Häufige Fehlercodes:
|
Beispiele
|
Get a notebook definition in fabric |
| 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
{
"definition": {
"parts": [
{
"path": "notebook-content.py",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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
{
"definition": {
"parts": [
{
"path": "notebook-content.ipynb",
"payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
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 |
|---|---|
|
Error |
Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt. |
|
Error |
Das Fehlerbezogene Ressourcendetails-Objekt. |
|
Error |
Die Fehlerantwort. |
|
Error |
Die Fehlerantwortdetails. |
|
Notebook |
Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zur Struktur der Notizbuchdefinition finden Sie in diesem Artikel . |
|
Notebook |
Notizbuchdefinitionsteilobjekt. |
|
Notebook |
Antwort auf öffentliche Notizbücher. |
|
Payload |
Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden. |
ErrorParameter
Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
| Name | Typ | Beschreibung |
|---|---|---|
| message |
string |
Eine lesbare Beschreibung der Bedeutung des Parameters. |
| name |
string |
Die Parameterkennung. |
| value |
string |
Der übergebene Wert |
ErrorRelatedResource
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
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. |
| isRetriable |
boolean |
Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den |
| message |
string |
Eine lesbare Darstellung des Fehlers. |
| moreDetails |
Liste der zusätzlichen Fehlerdetails. |
|
| parameters |
Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen. |
|
| relatedResource |
Die fehlerbezogenen Ressourcendetails. |
|
| requestId |
string (uuid) |
ID der Anforderung, die dem Fehler zugeordnet ist. |
ErrorResponseDetails
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. |
| parameters |
Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen. |
|
| relatedResource |
Die fehlerbezogenen Ressourcendetails. |
NotebookDefinition
Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zur Struktur der Notizbuchdefinition finden Sie in diesem Artikel .
| Name | Typ | Beschreibung |
|---|---|---|
| format |
string |
Das Format der Notizbuchdefinition. Unterstütztes Format: |
| parts |
Eine Liste der Definitionsteile. |
NotebookDefinitionPart
Notizbuchdefinitionsteilobjekt.
| Name | Typ | Beschreibung |
|---|---|---|
| path |
string |
Der Notizbuchteilpfad. Unterstützte Notizbuchinhaltserweiterungen: |
| payload |
string |
Die Nutzlast des Notizbuchteils. |
| payloadType |
Der Nutzlasttyp. |
NotebookDefinitionResponse
Antwort auf öffentliche Notizbücher.
| Name | Typ | Beschreibung |
|---|---|---|
| definition |
Öffentliches Notizbuchdefinitionsobjekt. Weitere Informationen zur Struktur der Notizbuchdefinition finden Sie in diesem Artikel . |
PayloadType
Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
| Wert | Beschreibung |
|---|---|
| InlineBase64 |
Inlinebasis 64. |