RunNotebook interface
表示 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
运行笔记本请求有效负载。
选项参数。
返回
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
运行笔记本请求有效负载。
选项参数。
返回
Promise<RunNotebookCreateRunResponse>
cancelRun(string, RunNotebookCancelRunOptionalParams)
取消笔记本运行。
function cancelRun(runId: string, options?: RunNotebookCancelRunOptionalParams): Promise<RunNotebookResponse>
参数
- runId
-
string
笔记本运行 ID。对于“创建运行”,可以生成新的 GUID 并在此处使用它。 对于其他作,这与创建运行中使用的 ID 相同。
选项参数。
返回
Promise<RunNotebookResponse>
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)
获取运行 ID 的 RunNotebook 快照。
function getSnapshot(runId: string, options?: RunNotebookGetSnapshotOptionalParams): Promise<RunNotebookSnapshotResponse>
参数
- runId
-
string
笔记本运行 ID。对于“创建运行”,可以生成新的 GUID 并在此处使用它。 对于其他作,这与创建运行中使用的 ID 相同。
选项参数。
返回
Promise<RunNotebookSnapshotResponse>
getStatus(string, RunNotebookGetStatusOptionalParams)
获取运行 ID 的 RunNotebook 状态。
function getStatus(runId: string, options?: RunNotebookGetStatusOptionalParams): Promise<RunNotebookResponse>
参数
- runId
-
string
笔记本运行 ID。对于“创建运行”,可以生成新的 GUID 并在此处使用它。 对于其他作,这与创建运行中使用的 ID 相同。
选项参数。
返回
Promise<RunNotebookResponse>