CopyActivity Class

Definition

Copy activity.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CopyActivity+CopyActivityConverter))]
public class CopyActivity : Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CopyActivity+CopyActivityConverter))>]
type CopyActivity = class
    inherit ExecutionActivity
Public Class CopyActivity
Inherits ExecutionActivity
Inheritance
System.Object
CopyActivity
Attributes
System.Text.Json.Serialization.JsonConverterAttribute

Constructors

CopyActivity(String, CopySource, CopySink)

Initializes a new instance of CopyActivity.

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.

DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
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.

Item[String]

Gets or sets the element with the specified key.

(Inherited from Activity)
Keys

Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

(Inherited from Activity)
LinkedServiceName

Linked service reference.

(Inherited from ExecutionActivity)
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.

Name

Activity name.

(Inherited from Activity)
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.

Policy

Activity policy.

(Inherited from ExecutionActivity)
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.

UserProperties

Activity user properties.

(Inherited from Activity)
ValidateDataConsistency

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

Values

Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.

(Inherited from Activity)

Methods

Add(String, Object)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

(Inherited from Activity)
ContainsKey(String)

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

(Inherited from Activity)
GetEnumerator()

Returns an enumerator that iterates through the collection.

(Inherited from Activity)
Remove(String)

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

(Inherited from Activity)
TryGetValue(String, Object)

Gets the value associated with the specified key.

(Inherited from Activity)

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)

Adds an item to the System.Collections.Generic.ICollection`1.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.Clear()

Removes all items from the System.Collections.Generic.ICollection`1.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)

Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)

Copies the elements of the System.Collections.Generic.ICollection`1 to an System.Array, starting at a particular System.Array index.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.Count

Gets the number of elements contained in the System.Collections.Generic.ICollection`1.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.

(Inherited from Activity)
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1.

(Inherited from Activity)
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

(Inherited from Activity)

Extension Methods

GetValueOrAdd<TKey,TValue>(IDictionary<TKey,TValue>, TKey, Func<TKey,TValue>)

Gets or adds the value associated with specified key.

GetValueOrDefault<TKey,TValue>(IDictionary<TKey,TValue>, TKey, TValue)

Gets the value associated with specified key.

Applies to