SwitchActivity interface

  • Reference
Package:
@azure/arm-datafactory

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

Extends
ControlActivity

Properties

cases

List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.
defaultActivities

List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.
on

An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.
type

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

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

cases

List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.

cases?: SwitchCase[]

Property Value

SwitchCase[]

defaultActivities

List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.

defaultActivities?: ActivityUnion[]

Property Value

ActivityUnion[]

on

An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.

on: Expression

Property Value

Expression

type

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

type: "Switch"

Property Value

"Switch"

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