CopyActivity Class

Copy activity.

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

Inheritance
azure.synapse.artifacts.models._models_py3.ExecutionActivity
CopyActivity

Constructor

CopyActivity(*, name: str, source: azure.synapse.artifacts.models._models_py3.CopySource, sink: azure.synapse.artifacts.models._models_py3.CopySink, additional_properties: typing.Union[typing.Dict[str, object], NoneType] = None, description: typing.Union[str, NoneType] = None, depends_on: typing.Union[typing.List[_ForwardRef('ActivityDependency')], NoneType] = None, user_properties: typing.Union[typing.List[_ForwardRef('UserProperty')], NoneType] = None, linked_service_name: typing.Union[_ForwardRef('LinkedServiceReference'), NoneType] = None, policy: typing.Union[_ForwardRef('ActivityPolicy'), NoneType] = None, inputs: typing.Union[typing.List[_ForwardRef('DatasetReference')], NoneType] = None, outputs: typing.Union[typing.List[_ForwardRef('DatasetReference')], NoneType] = None, translator: object = None, enable_staging: object = None, staging_settings: typing.Union[_ForwardRef('StagingSettings'), NoneType] = None, parallel_copies: object = None, data_integration_units: object = None, enable_skip_incompatible_row: object = None, redirect_incompatible_row_settings: typing.Union[_ForwardRef('RedirectIncompatibleRowSettings'), NoneType] = None, log_storage_settings: typing.Union[_ForwardRef('LogStorageSettings'), NoneType] = None, log_settings: typing.Union[_ForwardRef('LogSettings'), NoneType] = None, preserve_rules: typing.Union[typing.List[object], NoneType] = None, preserve: typing.Union[typing.List[object], NoneType] = None, validate_data_consistency: object = None, skip_error_file: typing.Union[_ForwardRef('SkipErrorFile'), NoneType] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

name
str
Required

Required. Activity name.

type
str
Required

Required. Type of activity.Constant filled by server.

description
str
Required

Activity description.

depends_on
list[ActivityDependency]
Required

Activity depends on condition.

user_properties
list[UserProperty]
Required

Activity user properties.

linked_service_name
LinkedServiceReference
Required

Linked service reference.

policy
ActivityPolicy
Required

Activity policy.

inputs
list[DatasetReference]
Required

List of inputs for the activity.

outputs
list[DatasetReference]
Required

List of outputs for the activity.

source
CopySource
Required

Required. Copy activity source.

sink
CopySink
Required

Required. Copy activity sink.

translator
object
Required

Copy activity translator. If not specified, tabular translator is used.

enable_staging
object
Required

Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

staging_settings
StagingSettings
Required

Specifies interim staging settings when EnableStaging is true.

parallel_copies
object
Required

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
object
Required

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
object
Required

Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

redirect_incompatible_row_settings
RedirectIncompatibleRowSettings
Required

Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

log_storage_settings
LogStorageSettings
Required

(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.

log_settings
LogSettings
Required

Log settings customer needs provide when enabling log.

preserve_rules
list[object]
Required

Preserve Rules.

preserve
list[object]
Required

Preserve rules.

validate_data_consistency
object
Required

Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

skip_error_file
SkipErrorFile
Required

Specify the fault tolerance for data consistency.