Package version:

Interface SynapseNotebookActivity

Execute Synapse notebook activity.

interface SynapseNotebookActivity {
    conf?: any;
    configurationType?: string;
    dependsOn?: ActivityDependency[];
    description?: string;
    driverSize?: any;
    executorSize?: any;
    linkedServiceName?: LinkedServiceReference;
    name: string;
    notebook: SynapseNotebookReference;
    numExecutors?: any;
    onInactiveMarkAs?: string;
    parameters?: {
        [propertyName: string]: NotebookParameter;
    };
    policy?: ActivityPolicy;
    sparkConfig?: {
        [propertyName: string]: any;
    };
    sparkPool?: BigDataPoolParametrizationReference;
    state?: string;
    targetSparkConfiguration?: SparkConfigurationParametrizationReference;
    type: "SynapseNotebook";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

conf? configurationType? dependsOn? description? driverSize? executorSize? linkedServiceName? name notebook numExecutors? onInactiveMarkAs? parameters? policy? sparkConfig? sparkPool? state? targetSparkConfiguration? type userProperties?

Properties

Optionalconf

conf?: any

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

OptionalconfigurationType

configurationType?: string

The type of the spark config.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionaldriverSize

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

OptionalexecutorSize

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

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

name

name: string

Activity name.

notebook

notebook: SynapseNotebookReference

Synapse notebook reference.

OptionalnumExecutors

numExecutors?: any

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

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

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.

Optionalparameters

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

Notebook parameters.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

OptionalsparkConfig

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

Spark configuration property.

OptionalsparkPool

sparkPool?: BigDataPoolParametrizationReference

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

Optionalstate

state?: string

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

OptionaltargetSparkConfiguration

targetSparkConfiguration?: SparkConfigurationParametrizationReference

The spark configuration of the spark job.

type

type

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

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility