CopyActivity interface

Package:

@azure/arm-datafactory

Copy activity.

Extends

ExecutionActivity

Properties

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.
enableSkipIncompatibleRow	Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
enableStaging	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.
logSettings	Log settings customer needs provide when enabling log.
logStorageSettings	(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.
outputs	List of outputs for the activity.
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.
preserve	Preserve rules.
preserveRules	Preserve Rules.
redirectIncompatibleRowSettings	Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
sink	Copy activity sink.
skipErrorFile	Specify the fault tolerance for data consistency.
source	Copy activity source.
stagingSettings	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
validateDataConsistency	Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).

Inherited Properties

dependsOn	Activity depends on condition.
description	Activity description.
linkedServiceName	Linked service reference.
name	Activity 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.
policy	Activity policy.
state	Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties	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?: any

Property Value

any

enableSkipIncompatibleRow

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

enableSkipIncompatibleRow?: any

Property Value

any

enableStaging

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

enableStaging?: any

Property Value

any

inputs

List of inputs for the activity.

inputs?: DatasetReference[]

Property Value

DatasetReference[]

logSettings

Log settings customer needs provide when enabling log.

logSettings?: LogSettings

Property Value

LogSettings

logStorageSettings

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

logStorageSettings?: LogStorageSettings

Property Value

LogStorageSettings

outputs

List of outputs for the activity.

outputs?: DatasetReference[]

Property Value

DatasetReference[]

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?: any

Property 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?: RedirectIncompatibleRowSettings

Property Value

RedirectIncompatibleRowSettings

sink

Copy activity sink.

sink: CopySinkUnion

Property Value

CopySinkUnion

skipErrorFile

Specify the fault tolerance for data consistency.

skipErrorFile?: SkipErrorFile

Property Value

SkipErrorFile

source

Copy activity source.

source: CopySourceUnion

Property Value

CopySourceUnion

stagingSettings

Specifies interim staging settings when EnableStaging is true.

stagingSettings?: StagingSettings

Property Value

StagingSettings

translator

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

translator?: any

Property 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?: any

Property Value

any

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.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?: string

Property Value

string

Inherited From ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties