NotebookOperations interface

Package:

@azure/synapse-artifacts

Interface representing a NotebookOperations.

Methods

beginCreateOrUpdateNotebook(string, NotebookResource, NotebookCreateOrUpdateNotebookOptionalParams)	Creates or updates a Note Book.
beginCreateOrUpdateNotebookAndWait(string, NotebookResource, NotebookCreateOrUpdateNotebookOptionalParams)	Creates or updates a Note Book.
beginDeleteNotebook(string, NotebookDeleteNotebookOptionalParams)	Deletes a Note book.
beginDeleteNotebookAndWait(string, NotebookDeleteNotebookOptionalParams)	Deletes a Note book.
beginRenameNotebook(string, ArtifactRenameRequest, NotebookRenameNotebookOptionalParams)	Renames a notebook.
beginRenameNotebookAndWait(string, ArtifactRenameRequest, NotebookRenameNotebookOptionalParams)	Renames a notebook.
getNotebook(string, NotebookGetNotebookOptionalParams)	Gets a Note Book.
listNotebooksByWorkspace(NotebookGetNotebooksByWorkspaceOptionalParams)	Lists Notebooks.
listNotebookSummaryByWorkSpace(NotebookGetNotebookSummaryByWorkSpaceOptionalParams)	Lists a summary of Notebooks.

Method Details

beginCreateOrUpdateNotebook(string, NotebookResource, NotebookCreateOrUpdateNotebookOptionalParams)

Creates or updates a Note Book.

function beginCreateOrUpdateNotebook(notebookName: string, notebook: NotebookResource, options?: NotebookCreateOrUpdateNotebookOptionalParams): Promise<SimplePollerLike<OperationState<NotebookResource>, NotebookResource>>

Parameters

notebookName

string

The notebook name.

notebook

NotebookResource

Note book resource definition.

options

NotebookCreateOrUpdateNotebookOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NotebookResource>, NotebookResource>>

beginCreateOrUpdateNotebookAndWait(string, NotebookResource, NotebookCreateOrUpdateNotebookOptionalParams)

Creates or updates a Note Book.

function beginCreateOrUpdateNotebookAndWait(notebookName: string, notebook: NotebookResource, options?: NotebookCreateOrUpdateNotebookOptionalParams): Promise<NotebookResource>

Parameters

notebookName

string

The notebook name.

notebook

NotebookResource

Note book resource definition.

options

NotebookCreateOrUpdateNotebookOptionalParams

The options parameters.

Returns

Promise<NotebookResource>

beginDeleteNotebook(string, NotebookDeleteNotebookOptionalParams)

Deletes a Note book.

function beginDeleteNotebook(notebookName: string, options?: NotebookDeleteNotebookOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

notebookName

string

The notebook name.

options

NotebookDeleteNotebookOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteNotebookAndWait(string, NotebookDeleteNotebookOptionalParams)

Deletes a Note book.

function beginDeleteNotebookAndWait(notebookName: string, options?: NotebookDeleteNotebookOptionalParams): Promise<void>

Parameters

notebookName

string

The notebook name.

options

NotebookDeleteNotebookOptionalParams

The options parameters.

Returns

Promise<void>

beginRenameNotebook(string, ArtifactRenameRequest, NotebookRenameNotebookOptionalParams)

Renames a notebook.

function beginRenameNotebook(notebookName: string, request: ArtifactRenameRequest, options?: NotebookRenameNotebookOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

notebookName

string

The notebook name.

request

ArtifactRenameRequest

proposed new name.

options

NotebookRenameNotebookOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRenameNotebookAndWait(string, ArtifactRenameRequest, NotebookRenameNotebookOptionalParams)

Renames a notebook.

function beginRenameNotebookAndWait(notebookName: string, request: ArtifactRenameRequest, options?: NotebookRenameNotebookOptionalParams): Promise<void>

Parameters

notebookName

string

The notebook name.

request

ArtifactRenameRequest

proposed new name.

options

NotebookRenameNotebookOptionalParams

The options parameters.

Returns

Promise<void>

getNotebook(string, NotebookGetNotebookOptionalParams)

Gets a Note Book.

function getNotebook(notebookName: string, options?: NotebookGetNotebookOptionalParams): Promise<NotebookResource>

Parameters

notebookName

string

The notebook name.

options

NotebookGetNotebookOptionalParams

The options parameters.

Returns

Promise<NotebookResource>

listNotebooksByWorkspace(NotebookGetNotebooksByWorkspaceOptionalParams)

Lists Notebooks.

function listNotebooksByWorkspace(options?: NotebookGetNotebooksByWorkspaceOptionalParams): PagedAsyncIterableIterator<NotebookResource, NotebookResource[], PageSettings>

Parameters

options

NotebookGetNotebooksByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NotebookResource, NotebookResource[], PageSettings>

listNotebookSummaryByWorkSpace(NotebookGetNotebookSummaryByWorkSpaceOptionalParams)

Lists a summary of Notebooks.

function listNotebookSummaryByWorkSpace(options?: NotebookGetNotebookSummaryByWorkSpaceOptionalParams): PagedAsyncIterableIterator<NotebookResource, NotebookResource[], PageSettings>

Parameters

options

NotebookGetNotebookSummaryByWorkSpaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NotebookResource, NotebookResource[], PageSettings>