Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SynapseNotebookActivity

Package version

Execute Synapse notebook activity.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional conf

conf: any

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

Optional dependsOn

dependsOn: ActivityDependency[]

Activity depends on condition.

Optional description

description: undefined | string

Activity description.

Optional driverSize

driverSize: any

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

Optional executorSize

executorSize: any

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

Optional linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

name

name: string

Activity name.

notebook

Synapse notebook reference.

Optional numExecutors

numExecutors: undefined | number

Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.

Optional parameters

parameters: undefined | {}

Notebook parameters.

Optional policy

Activity policy.

Optional sparkPool

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

type

type: "SynapseNotebook"

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

Optional userProperties

userProperties: UserProperty[]

Activity user properties.

Generated using TypeDoc