ScriptActivity interface

Package:
@azure/arm-datafactory

Script activity type.

Extends
ExecutionActivity

Properties

logSettings

Log settings of script activity.
returnMultistatementResult

Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean).
scriptBlockExecutionTimeout

ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
scripts

Array of script blocks. Type: array.
treatDecimalAsString

Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean).
type

Type of activity.

Inherited Properties

additionalProperties

Additional 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

logSettings

Log settings of script activity.

logSettings?: ScriptActivityTypePropertiesLogSettings

Property Value

ScriptActivityTypePropertiesLogSettings

returnMultistatementResult

Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean).

returnMultistatementResult?: any

Property Value

any

scriptBlockExecutionTimeout

ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

scriptBlockExecutionTimeout?: any

Property Value

any

scripts

Array of script blocks. Type: array.

scripts?: ScriptActivityScriptBlock[]

Property Value

ScriptActivityScriptBlock[]

treatDecimalAsString

Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean).

treatDecimalAsString?: any

Property Value

any

type

Type of activity.

type: "Script"

Property Value

"Script"

Inherited Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

Inherited From ExecutionActivity.additionalProperties

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