Package version:

Interface ExecutionActivity

Base class for all execution activities.

interface ExecutionActivity {
    dependsOn?: ActivityDependency[];
    description?: string;
    linkedServiceName?: LinkedServiceReference;
    name: string;
    onInactiveMarkAs?: string;
    policy?: ActivityPolicy;
    state?: string;
    type:
        | "Execution"
        | "Copy"
        | "HDInsightHive"
        | "HDInsightPig"
        | "HDInsightMapReduce"
        | "HDInsightStreaming"
        | "HDInsightSpark"
        | "ExecuteSSISPackage"
        | "Custom"
        | "SqlServerStoredProcedure"
        | "Delete"
        | "AzureDataExplorerCommand"
        | "Lookup"
        | "WebActivity"
        | "GetMetadata"
        | "AzureMLBatchExecution"
        | "AzureMLUpdateResource"
        | "AzureMLExecutePipeline"
        | "DataLakeAnalyticsU-SQL"
        | "DatabricksNotebook"
        | "DatabricksSparkJar"
        | "DatabricksSparkPython"
        | "AzureFunctionActivity"
        | "ExecuteDataFlow"
        | "Script"
        | "SynapseNotebook"
        | "SparkJob";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

dependsOn?: ActivityDependency[]

Activity depends on condition.

description?: string

Activity description.

linkedServiceName?: LinkedServiceReference

Linked service reference.

name: string

Activity name.

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.

Activity policy.

state?: string

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

type:
    | "Execution"
    | "Copy"
    | "HDInsightHive"
    | "HDInsightPig"
    | "HDInsightMapReduce"
    | "HDInsightStreaming"
    | "HDInsightSpark"
    | "ExecuteSSISPackage"
    | "Custom"
    | "SqlServerStoredProcedure"
    | "Delete"
    | "AzureDataExplorerCommand"
    | "Lookup"
    | "WebActivity"
    | "GetMetadata"
    | "AzureMLBatchExecution"
    | "AzureMLUpdateResource"
    | "AzureMLExecutePipeline"
    | "DataLakeAnalyticsU-SQL"
    | "DatabricksNotebook"
    | "DatabricksSparkJar"
    | "DatabricksSparkPython"
    | "AzureFunctionActivity"
    | "ExecuteDataFlow"
    | "Script"
    | "SynapseNotebook"
    | "SparkJob"

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

userProperties?: UserProperty[]

Activity user properties.