RunNotebook interface

套件:

@azure/synapse-artifacts

表示 RunNotebook 的介面。

方法

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	執行筆記本
beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	執行筆記本
cancelRun(string, RunNotebookCancelRunOptionalParams)	取消筆記本執行。
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)	取得 RunNotebook Snapshot 以取得執行標識碼。
getStatus(string, RunNotebookGetStatusOptionalParams)	取得執行標識碼的 RunNotebook 狀態。

方法詳細資料

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

執行筆記本

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

參數

runId

string

筆記本執行識別碼。針對 [建立執行]，您可以產生新的 GUID 並在這裡使用它。 對於其他動作，這與建立執行中使用的識別碼相同。

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

筆記本執行識別碼。針對 [建立執行]，您可以產生新的 GUID 並在這裡使用它。 對於其他動作，這與建立執行中使用的識別碼相同。

runNotebookRequest

RunNotebookRequest

運行筆記本請求有效負載。

options

RunNotebookCreateRunOptionalParams

選項參數。

傳回

Promise<RunNotebookCreateRunResponse>

cancelRun(string, RunNotebookCancelRunOptionalParams)

取消筆記本執行。

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

參數

runId

string

筆記本執行識別碼。針對 [建立執行]，您可以產生新的 GUID 並在這裡使用它。 對於其他動作，這與建立執行中使用的識別碼相同。

options

RunNotebookCancelRunOptionalParams

選項參數。

傳回

Promise<RunNotebookResponse>

getSnapshot(string, RunNotebookGetSnapshotOptionalParams)

取得 RunNotebook Snapshot 以取得執行標識碼。

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

參數

runId

string

筆記本執行識別碼。針對 [建立執行]，您可以產生新的 GUID 並在這裡使用它。 對於其他動作，這與建立執行中使用的識別碼相同。

options

RunNotebookGetSnapshotOptionalParams

選項參數。

傳回

Promise<RunNotebookSnapshotResponse>

getStatus(string, RunNotebookGetStatusOptionalParams)

取得執行標識碼的 RunNotebook 狀態。

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

參數

runId

string

筆記本執行識別碼。針對 [建立執行]，您可以產生新的 GUID 並在這裡使用它。 對於其他動作，這與建立執行中使用的識別碼相同。

options

RunNotebookGetStatusOptionalParams

選項參數。

傳回

Promise<RunNotebookResponse>