SynapseNotebookActivity Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

SynapseNotebookActivity.cs

Execute Synapse notebook activity.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SynapseNotebookActivity+SynapseNotebookActivityConverter))]
public class SynapseNotebookActivity : Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SynapseNotebookActivity+SynapseNotebookActivityConverter))>]
type SynapseNotebookActivity = class
    inherit ExecutionActivity

Public Class SynapseNotebookActivity
Inherits ExecutionActivity

Inheritance

Object

Activity

ExecutionActivity

SynapseNotebookActivity

Attributes

JsonConverterAttribute

Constructors

SynapseNotebookActivity(String, SynapseNotebookReference)

Initializes a new instance of SynapseNotebookActivity.

Properties

AdditionalProperties	Additional Properties. (Inherited from Activity)
Conf	Spark configuration properties, which will override the 'conf' of the notebook you provide.
ConfigurationType	The type of the spark config.
DependsOn	Activity depends on condition. (Inherited from Activity)
Description	Activity description. (Inherited from Activity)
DriverSize	Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string).
ExecutorSize	Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string).
LinkedServiceName	Linked service reference. (Inherited from ExecutionActivity)
Name	Activity name. (Inherited from Activity)
Notebook	Synapse notebook reference.
NumExecutors	Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide. Type: integer (or Expression with resultType integer).
OnInactiveMarkAs	Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. (Inherited from Activity)
Parameters	Notebook parameters.
Policy	Activity policy. (Inherited from ExecutionActivity)
SparkConfig	Spark configuration property.
SparkPool	The name of the big data pool which will be used to execute the notebook.
State	Activity state. This is an optional property and if not provided, the state will be Active by default. (Inherited from Activity)
TargetSparkConfiguration	The spark configuration of the spark job.
UserProperties	Activity user properties. (Inherited from Activity)