SetVariableActivity interface

  • Reference
Package:
@azure/arm-datafactory

Set value for a Variable.

Extends
ControlActivity

Properties

policy

Activity policy.
setSystemVariable

If set to true, it sets the pipeline run return value.
type

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

Value to be set. Could be a static value or Expression.
variableName

Name of the variable whose value needs to be set.

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
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.
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

policy

Activity policy.

policy?: SecureInputOutputPolicy

Property Value

SecureInputOutputPolicy

setSystemVariable

If set to true, it sets the pipeline run return value.

setSystemVariable?: boolean

Property Value

boolean

type

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

type: "SetVariable"

Property Value

"SetVariable"

value

Value to be set. Could be a static value or Expression.

value?: any

Property Value

any

variableName

Name of the variable whose value needs to be set.

variableName?: string

Property Value

string

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ControlActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ControlActivity.description

name

Activity name.

name: string

Property Value

string

Inherited From ControlActivity.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 ControlActivity.onInactiveMarkAs

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 ControlActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ControlActivity.userProperties