Items - Get Notebook Definition

Service:: Notebook

Version d'API:: v1

Retourne la définition publique de notebook spécifiée.
Cette API prend en charge opérations longues (LRO).

Lorsque vous obtenez la définition publique d’un notebook, l’étiquette de confidentialité ne fait pas partie de la définition.

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour le notebook.

Étendues déléguées requises

Notebook.ReadWrite.All ou Item.ReadWrite.All

Limites

Cette API est bloquée pour un notebook avec une étiquette de confidentialité chiffrée.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
notebookId	path	True	string (uuid)	ID du bloc-notes.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
format	query		string	Format de la définition publique du notebook. Format pris en charge : `ipynb` et `fabricGitSource`. Si aucun format n’est fourni, `fabricGitSource` il est utilisé.

Réponses

Nom	Type	Description
200 OK	NotebookDefinitionResponse	La demande s’est terminée avec succès.
202 Accepted		Demande acceptée. La récupération de la définition est en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

Nom

Type

Description

200 OK

NotebookDefinitionResponse

La demande s’est terminée avec succès.

202 Accepted

Demande acceptée. La récupération de la définition est en cours.

En-têtes

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

Exemples

Get a notebook definition in fabricGitSource format example

Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 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

Définitions

Nom	Description
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
NotebookDefinition	Objet de définition publique de notebook. Pour plus d’informations sur la création d’une définition publique de notebook, consultez cet article .
NotebookDefinitionPart	Objet de partie de définition de bloc-notes.
NotebookDefinitionResponse	Réponse de définition publique du bloc-notes.
PayloadType	Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

NotebookDefinition

Object

Objet de définition publique de notebook. Pour plus d’informations sur la création d’une définition publique de notebook, consultez cet article .

Nom	Type	Description
format	string	Format de la définition du bloc-notes. Format pris en charge : `ipynb` et `fabricGitSource`. Si aucun format n’est fourni, `fabricGitSource` il est utilisé.
parts	NotebookDefinitionPart[]	Liste des parties de définition.

NotebookDefinitionPart

Object

Objet de partie de définition de bloc-notes.

Nom	Type	Description
path	string	Chemin du composant Bloc-notes. Extensions de contenu de notebook prises en charge : `.ipynb` pour `ipynb` le format ; `.py`, `.scala.r`, `.sql` pour `fabricGitSource` le format.
payload	string	Charge utile du composant Notebook.
payloadType	PayloadType	Type de charge utile.

NotebookDefinitionResponse

Object

Réponse de définition publique du bloc-notes.

Nom	Type	Description
definition	NotebookDefinition	Objet de définition publique de notebook. Pour plus d’informations sur la création d’une définition publique de notebook, consultez cet article .

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
InlineBase64	Base 64 inline.

Partager via

Items - Get Notebook Definition

Autorisations

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Get a notebook definition in fabricGitSource format example

Exemple de requête

Exemple de réponse

Get a notebook definition in ipynb format example

Exemple de requête

Exemple de réponse

Définitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

NotebookDefinition

NotebookDefinitionPart

NotebookDefinitionResponse

PayloadType