CopyActivity interface
Copy activity.
- Extends
Properties
| data |
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 |
Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean). |
| enable |
Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean). |
| inputs | List of inputs for the activity. |
| log |
Log settings customer needs provide when enabling log. |
| log |
(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log. |
| outputs | List of outputs for the activity. |
| parallel |
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. |
| preserve | Preserve rules. |
| preserve |
Preserve Rules. |
| redirect |
Redirect incompatible row settings when EnableSkipIncompatibleRow is true. |
| sink | Copy activity sink. |
| skip |
Specify the fault tolerance for data consistency. |
| source | Copy activity source. |
| staging |
Specifies interim staging settings when EnableStaging is true. |
| translator | Copy activity translator. If not specified, tabular translator is used. |
| type | Polymorphic discriminator, which specifies the different types this object can be |
| validate |
Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean). |
Inherited Properties
| depends |
Activity depends on condition. |
| description | Activity description. |
| linked |
Linked service reference. |
| name | Activity name. |
| on |
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. |
| policy | Activity policy. |
| state | Activity state. This is an optional property and if not provided, the state will be Active by default. |
| user |
Activity user properties. |
Property Details
dataIntegrationUnits
Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
dataIntegrationUnits?: anyProperty Value
any
enableSkipIncompatibleRow
Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
enableSkipIncompatibleRow?: anyProperty Value
any
enableStaging
Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
enableStaging?: anyProperty Value
any
inputs
logSettings
Log settings customer needs provide when enabling log.
logSettings?: LogSettingsProperty Value
logStorageSettings
(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.
logStorageSettings?: LogStorageSettingsProperty Value
outputs
parallelCopies
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.
parallelCopies?: anyProperty Value
any
preserve
Preserve rules.
preserve?: any[]Property Value
any[]
preserveRules
Preserve Rules.
preserveRules?: any[]Property Value
any[]
redirectIncompatibleRowSettings
Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
redirectIncompatibleRowSettings?: RedirectIncompatibleRowSettingsProperty Value
sink
skipErrorFile
Specify the fault tolerance for data consistency.
skipErrorFile?: SkipErrorFileProperty Value
source
stagingSettings
Specifies interim staging settings when EnableStaging is true.
stagingSettings?: StagingSettingsProperty Value
translator
Copy activity translator. If not specified, tabular translator is used.
translator?: anyProperty Value
any
type
Polymorphic discriminator, which specifies the different types this object can be
type: "Copy"Property Value
"Copy"
validateDataConsistency
Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).
validateDataConsistency?: anyProperty Value
any
Inherited Property Details
dependsOn
Activity depends on condition.
dependsOn?: ActivityDependency[]Property Value
Inherited From ExecutionActivity.dependsOn
description
Activity description.
description?: stringProperty Value
string
Inherited From ExecutionActivity.description
linkedServiceName
Linked service reference.
linkedServiceName?: LinkedServiceReferenceProperty Value
Inherited From ExecutionActivity.linkedServiceName
name
onInactiveMarkAs
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.
onInactiveMarkAs?: stringProperty Value
string
Inherited From ExecutionActivity.onInactiveMarkAs
policy
state
Activity state. This is an optional property and if not provided, the state will be Active by default.
state?: stringProperty Value
string
Inherited From ExecutionActivity.state
userProperties
Activity user properties.
userProperties?: UserProperty[]Property Value
Inherited From ExecutionActivity.userProperties