CopyActivity Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Copy activity.
public class CopyActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CopyActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CopyActivity>public class CopyActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivitytype CopyActivity = class
inherit ExecutionActivity
interface IJsonModel<CopyActivity>
interface IPersistableModel<CopyActivity>type CopyActivity = class
inherit ExecutionActivityPublic Class CopyActivity
Inherits ExecutionActivity
Implements IJsonModel(Of CopyActivity), IPersistableModel(Of CopyActivity)Public Class CopyActivity
Inherits ExecutionActivity- Inheritance
- Implements
Constructors
| CopyActivity(String, CopyActivitySource, CopySink) |
Initializes a new instance of CopyActivity. |
Properties
| AdditionalProperties |
Additional Properties To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| 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 PipelineActivity) |
| Description |
Activity description. (Inherited from PipelineActivity) |
| 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 PipelineActivity) |
| 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 PipelineActivity) |
| 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. To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| PreserveRules |
Preserve Rules. To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| 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, DataFactoryBlobSink, CommonDataServiceForAppsSink, CosmosDBMongoDBApiSink, CosmosDBSqlApiSink, DelimitedTextSink, DocumentDBCollectionSink, DynamicsCrmSink, DynamicsSink, FileSystemSink, IcebergSink, InformixSink, JsonSink, LakeHouseTableSink, MicrosoftAccessSink, MongoDBAtlasSink, MongoDBV2Sink, 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 CopyActivitySource 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, DataFactoryBlobSource, CassandraSource, CommonDataServiceForAppsSource, ConcurSource, CosmosDBMongoDBApiSource, CosmosDBSqlApiSource, CouchbaseSource, Db2Source, DelimitedTextSource, DocumentDBCollectionSource, DrillSource, DynamicsAXSource, DynamicsCrmSource, DynamicsSource, EloquaSource, ExcelSource, FileSystemSource, GoogleAdWordsSource, GoogleBigQuerySource, GoogleBigQueryV2Source, GreenplumSource, HBaseSource, HdfsSource, HiveSource, DataFactoryHttpFileSource, 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 PipelineActivity) |
| Translator |
Copy activity translator. If not specified, tabular translator is used. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| UserProperties |
Activity user properties. (Inherited from PipelineActivity) |
| ValidateDataConsistency |
Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean). |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ExecutionActivity) |
