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: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, inputs: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, outputs: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, translator: Optional[object] = None, enable_staging: Optional[object] = None, staging_settings: Optional[azure.synapse.artifacts.models._models_py3.StagingSettings] = None, parallel_copies: Optional[object] = None, data_integration_units: Optional[object] = None, enable_skip_incompatible_row: Optional[object] = None, redirect_incompatible_row_settings: Optional[azure.synapse.artifacts.models._models_py3.RedirectIncompatibleRowSettings] = None, preserve_rules: Optional[List[object]] = None, preserve: Optional[List[object]] = 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.

preserve_rules

list[object]

Required

Preserve Rules.

preserve

list[object]

Required

Preserve rules.