CustomActivity Class

Reference

Custom activity type.

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

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

CustomActivity

Constructor

CustomActivity(*, name: str, command: MutableMapping[str, Any], 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, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, resource_linked_service: _models.LinkedServiceReference | None = None, folder_path: MutableMapping[str, Any] | None = None, reference_objects: _models.CustomActivityReferenceObject | None = None, extended_properties: Dict[str, MutableMapping[str, Any]] | None = None, retention_time_in_days: MutableMapping[str, Any] | None = None, auto_user_specification: MutableMapping[str, Any] | 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.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
command	<xref:JSON> Command for custom activity Type: string (or Expression with resultType string). Required.
resource_linked_service	LinkedServiceReference Resource linked service reference.
folder_path	<xref:JSON> Folder path for resource files Type: string (or Expression with resultType string).
reference_objects	CustomActivityReferenceObject Reference objects.
extended_properties	dict[str, <xref:JSON>] User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
retention_time_in_days	<xref:JSON> The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).
auto_user_specification	<xref:JSON> Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).

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.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
command	<xref:JSON> Command for custom activity Type: string (or Expression with resultType string). Required.
resource_linked_service	LinkedServiceReference Resource linked service reference.
folder_path	<xref:JSON> Folder path for resource files Type: string (or Expression with resultType string).
reference_objects	CustomActivityReferenceObject Reference objects.
extended_properties	dict[str, <xref:JSON>] User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
retention_time_in_days	<xref:JSON> The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).
auto_user_specification	<xref:JSON> Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).

Share via

CustomActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources