CopyActivity Class

Reference

Copy activity.

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

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

CopyActivity

Constructor

CopyActivity(*, name: str, source: _models.CopySource, sink: _models.CopySink, 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, inputs: List[_models.DatasetReference] | None = None, outputs: List[_models.DatasetReference] | None = None, translator: MutableMapping[str, Any] | None = None, enable_staging: MutableMapping[str, Any] | None = None, staging_settings: _models.StagingSettings | None = None, parallel_copies: MutableMapping[str, Any] | None = None, data_integration_units: MutableMapping[str, Any] | None = None, enable_skip_incompatible_row: MutableMapping[str, Any] | None = None, redirect_incompatible_row_settings: _models.RedirectIncompatibleRowSettings | None = None, log_storage_settings: _models.LogStorageSettings | None = None, log_settings: _models.LogSettings | None = None, preserve_rules: List[MutableMapping[str, Any]] | None = None, preserve: List[MutableMapping[str, Any]] | None = None, validate_data_consistency: MutableMapping[str, Any] | None = None, skip_error_file: _models.SkipErrorFile | 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.
inputs	list[DatasetReference] List of inputs for the activity.
outputs	list[DatasetReference] List of outputs for the activity.
source	CopySource Copy activity source. Required.
sink	CopySink Copy activity sink. Required.
translator	<xref:JSON> Copy activity translator. If not specified, tabular translator is used.
enable_staging	<xref:JSON> Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
staging_settings	StagingSettings Specifies interim staging settings when EnableStaging is true.
parallel_copies	<xref:JSON> Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.
data_integration_units	<xref:JSON> Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
enable_skip_incompatible_row	<xref:JSON> Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
redirect_incompatible_row_settings	RedirectIncompatibleRowSettings Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
log_storage_settings	LogStorageSettings (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.
log_settings	LogSettings Log settings customer needs provide when enabling log.
preserve_rules	list[<xref:JSON>] Preserve Rules.
preserve	list[<xref:JSON>] Preserve rules.
validate_data_consistency	<xref:JSON> Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).
skip_error_file	SkipErrorFile Specify the fault tolerance for data consistency.

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.
inputs	list[DatasetReference] List of inputs for the activity.
outputs	list[DatasetReference] List of outputs for the activity.
source	CopySource Copy activity source. Required.
sink	CopySink Copy activity sink. Required.
translator	<xref:JSON> Copy activity translator. If not specified, tabular translator is used.
enable_staging	<xref:JSON> Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
staging_settings	StagingSettings Specifies interim staging settings when EnableStaging is true.
parallel_copies	<xref:JSON> Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.
data_integration_units	<xref:JSON> Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
enable_skip_incompatible_row	<xref:JSON> Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
redirect_incompatible_row_settings	RedirectIncompatibleRowSettings Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
log_storage_settings	LogStorageSettings (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.
log_settings	LogSettings Log settings customer needs provide when enabling log.
preserve_rules	list[<xref:JSON>] Preserve Rules.
preserve	list[<xref:JSON>] Preserve rules.
validate_data_consistency	<xref:JSON> Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).
skip_error_file	SkipErrorFile Specify the fault tolerance for data consistency.

Share via

CopyActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources