Share via

CopyActivity Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
CopyActivity.cs

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
Object
Activity
ExecutionActivity
CopyActivity
Attributes
JsonConverterAttribute

Constructors

CopyActivity(String, CopySource, CopySink)

Initializes a new instance of CopyActivity.

Properties

AdditionalProperties

Additional Properties.

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

(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. Please note CopySink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroSink, AzureBlobFSSink, AzureDatabricksDeltaLakeSink, AzureDataExplorerSink, AzureDataLakeStoreSink, AzureMySqlSink, AzurePostgreSqlSink, AzureQueueSink, AzureSearchIndexSink, AzureSqlSink, AzureTableSink, BinarySink, BlobSink, CommonDataServiceForAppsSink, CosmosDbMongoDbApiSink, CosmosDbSqlApiSink, DelimitedTextSink, DocumentDbCollectionSink, DynamicsCrmSink, DynamicsSink, FileSystemSink, InformixSink, JsonSink, LakeHouseTableSink, MicrosoftAccessSink, OdbcSink, OracleSink, OrcSink, ParquetSink, RestSink, SalesforceServiceCloudSink, SalesforceServiceCloudV2Sink, SalesforceSink, SalesforceV2Sink, SapCloudForCustomerSink, SnowflakeSink, SnowflakeV2Sink, SqlDWSink, SqlMISink, SqlServerSink, SqlSink and WarehouseSink.
SkipErrorFile

Specify the fault tolerance for data consistency.
Source

Copy activity source. Please note CopySource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonMWSSource, AmazonRdsForOracleSource, AmazonRdsForSqlServerSource, AmazonRedshiftSource, AvroSource, AzureBlobFSSource, AzureDatabricksDeltaLakeSource, AzureDataExplorerSource, AzureDataLakeStoreSource, AzureMariaDBSource, AzureMySqlSource, AzurePostgreSqlSource, AzureSqlSource, AzureTableSource, BinarySource, BlobSource, CassandraSource, CommonDataServiceForAppsSource, ConcurSource, CosmosDbMongoDbApiSource, CosmosDbSqlApiSource, CouchbaseSource, Db2Source, DelimitedTextSource, DocumentDbCollectionSource, DrillSource, DynamicsAXSource, DynamicsCrmSource, DynamicsSource, EloquaSource, ExcelSource, FileSystemSource, GoogleAdWordsSource, GoogleBigQuerySource, GoogleBigQueryV2Source, GreenplumSource, HBaseSource, HdfsSource, HiveSource, HttpSource, HubspotSource, ImpalaSource, InformixSource, JiraSource, JsonSource, LakeHouseTableSource, MagentoSource, MariaDBSource, MarketoSource, MicrosoftAccessSource, MongoDbAtlasSource, MongoDbSource, MongoDbV2Source, MySqlSource, NetezzaSource, ODataSource, OdbcSource, Office365Source, OracleServiceCloudSource, OracleSource, OrcSource, ParquetSource, PaypalSource, PhoenixSource, PostgreSqlSource, PostgreSqlV2Source, PrestoSource, QuickBooksSource, RelationalSource, ResponsysSource, RestSource, SalesforceMarketingCloudSource, SalesforceServiceCloudSource, SalesforceServiceCloudV2Source, SalesforceSource, SalesforceV2Source, SapBwSource, SapCloudForCustomerSource, SapEccSource, SapHanaSource, SapOdpSource, SapOpenHubSource, SapTableSource, ServiceNowSource, ServiceNowV2Source, SharePointOnlineListSource, ShopifySource, SnowflakeSource, SnowflakeV2Source, SparkSource, SqlDWSource, SqlMISource, SqlServerSource, SqlSource, SquareSource, SybaseSource, TabularSource, TeradataSource, VerticaSource, WarehouseSource, WebSource, XeroSource, XmlSource and ZohoSource.
StagingSettings

Specifies interim staging settings when EnableStaging is true.
State

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

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

Applies to