SwitchActivity Class

Reference

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

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

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

SwitchActivity

Constructor

SwitchActivity(*, name: str, on: _models.Expression, 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, cases: List[_models.SwitchCase] | None = None, default_activities: List[_models.Activity] | 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	str or ActivityState 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	str or ActivityOnInactiveMarkAs 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	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
on	Expression 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. Required.
cases	list[SwitchCase] 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.
default_activities	list[Activity] 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.

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	str or ActivityState 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	str or ActivityOnInactiveMarkAs 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	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
on	Expression 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. Required.
cases	list[SwitchCase] 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.
default_activities	list[Activity] 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.

Share via

SwitchActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources