ExecutePipelineActivity Class

Execute pipeline activity.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.ControlActivity

ExecutePipelineActivity

Constructor

ExecutePipelineActivity(*, name: str, pipeline: _models.PipelineReference, 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.ExecutePipelineActivityPolicy | None = None, parameters: Dict[str, MutableMapping[str, Any]] | None = None, wait_on_completion: 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	ExecutePipelineActivityPolicy Execute pipeline activity policy.
pipeline	PipelineReference Pipeline reference. Required.
parameters	dict[str, <xref:JSON>] Pipeline parameters.
wait_on_completion	bool Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

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	ExecutePipelineActivityPolicy Execute pipeline activity policy.
pipeline	PipelineReference Pipeline reference. Required.
parameters	dict[str, <xref:JSON>] Pipeline parameters.
wait_on_completion	bool Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.