DeleteActivity Class

Reference

Delete activity.

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

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

DeleteActivity

Constructor

DeleteActivity(*, name: str, dataset: _models.DatasetReference, 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, recursive: MutableMapping[str, Any] | None = None, max_concurrent_connections: int | None = None, enable_logging: MutableMapping[str, Any] | None = None, log_storage_settings: _models.LogStorageSettings | None = None, store_settings: _models.StoreReadSettings | 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.
recursive	<xref:JSON> If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).
max_concurrent_connections	int The max concurrent connections to connect data source at the same time.
enable_logging	<xref:JSON> Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).
log_storage_settings	LogStorageSettings Log storage settings customer need to provide when enableLogging is true.
dataset	DatasetReference Delete activity dataset reference. Required.
store_settings	StoreReadSettings Delete activity store settings.

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.
recursive	<xref:JSON> If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).
max_concurrent_connections	int The max concurrent connections to connect data source at the same time.
enable_logging	<xref:JSON> Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).
log_storage_settings	LogStorageSettings Log storage settings customer need to provide when enableLogging is true.
dataset	DatasetReference Delete activity dataset reference. Required.
store_settings	StoreReadSettings Delete activity store settings.

Share via

DeleteActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources