SynapseNotebookActivity interface

Package:

@azure/arm-datafactory

Execute Synapse notebook activity.

Extends

ExecutionActivity

Properties

conf	Spark configuration properties, which will override the 'conf' of the notebook you provide.
configurationType	The type of the spark config.
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).
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).
parameters	Notebook parameters.
sparkConfig	Spark configuration property.
sparkPool	The name of the big data pool which will be used to execute the notebook.
targetSparkConfiguration	The spark configuration of the spark job.
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

dependsOn	Activity depends on condition.
description	Activity description.
linkedServiceName	Linked service reference.
name	Activity name.
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.
policy	Activity policy.
state	Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties	Activity user properties.

Property Details

conf

Spark configuration properties, which will override the 'conf' of the notebook you provide.

conf?: any

Property Value

any

configurationType

The type of the spark config.

configurationType?: string

Property Value

string

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).

driverSize?: any

Property Value

any

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).

executorSize?: any

Property Value

any

notebook

Synapse notebook reference.

notebook: SynapseNotebookReference

Property Value

SynapseNotebookReference

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).

numExecutors?: any

Property Value

any

parameters

Notebook parameters.

parameters?: {[propertyName: string]: NotebookParameter}

Property Value

{[propertyName: string]: NotebookParameter}

sparkConfig

Spark configuration property.

sparkConfig?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

sparkPool

The name of the big data pool which will be used to execute the notebook.

sparkPool?: BigDataPoolParametrizationReference

Property Value

BigDataPoolParametrizationReference

targetSparkConfiguration

The spark configuration of the spark job.

targetSparkConfiguration?: SparkConfigurationParametrizationReference

Property Value

SparkConfigurationParametrizationReference

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SynapseNotebook"

Property Value

"SynapseNotebook"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.name

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.

onInactiveMarkAs?: string

Property Value

string

Inherited From ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties