Notebook interface

Package:

@azure/synapse-artifacts

Notebook.

Properties

bigDataPool	Big data pool reference.
cells	Array of cells of the current notebook.
description	The description of the notebook.
folder	The folder that this notebook is in. If not specified, this notebook will appear at the root level.
metadata	Notebook root-level metadata.
nbformat	Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.
nbformatMinor	Notebook format (minor number). Incremented for backward compatible changes to the notebook format.
sessionProperties	Session properties.
targetSparkConfiguration	The spark configuration of the spark job.

Property Details

bigDataPool

Big data pool reference.

bigDataPool?: BigDataPoolReference

Property Value

BigDataPoolReference

cells

Array of cells of the current notebook.

cells: NotebookCell[]

Property Value

NotebookCell[]

description

The description of the notebook.

description?: string

Property Value

string

folder

The folder that this notebook is in. If not specified, this notebook will appear at the root level.

folder?: NotebookFolder

Property Value

NotebookFolder

metadata

Notebook root-level metadata.

metadata: NotebookMetadata

Property Value

NotebookMetadata

nbformat

Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.

nbformat: number

Property Value

number

nbformatMinor

Notebook format (minor number). Incremented for backward compatible changes to the notebook format.

nbformatMinor: number

Property Value

number

sessionProperties

Session properties.

sessionProperties?: NotebookSessionProperties

Property Value

NotebookSessionProperties

targetSparkConfiguration

The spark configuration of the spark job.

targetSparkConfiguration?: SparkConfigurationReference

Property Value

SparkConfigurationReference