ForEachActivity interface

  • Reference
Package:
@azure/arm-datafactory

This activity is used for iterating over a collection and execute given activities.

Extends
ControlActivity

Properties

activities

List of activities to execute .
batchCount

Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
isSequential

Should the loop be executed in sequence or in parallel (max 50)
items

Collection to iterate.
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

activities

List of activities to execute .

activities: ActivityUnion[]

Property Value

ActivityUnion[]

batchCount

Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).

batchCount?: number

Property Value

number

isSequential

Should the loop be executed in sequence or in parallel (max 50)

isSequential?: boolean

Property Value

boolean

items

Collection to iterate.

items: Expression

Property Value

Expression

type

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

type: "ForEach"

Property Value

"ForEach"

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