RunNotebookClient.StartCreateRun Method

Reference

Definition

Namespace:: Azure.Analytics.Synapse.Artifacts

Assembly:: Azure.Analytics.Synapse.Artifacts.dll

Package:: Azure.Analytics.Synapse.Artifacts v1.0.0-preview.21

Source:: RunNotebookClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Run notebook.

public virtual Azure.Analytics.Synapse.Artifacts.RunNotebookCreateRunOperation StartCreateRun(string runId, Azure.Analytics.Synapse.Artifacts.Models.RunNotebookRequest runNotebookRequest, System.Threading.CancellationToken cancellationToken = default);

abstract member StartCreateRun : string * Azure.Analytics.Synapse.Artifacts.Models.RunNotebookRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.RunNotebookCreateRunOperation
override this.StartCreateRun : string * Azure.Analytics.Synapse.Artifacts.Models.RunNotebookRequest * System.Threading.CancellationToken -> Azure.Analytics.Synapse.Artifacts.RunNotebookCreateRunOperation

Public Overridable Function StartCreateRun (runId As String, runNotebookRequest As RunNotebookRequest, Optional cancellationToken As CancellationToken = Nothing) As RunNotebookCreateRunOperation

Parameters

runId: String

Notebook run id. For Create Run, you can generate a new GUID and use it here. For other actions, this is the same ID used in Create Run.

runNotebookRequest: RunNotebookRequest

Run notebook request payload.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

RunNotebookCreateRunOperation

Exceptions

ArgumentNullException

runId or runNotebookRequest is null.

Applies to