RunNotebook interface

パッケージ:

@azure/synapse-artifacts

RunNotebook を表すインターフェイス。

メソッド

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	ノートブックを実行する
beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	ノートブックを実行する
cancelRun(string, RunNotebookCancelRunOptionalParams)	ノートブックの実行を取り消します。
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)	実行 ID の RunNotebook スナップショットを取得します。
getStatus(string, RunNotebookGetStatusOptionalParams)	実行 ID の RunNotebook の状態を取得します。

メソッドの詳細

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

ノートブックを実行する

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

パラメーター

runId

string

ノートブック実行 ID。[実行の作成] では、新しい GUID を生成してここで使用できます。 他のアクションの場合、これは実行の作成で使用されるのと同じ ID です。

runNotebookRequest

RunNotebookRequest

ノートブック要求ペイロードを実行します。

options

RunNotebookCreateRunOptionalParams

オプション パラメーター。

戻り値

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

beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

ノートブックを実行する

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

パラメーター

runId

string

ノートブック実行 ID。[実行の作成] では、新しい GUID を生成してここで使用できます。 他のアクションの場合、これは実行の作成で使用されるのと同じ ID です。

runNotebookRequest

RunNotebookRequest

ノートブック要求ペイロードを実行します。

options

RunNotebookCreateRunOptionalParams

オプション パラメーター。

戻り値

Promise<RunNotebookCreateRunResponse>

cancelRun(string, RunNotebookCancelRunOptionalParams)

ノートブックの実行を取り消します。

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

パラメーター

runId

string

ノートブック実行 ID。[実行の作成] では、新しい GUID を生成してここで使用できます。 他のアクションの場合、これは実行の作成で使用されるのと同じ ID です。

options

RunNotebookCancelRunOptionalParams

オプション パラメーター。

戻り値

Promise<RunNotebookResponse>

getSnapshot(string, RunNotebookGetSnapshotOptionalParams)

実行 ID の RunNotebook スナップショットを取得します。

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

パラメーター

runId

string

ノートブック実行 ID。[実行の作成] では、新しい GUID を生成してここで使用できます。 他のアクションの場合、これは実行の作成で使用されるのと同じ ID です。

options

RunNotebookGetSnapshotOptionalParams

オプション パラメーター。

戻り値

Promise<RunNotebookSnapshotResponse>

getStatus(string, RunNotebookGetStatusOptionalParams)

実行 ID の RunNotebook の状態を取得します。

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

パラメーター

runId

string

ノートブック実行 ID。[実行の作成] では、新しい GUID を生成してここで使用できます。 他のアクションの場合、これは実行の作成で使用されるのと同じ ID です。

options

RunNotebookGetStatusOptionalParams

オプション パラメーター。

戻り値

Promise<RunNotebookResponse>