Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Notebook

Package version

Notebook. Interface representing a Notebook.

Hierarchy

  • Notebook

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional bigDataPool

bigDataPool: BigDataPoolReference | null

Big data pool reference.

cells

cells: NotebookCell[]

Array of cells of the current notebook.

Optional description

description: undefined | string

The description of the notebook.

metadata

Notebook root-level metadata.

nbformat

nbformat: number

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

nbformatMinor

nbformatMinor: number

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

Optional sessionProperties

sessionProperties: NotebookSessionProperties | null

Session properties.

Methods

createOrUpdateNotebook

deleteNotebook

  • deleteNotebook(notebookName: string, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>
  • Deletes a Note book.

    Parameters

    • notebookName: string

      The notebook name.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<LROPoller<coreHttp.RestResponse>>

getNotebook

listNotebookSummaryByWorkSpace

  • listNotebookSummaryByWorkSpace(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<NotebookResource>

listNotebooksByWorkspace

  • listNotebooksByWorkspace(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<NotebookResource>

renameNotebook

  • renameNotebook(notebookName: string, request: ArtifactRenameRequest, options?: coreHttp.OperationOptions): Promise<LROPoller<coreHttp.RestResponse>>

Generated using TypeDoc