RunNotebook interface

Пакет:

@azure/synapse-artifacts

Интерфейс, представляющий Модуль RunNotebook.

Методы

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Запуск записной книжки
beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Запуск записной книжки
cancelRun(string, RunNotebookCancelRunOptionalParams)	Отмена выполнения записной книжки.
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)	Получение моментального снимка RunNotebook для идентификатора запуска.
getStatus(string, RunNotebookGetStatusOptionalParams)	Получение состояния RunNotebook для идентификатора запуска.

Сведения о методе

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

Запуск записной книжки

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

Параметры

runId

string

Идентификатор запуска записной книжки. Для Create Run вы можете создать новый идентификатор GUID и использовать его здесь. Для других действий это тот же идентификатор, который используется в Create Run.

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

Идентификатор запуска записной книжки. Для Create Run вы можете создать новый идентификатор GUID и использовать его здесь. Для других действий это тот же идентификатор, который используется в Create Run.

runNotebookRequest

RunNotebookRequest

Запустите полезные данные запроса записной книжки.

options

RunNotebookCreateRunOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RunNotebookCreateRunResponse>

cancelRun(string, RunNotebookCancelRunOptionalParams)

Отмена выполнения записной книжки.

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

Параметры

runId

string

Идентификатор запуска записной книжки. Для Create Run вы можете создать новый идентификатор GUID и использовать его здесь. Для других действий это тот же идентификатор, который используется в Create Run.

options

RunNotebookCancelRunOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RunNotebookResponse>

getSnapshot(string, RunNotebookGetSnapshotOptionalParams)

Получение моментального снимка RunNotebook для идентификатора запуска.

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

Параметры

runId

string

Идентификатор запуска записной книжки. Для Create Run вы можете создать новый идентификатор GUID и использовать его здесь. Для других действий это тот же идентификатор, который используется в Create Run.

options

RunNotebookGetSnapshotOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RunNotebookSnapshotResponse>

getStatus(string, RunNotebookGetStatusOptionalParams)

Получение состояния RunNotebook для идентификатора запуска.

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

Параметры

runId

string

Идентификатор запуска записной книжки. Для Create Run вы можете создать новый идентификатор GUID и использовать его здесь. Для других действий это тот же идентификатор, который используется в Create Run.

options

RunNotebookGetStatusOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RunNotebookResponse>