RunNotebook interface

Package:

@azure/synapse-artifacts

Interface representing a RunNotebook.

Methods

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Run notebook
beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Run notebook
cancelRun(string, RunNotebookCancelRunOptionalParams)	Cancel notebook run.
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)	Get RunNotebook Snapshot for run id.
getStatus(string, RunNotebookGetStatusOptionalParams)	Get RunNotebook Status for run id.

Method Details

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

Run notebook

function beginCreateRun(runId: string, runNotebookRequest: RunNotebookRequest, options?: RunNotebookCreateRunOptionalParams): Promise<SimplePollerLike<OperationState<RunNotebookCreateRunResponse>, RunNotebookCreateRunResponse>>

Parameters

runId

string

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

runNotebookRequest

RunNotebookRequest

Run notebook request payload.

options

RunNotebookCreateRunOptionalParams

The options parameters.

Returns

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

beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

Run notebook

function beginCreateRunAndWait(runId: string, runNotebookRequest: RunNotebookRequest, options?: RunNotebookCreateRunOptionalParams): Promise<RunNotebookCreateRunResponse>

Parameters

runId

string

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

runNotebookRequest

RunNotebookRequest

Run notebook request payload.

options

RunNotebookCreateRunOptionalParams

The options parameters.

Returns

Promise<RunNotebookCreateRunResponse>

cancelRun(string, RunNotebookCancelRunOptionalParams)

Cancel notebook run.

function cancelRun(runId: string, options?: RunNotebookCancelRunOptionalParams): Promise<RunNotebookResponse>

Parameters

runId

string

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

options

RunNotebookCancelRunOptionalParams

The options parameters.

Returns

Promise<RunNotebookResponse>

getSnapshot(string, RunNotebookGetSnapshotOptionalParams)

Get RunNotebook Snapshot for run id.

function getSnapshot(runId: string, options?: RunNotebookGetSnapshotOptionalParams): Promise<RunNotebookSnapshotResponse>

Parameters

runId

string

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

options

RunNotebookGetSnapshotOptionalParams

The options parameters.

Returns

Promise<RunNotebookSnapshotResponse>

getStatus(string, RunNotebookGetStatusOptionalParams)

Get RunNotebook Status for run id.

function getStatus(runId: string, options?: RunNotebookGetStatusOptionalParams): Promise<RunNotebookResponse>

Parameters

runId

string

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

options

RunNotebookGetStatusOptionalParams

The options parameters.

Returns

Promise<RunNotebookResponse>