Package version:

Interface CopyActivity

Copy activity.

interface CopyActivity {
    dataIntegrationUnits?: any;
    dependsOn?: ActivityDependency[];
    description?: string;
    enableSkipIncompatibleRow?: any;
    enableStaging?: any;
    inputs?: DatasetReference[];
    linkedServiceName?: LinkedServiceReference;
    logSettings?: LogSettings;
    logStorageSettings?: LogStorageSettings;
    name: string;
    onInactiveMarkAs?: string;
    outputs?: DatasetReference[];
    parallelCopies?: any;
    policy?: ActivityPolicy;
    preserve?: any[];
    preserveRules?: any[];
    redirectIncompatibleRowSettings?: RedirectIncompatibleRowSettings;
    sink: CopySinkUnion;
    skipErrorFile?: SkipErrorFile;
    source: CopySourceUnion;
    stagingSettings?: StagingSettings;
    state?: string;
    translator?: any;
    type: "Copy";
    userProperties?: UserProperty[];
    validateDataConsistency?: any;
}

Hierarchy (view full)

Properties

dataIntegrationUnits? dependsOn? description? enableSkipIncompatibleRow? enableStaging? inputs? linkedServiceName? logSettings? logStorageSettings? name onInactiveMarkAs? outputs? parallelCopies? policy? preserve? preserveRules? redirectIncompatibleRowSettings? sink skipErrorFile? source stagingSettings? state? translator? type userProperties? validateDataConsistency?

Properties

OptionaldataIntegrationUnits

dataIntegrationUnits?: any

Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

OptionalenableSkipIncompatibleRow

enableSkipIncompatibleRow?: any

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

OptionalenableStaging

enableStaging?: any

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

Optionalinputs

inputs?: DatasetReference[]

List of inputs for the activity.

OptionallinkedServiceName

linkedServiceName?: LinkedServiceReference

Linked service reference.

OptionallogSettings

logSettings?: LogSettings

Log settings customer needs provide when enabling log.

OptionallogStorageSettings

logStorageSettings?: LogStorageSettings

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

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

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.

Optionaloutputs

outputs?: DatasetReference[]

List of outputs for the activity.

OptionalparallelCopies

parallelCopies?: any

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.

Optionalpolicy

policy?: ActivityPolicy

Activity policy.

Optionalpreserve

preserve?: any[]

Preserve rules.

OptionalpreserveRules

preserveRules?: any[]

Preserve Rules.

OptionalredirectIncompatibleRowSettings

redirectIncompatibleRowSettings?: RedirectIncompatibleRowSettings

Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

sink

sink: CopySinkUnion

Copy activity sink.

OptionalskipErrorFile

skipErrorFile?: SkipErrorFile

Specify the fault tolerance for data consistency.

source

source: CopySourceUnion

Copy activity source.

OptionalstagingSettings

stagingSettings?: StagingSettings

Specifies interim staging settings when EnableStaging is true.

Optionalstate

state?: string

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

Optionaltranslator

translator?: any

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

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

OptionalvalidateDataConsistency

validateDataConsistency?: any

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

Settings

Member Visibility