ForEachActivity Class

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

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.ControlActivity
ForEachActivity

Constructor

ForEachActivity(*, name: str, items: _models.Expression, activities: List[_models.Activity], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty] | None = None, is_sequential: bool | None = None, batch_count: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

name
str

Activity name. Required.

description
str

Activity description.

state

Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".

on_inactive_mark_as

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. Known values are: "Succeeded", "Failed", and "Skipped".

depends_on

Activity depends on condition.

user_properties

Activity user properties.

is_sequential

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

batch_count
int

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

items

Collection to iterate. Required.

activities

List of activities to execute . Required.

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

name
str

Activity name. Required.

type
str

Type of activity. Required.

description
str

Activity description.

state

Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".

on_inactive_mark_as

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. Known values are: "Succeeded", "Failed", and "Skipped".

depends_on

Activity depends on condition.

user_properties

Activity user properties.

is_sequential

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

batch_count
int

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

items

Collection to iterate. Required.

activities

List of activities to execute . Required.