SetVariableActivity Class

Set value for a Variable.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.ControlActivity

SetVariableActivity

Constructor

SetVariableActivity(*, name: str, 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, policy: _models.SecureInputOutputPolicy | None = None, variable_name: str | None = None, value: MutableMapping[str, Any] | None = None, set_system_variable: bool | 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.
policy	SecureInputOutputPolicy Activity policy.
variable_name	str Name of the variable whose value needs to be set.
value	<xref:JSON> Value to be set. Could be a static value or Expression.
set_system_variable	bool If set to true, it sets the pipeline run return value.

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.
policy	SecureInputOutputPolicy Activity policy.
variable_name	str Name of the variable whose value needs to be set.
value	<xref:JSON> Value to be set. Could be a static value or Expression.
set_system_variable	bool If set to true, it sets the pipeline run return value.