RunNotebook interface

Paquet:

@azure/synapse-artifacts

Interface représentant un RunNotebook.

Méthodes

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Exécuter le notebook
beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)	Exécuter le notebook
cancelRun(string, RunNotebookCancelRunOptionalParams)	Annuler l’exécution du bloc-notes.
getSnapshot(string, RunNotebookGetSnapshotOptionalParams)	Obtenir l’instantané RunNotebook pour l’ID d’exécution.
getStatus(string, RunNotebookGetStatusOptionalParams)	Obtenir l’état de RunNotebook pour l’ID d’exécution.

Détails de la méthode

beginCreateRun(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

Exécuter le notebook

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

Paramètres

runId

string

ID d’exécution du bloc-notes. Pour Create Run, vous pouvez générer un nouveau GUID et l’utiliser ici. Pour les autres actions, il s’agit du même ID que celui utilisé dans Create Run.

runNotebookRequest

RunNotebookRequest

Exécutez la charge utile de demande de bloc-notes.

options

RunNotebookCreateRunOptionalParams

Paramètres d’options.

Retours

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

beginCreateRunAndWait(string, RunNotebookRequest, RunNotebookCreateRunOptionalParams)

Exécuter le notebook

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

Paramètres

runId

string

ID d’exécution du bloc-notes. Pour Create Run, vous pouvez générer un nouveau GUID et l’utiliser ici. Pour les autres actions, il s’agit du même ID que celui utilisé dans Create Run.

runNotebookRequest

RunNotebookRequest

Exécutez la charge utile de demande de bloc-notes.

options

RunNotebookCreateRunOptionalParams

Paramètres d’options.

Retours

Promise<RunNotebookCreateRunResponse>

cancelRun(string, RunNotebookCancelRunOptionalParams)

Annuler l’exécution du bloc-notes.

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

Paramètres

runId

string

ID d’exécution du bloc-notes. Pour Create Run, vous pouvez générer un nouveau GUID et l’utiliser ici. Pour les autres actions, il s’agit du même ID que celui utilisé dans Create Run.

options

RunNotebookCancelRunOptionalParams

Paramètres d’options.

Retours

Promise<RunNotebookResponse>

getSnapshot(string, RunNotebookGetSnapshotOptionalParams)

Obtenir l’instantané RunNotebook pour l’ID d’exécution.

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

Paramètres

runId

string

ID d’exécution du bloc-notes. Pour Create Run, vous pouvez générer un nouveau GUID et l’utiliser ici. Pour les autres actions, il s’agit du même ID que celui utilisé dans Create Run.

options

RunNotebookGetSnapshotOptionalParams

Paramètres d’options.

Retours

Promise<RunNotebookSnapshotResponse>

getStatus(string, RunNotebookGetStatusOptionalParams)

Obtenir l’état de RunNotebook pour l’ID d’exécution.

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

Paramètres

runId

string

ID d’exécution du bloc-notes. Pour Create Run, vous pouvez générer un nouveau GUID et l’utiliser ici. Pour les autres actions, il s’agit du même ID que celui utilisé dans Create Run.

options

RunNotebookGetStatusOptionalParams

Paramètres d’options.

Retours

Promise<RunNotebookResponse>