Pipelines - Get

Service:: Data Factory

API Version:: 2018-06-01

Gets a pipeline.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The factory name.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	The pipeline name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
if-none-match		string	ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Responses

Name	Type	Description
200 OK	PipelineResource	Azure operation completed successfully.
Other Status Codes		The client has made a conditional request and the resource has not been modified.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Pipelines_Get

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline?api-version=2018-06-01


/**
 * Samples for Pipelines Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/Pipelines_Get.json
     */
    /**
     * Sample code: Pipelines_Get.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void pipelinesGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.pipelines().getWithResponse("exampleResourceGroup", "exampleFactoryName", "examplePipeline", null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python pipelines_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.pipelines.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        pipeline_name="examplePipeline",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Pipelines_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Pipelines_Get.json
// this example is just showing the usage of "Pipelines_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
DataFactoryPipelineResource result = await dataFactoryPipeline.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryPipelineData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

Date: Mon, 22 Apr 2019 18:33:51 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: f3865c61-4888-4b91-a617-9a985d9dd0fd
x-ms-ratelimit-remaining-subscription-reads: 11991
x-ms-request-id: f3865c61-4888-4b91-a617-9a985d9dd0fd

{
  "name": "examplePipeline",
  "type": "Microsoft.DataFactory/factories/pipelines",
  "etag": "1500504f-0000-0200-0000-5cbe090f0000",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline",
  "properties": {
    "description": "Example description",
    "activities": [
      {
        "name": "ExampleForeachActivity",
        "type": "ForEach",
        "typeProperties": {
          "activities": [
            {
              "name": "ExampleCopyActivity",
              "type": "Copy",
              "inputs": [
                {
                  "type": "DatasetReference",
                  "parameters": {
                    "MyFileName": "examplecontainer.csv",
                    "MyFolderPath": "examplecontainer"
                  },
                  "referenceName": "exampleDataset"
                }
              ],
              "outputs": [
                {
                  "type": "DatasetReference",
                  "parameters": {
                    "MyFileName": {
                      "type": "Expression",
                      "value": "@item()"
                    },
                    "MyFolderPath": "examplecontainer"
                  },
                  "referenceName": "exampleDataset"
                }
              ],
              "typeProperties": {
                "dataIntegrationUnits": 32,
                "sink": {
                  "type": "BlobSink"
                },
                "source": {
                  "type": "BlobSource"
                }
              }
            }
          ],
          "isSequential": true,
          "items": {
            "type": "Expression",
            "value": "@pipeline().parameters.OutputBlobNameList"
          }
        }
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      }
    },
    "policy": {
      "elapsedTimeMetric": {
        "duration": "0.00:10:00"
      }
    },
    "variables": {
      "TestVariableArray": {
        "type": "Array"
      }
    }
  }
}

Status code:: 304

Definitions

Name	Description
ActivityDependency	Activity dependency information.
ActivityOnInactiveMarkAs	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.
ActivityPolicy	Execution policy for an activity.
ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
AmazonMWSSource	A copy activity Amazon Marketplace Web Service source.
AmazonRdsForOraclePartitionSettings	The settings that will be leveraged for AmazonRdsForOracle source partitioning.
AmazonRdsForOracleSource	A copy activity AmazonRdsForOracle source.
AmazonRdsForSqlServerSource	A copy activity Amazon RDS for SQL Server source.
AmazonRedshiftSource	A copy activity source for Amazon Redshift Source.
AmazonS3CompatibleReadSettings	Amazon S3 Compatible read settings.
AmazonS3ReadSettings	Amazon S3 read settings.
AppendVariableActivity	Append value for a Variable of type Array.
AvroSink	A copy activity Avro sink.
AvroSource	A copy activity Avro source.
AvroWriteSettings	Avro write settings.
AzureBlobFSReadSettings	Azure blobFS read settings.
AzureBlobFSSink	A copy activity Azure Data Lake Storage Gen2 sink.
AzureBlobFSSource	A copy activity Azure BlobFS source.
AzureBlobFSWriteSettings	Azure blobFS write settings.
AzureBlobStorageReadSettings	Azure blob read settings.
AzureBlobStorageWriteSettings	Azure blob write settings.
AzureDatabricksDeltaLakeExportCommand	Azure Databricks Delta Lake export command settings.
AzureDatabricksDeltaLakeImportCommand	Azure Databricks Delta Lake import command settings.
AzureDatabricksDeltaLakeSink	A copy activity Azure Databricks Delta Lake sink.
AzureDatabricksDeltaLakeSource	A copy activity Azure Databricks Delta Lake source.
AzureDataExplorerCommandActivity	Azure Data Explorer command activity.
AzureDataExplorerSink	A copy activity Azure Data Explorer sink.
AzureDataExplorerSource	A copy activity Azure Data Explorer (Kusto) source.
AzureDataLakeStoreReadSettings	Azure data lake store read settings.
AzureDataLakeStoreSink	A copy activity Azure Data Lake Store sink.
AzureDataLakeStoreSource	A copy activity Azure Data Lake source.
AzureDataLakeStoreWriteSettings	Azure data lake store write settings.
AzureFileStorageReadSettings	Azure File Storage read settings.
AzureFileStorageWriteSettings	Azure File Storage write settings.
AzureFunctionActivity	Azure Function activity.
AzureFunctionActivityMethod	The list of HTTP methods supported by a AzureFunctionActivity.
AzureKeyVaultSecretReference	Azure Key Vault secret reference.
AzureMariaDBSource	A copy activity Azure MariaDB source.
AzureMLBatchExecutionActivity	Azure ML Batch Execution activity.
AzureMLExecutePipelineActivity	Azure ML Execute Pipeline activity.
AzureMLUpdateResourceActivity	Azure ML Update Resource management activity.
AzureMLWebServiceFile	Azure ML WebService Input/Output file
AzureMySqlSink	A copy activity Azure MySql sink.
AzureMySqlSource	A copy activity Azure MySQL source.
AzurePostgreSqlSink	A copy activity Azure Database for PostgreSQL sink.
AzurePostgreSqlSinkUpsertSettings	Azure Database for PostgreSQL upsert option settings
AzurePostgreSqlSource	A copy activity Azure Database for PostgreSQL source.
AzurePostgreSqlWriteMethodEnum	The write behavior for the operation. Default is Bulk Insert.
AzureQueueSink	A copy activity Azure Queue sink.
AzureSearchIndexSink	A copy activity Azure Search Index sink.
AzureSearchIndexWriteBehaviorType	Specify the write behavior when upserting documents into Azure Search Index.
AzureSqlSink	A copy activity Azure SQL sink.
AzureSqlSource	A copy activity Azure SQL source.
AzureTableSink	A copy activity Azure Table sink.
AzureTableSource	A copy activity Azure Table source.
BigDataPoolParametrizationReference	Big data pool reference type.
BigDataPoolReferenceType	Big data pool reference type.
BinaryReadSettings	Binary read settings.
BinarySink	A copy activity Binary sink.
BinarySource	A copy activity Binary source.
BlobSink	A copy activity Azure Blob sink.
BlobSource	A copy activity Azure Blob source.
CassandraSource	A copy activity source for a Cassandra database.
CassandraSourceReadConsistencyLevels	The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.
CloudError	The object that defines the structure of an Azure Data Factory error response.
CommonDataServiceForAppsSink	A copy activity Common Data Service for Apps sink.
CommonDataServiceForAppsSource	A copy activity Common Data Service for Apps source.
ConcurSource	A copy activity Concur Service source.
ConfigurationType	The type of the spark config.
ContinuationSettingsReference	Continuation settings for execute data flow activity.
ControlActivity	Base class for all control activities like IfCondition, ForEach , Until.
CopyActivity	Copy activity.
CopyActivityLogSettings	Settings for copy activity log.
CosmosDbMongoDbApiSink	A copy activity sink for a CosmosDB (MongoDB API) database.
CosmosDbMongoDbApiSource	A copy activity source for a CosmosDB (MongoDB API) database.
CosmosDbSqlApiSink	A copy activity Azure CosmosDB (SQL API) Collection sink.
CosmosDbSqlApiSource	A copy activity Azure CosmosDB (SQL API) Collection source.
CouchbaseSource	A copy activity Couchbase server source.
createdByType	The type of identity that created the resource.
CredentialReference	Credential reference type.
CredentialReferenceType	Credential reference type.
CustomActivity	Custom activity type.
CustomActivityReferenceObject	Reference objects for custom activity
DatabricksJobActivity	Databricks Job activity.
DatabricksNotebookActivity	DatabricksNotebook activity.
DatabricksSparkJarActivity	DatabricksSparkJar activity.
DatabricksSparkPythonActivity	DatabricksSparkPython activity.
DataFlowReference	Data flow reference type.
DataFlowReferenceType	Data flow reference type.
DataFlowStagingInfo	Staging info for execute data flow activity.
DataLakeAnalyticsUSQLActivity	Data Lake Analytics U-SQL activity.
DatasetReference	Dataset reference type.
DatasetReferenceType	Dataset reference type.
Db2Source	A copy activity source for Db2 databases.
DeleteActivity	Delete activity.
DelimitedTextReadSettings	Delimited text read settings.
DelimitedTextSink	A copy activity DelimitedText sink.
DelimitedTextSource	A copy activity DelimitedText source.
DelimitedTextWriteSettings	Delimited text write settings.
DependencyCondition
DistcpSettings	Distcp settings.
DocumentDbCollectionSink	A copy activity Document Database Collection sink.
DocumentDbCollectionSource	A copy activity Document Database Collection source.
DrillSource	A copy activity Drill server source.
DWCopyCommandDefaultValue	Default value.
DWCopyCommandSettings	DW Copy Command settings.
DynamicsAXSource	A copy activity Dynamics AX source.
DynamicsCrmSink	A copy activity Dynamics CRM sink.
DynamicsCrmSource	A copy activity Dynamics CRM source.
DynamicsSink	A copy activity Dynamics sink.
DynamicsSinkWriteBehavior	Defines values for DynamicsSinkWriteBehavior.
DynamicsSource	A copy activity Dynamics source.
EloquaSource	A copy activity Eloqua server source.
ExcelSource	A copy activity excel source.
ExecuteDataFlowActivity	Execute data flow activity.
ExecuteDataFlowActivityTypePropertiesCompute	Compute properties for data flow activity.
ExecutePipelineActivity	Execute pipeline activity.
ExecutePipelineActivityPolicy	Execution policy for an execute pipeline activity.
ExecuteSSISPackageActivity	Execute SSIS package activity.
ExecuteWranglingDataflowActivity	Execute power query activity.
ExecutionActivity	Base class for all execution activities.
Expression	Azure Data Factory expression definition.
ExpressionType	Expression type.
ExpressionV2	Nested representation of a complex expression.
ExpressionV2Type	Type of expressions supported by the system. Type: string.
FailActivity	This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.
FileServerReadSettings	File server read settings.
FileServerWriteSettings	File server write settings.
FileSystemSink	A copy activity file system sink.
FileSystemSource	A copy activity file system source.
FilterActivity	Filter and return results from input array based on the conditions.
ForEachActivity	This activity is used for iterating over a collection and execute given activities.
FtpReadSettings	Ftp read settings.
GetMetadataActivity	Activity to get metadata of dataset
GoogleAdWordsSource	A copy activity Google AdWords service source.
GoogleBigQuerySource	A copy activity Google BigQuery service source.
GoogleBigQueryV2Source	A copy activity Google BigQuery service source.
GoogleCloudStorageReadSettings	Google Cloud Storage read settings.
GreenplumSource	A copy activity Greenplum Database source.
HBaseSource	A copy activity HBase server source.
HdfsReadSettings	HDFS read settings.
HdfsSource	A copy activity HDFS source.
HDInsightActivityDebugInfoOption	The HDInsightActivityDebugInfoOption settings to use.
HDInsightHiveActivity	HDInsight Hive activity type.
HDInsightMapReduceActivity	HDInsight MapReduce activity type.
HDInsightPigActivity	HDInsight Pig activity type.
HDInsightSparkActivity	HDInsight Spark activity.
HDInsightStreamingActivity	HDInsight streaming activity type.
HiveSource	A copy activity Hive Server source.
HttpReadSettings	Http read settings.
HttpSource	A copy activity source for an HTTP file.
HubspotSource	A copy activity Hubspot Service source.
IcebergSink	A copy activity Iceberg sink.
IcebergWriteSettings	Iceberg write settings.
IfConditionActivity	This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.
ImpalaSource	A copy activity Impala server source.
InformixSink	A copy activity Informix sink.
InformixSource	A copy activity source for Informix.
IntegrationRuntimeReference	Integration runtime reference type.
IntegrationRuntimeReferenceType	Type of integration runtime.
JiraSource	A copy activity Jira Service source.
JsonReadSettings	Json read settings.
JsonSink	A copy activity Json sink.
JsonSource	A copy activity Json source.
JsonWriteSettings	Json write settings.
LakeHouseReadSettings	Microsoft Fabric Lakehouse Files read settings.
LakeHouseTableSink	A copy activity for Microsoft Fabric Lakehouse Table sink.
LakeHouseTableSource	A copy activity source for Microsoft Fabric Lakehouse Table.
LakeHouseWriteSettings	Microsoft Fabric Lakehouse Files write settings.
LinkedServiceReference	Linked service reference type.
LogLocationSettings	Log location settings.
LogSettings	Log settings.
LogStorageSettings	(Deprecated. Please use LogSettings) Log storage settings.
LookupActivity	Lookup activity.
MagentoSource	A copy activity Magento server source.
MariaDBSource	A copy activity MariaDB server source.
MarketoSource	A copy activity Marketo server source.
MetadataItem	Specify the name and value of custom metadata item.
MicrosoftAccessSink	A copy activity Microsoft Access sink.
MicrosoftAccessSource	A copy activity source for Microsoft Access.
MongoDbAtlasSink	A copy activity MongoDB Atlas sink.
MongoDbAtlasSource	A copy activity source for a MongoDB Atlas database.
MongoDbCursorMethodsProperties	Cursor methods for Mongodb query
MongoDbSource	A copy activity source for a MongoDB database.
MongoDbV2Sink	A copy activity MongoDB sink.
MongoDbV2Source	A copy activity source for a MongoDB database.
MySqlSource	A copy activity source for MySQL databases.
NetezzaPartitionSettings	The settings that will be leveraged for Netezza source partitioning.
NetezzaSource	A copy activity Netezza source.
NotebookParameter	Notebook parameter.
NotebookParameterType	Notebook parameter type.
NotebookReferenceType	Synapse notebook reference type.
ODataSource	A copy activity source for OData source.
OdbcSink	A copy activity ODBC sink.
OdbcSource	A copy activity source for ODBC databases.
Office365Source	A copy activity source for an Office 365 service.
OracleCloudStorageReadSettings	Oracle Cloud Storage read settings.
OraclePartitionSettings	The settings that will be leveraged for Oracle source partitioning.
OracleServiceCloudSource	A copy activity Oracle Service Cloud source.
OracleSink	A copy activity Oracle sink.
OracleSource	A copy activity Oracle source.
OrcSink	A copy activity ORC sink.
OrcSource	A copy activity ORC source.
OrcWriteSettings	Orc write settings.
ParameterSpecification	Definition of a single parameter for an entity.
ParameterType	Parameter type.
ParquetReadSettings	Parquet read settings.
ParquetSink	A copy activity Parquet sink.
ParquetSource	A copy activity Parquet source.
ParquetWriteSettings	Parquet write settings.
PaypalSource	A copy activity Paypal Service source.
PhoenixSource	A copy activity Phoenix server source.
PipelineElapsedTimeMetricPolicy	Pipeline ElapsedTime Metric Policy.
PipelineFolder	The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
PipelinePolicy	Pipeline Policy.
PipelineReference	Pipeline reference type.
PipelineReferenceType	Pipeline reference type.
PipelineResource	Pipeline resource type.
PolybaseSettings	PolyBase settings.
PolybaseSettingsRejectType	Indicates whether the RejectValue property is specified as a literal value or a percentage.
PostgreSqlSource	A copy activity source for PostgreSQL databases.
PostgreSqlV2Source	A copy activity source for PostgreSQL databases.
PowerQuerySink	Power query sink.
PowerQuerySinkMapping	Map Power Query mashup query to sink dataset(s).
PrestoSource	A copy activity Presto server source.
QuickBooksSource	A copy activity QuickBooks server source.
RedirectIncompatibleRowSettings	Redirect incompatible row settings
RedshiftUnloadSettings	The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.
RelationalSource	A copy activity source for various relational databases.
ResponsysSource	A copy activity Responsys source.
RestSink	A copy activity Rest service Sink.
RestSource	A copy activity Rest service source.
SalesforceMarketingCloudSource	A copy activity Salesforce Marketing Cloud source.
SalesforceServiceCloudSink	A copy activity Salesforce Service Cloud sink.
SalesforceServiceCloudSource	A copy activity Salesforce Service Cloud source.
SalesforceServiceCloudV2Sink	A copy activity Salesforce Service Cloud V2 sink.
SalesforceServiceCloudV2Source	A copy activity Salesforce Service Cloud V2 source.
SalesforceSink	A copy activity Salesforce sink.
SalesforceSinkWriteBehavior	The write behavior for the operation. Default is Insert.
SalesforceSource	A copy activity Salesforce source.
SalesforceV2Sink	A copy activity Salesforce V2 sink.
SalesforceV2SinkWriteBehavior	The write behavior for the operation. Default is Insert.
SalesforceV2Source	A copy activity Salesforce V2 source.
SapBwSource	A copy activity source for SapBW server via MDX.
SapCloudForCustomerSink	A copy activity SAP Cloud for Customer sink.
SapCloudForCustomerSinkWriteBehavior	The write behavior for the operation. Default is 'Insert'.
SapCloudForCustomerSource	A copy activity source for SAP Cloud for Customer source.
SapEccSource	A copy activity source for SAP ECC source.
SapHanaPartitionSettings	The settings that will be leveraged for SAP HANA source partitioning.
SapHanaSource	A copy activity source for SAP HANA source.
SapOdpSource	A copy activity source for SAP ODP source.
SapOpenHubSource	A copy activity source for SAP Business Warehouse Open Hub Destination source.
SapTablePartitionSettings	The settings that will be leveraged for SAP table source partitioning.
SapTableSource	A copy activity source for SAP Table source.
ScriptActivity	Script activity type.
ScriptActivityLogDestination	The destination of logs. Type: string.
ScriptActivityParameter	Parameters of a script block.
ScriptActivityParameterDirection	The direction of the parameter.
ScriptActivityParameterType	The type of the parameter.
ScriptActivityScriptBlock	Script block of scripts.
ScriptActivityTypePropertiesLogSettings	Log settings of script activity.
SecureInputOutputPolicy	Execution policy for an activity that supports secure input and output.
SecureString	Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.
ServiceNowSource	A copy activity ServiceNow server source.
ServiceNowV2Source	A copy activity ServiceNowV2 server source.
SetVariableActivity	Set value for a Variable.
SftpReadSettings	Sftp read settings.
SftpWriteSettings	Sftp write settings.
SharePointOnlineListSource	A copy activity source for sharePoint online list source.
ShopifySource	A copy activity Shopify Service source.
SkipErrorFile	Skip error file.
SnowflakeExportCopyCommand	Snowflake export command settings.
SnowflakeImportCopyCommand	Snowflake import command settings.
SnowflakeSink	A copy activity snowflake sink.
SnowflakeSource	A copy activity snowflake source.
SnowflakeV2Sink	A copy activity snowflake sink.
SnowflakeV2Source	A copy activity snowflake source.
SparkConfigurationParametrizationReference	Spark configuration reference.
SparkConfigurationReferenceType	Spark configuration reference type.
SparkJobReferenceType	Synapse spark job reference type.
SparkSource	A copy activity Spark Server source.
SqlDWSink	A copy activity SQL Data Warehouse sink.
SqlDWSource	A copy activity SQL Data Warehouse source.
SqlDWUpsertSettings	Sql DW upsert option settings
SqlMISink	A copy activity Azure SQL Managed Instance sink.
SqlMISource	A copy activity Azure SQL Managed Instance source.
SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
SqlServerSink	A copy activity SQL server sink.
SqlServerSource	A copy activity SQL server source.
SqlServerStoredProcedureActivity	SQL stored procedure activity type.
SqlSink	A copy activity SQL sink.
SqlSource	A copy activity SQL source.
SqlUpsertSettings	Sql upsert option settings
SquareSource	A copy activity Square Service source.
SSISAccessCredential	SSIS access credential.
SSISChildPackage	SSIS embedded child package.
SSISExecutionCredential	SSIS package execution credential.
SSISExecutionParameter	SSIS execution parameter.
SSISLogLocation	SSIS package execution log location
SsisLogLocationType	The type of SSIS log location.
SSISPackageLocation	SSIS package location.
SsisPackageLocationType	The type of SSIS package location.
SSISPropertyOverride	SSIS property override.
StagingSettings	Staging settings.
SwitchActivity	This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.
SwitchCase	Switch cases with have a value and corresponding activities.
SybaseSource	A copy activity source for Sybase databases.
SynapseNotebookActivity	Execute Synapse notebook activity.
SynapseNotebookReference	Synapse notebook reference type.
SynapseSparkJobDefinitionActivity	Execute spark job activity.
SynapseSparkJobReference	Synapse spark job reference type.
systemData	Metadata pertaining to creation and last modification of the resource.
TabularSource	Copy activity sources of tabular type.
TarGZipReadSettings	The TarGZip compression read settings.
TarReadSettings	The Tar compression read settings.
TeradataImportCommand	Teradata import command settings.
TeradataPartitionSettings	The settings that will be leveraged for teradata source partitioning.
TeradataSink	A copy activity Teradata sink.
TeradataSource	A copy activity Teradata source.
Type	Linked service reference type.
UntilActivity	This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.
UserProperty	User property.
ValidationActivity	This activity verifies that an external resource exists.
VariableSpecification	Definition of a single variable for a Pipeline.
VariableType	Variable type.
VerticaSource	A copy activity Vertica source.
WaitActivity	This activity suspends pipeline execution for the specified interval.
WarehouseSink	A copy activity Microsoft Fabric Warehouse sink.
WarehouseSource	A copy activity Microsoft Fabric Warehouse source.
WebActivity	Web activity.
WebActivityAuthentication	Web activity authentication properties.
WebActivityMethod	The list of HTTP methods supported by a WebActivity.
WebHookActivity	WebHook activity.
WebHookActivityMethod	The list of HTTP methods supported by a WebHook activity.
WebSource	A copy activity source for web page table.
XeroSource	A copy activity Xero Service source.
XmlReadSettings	Xml read settings.
XmlSource	A copy activity Xml source.
ZipDeflateReadSettings	The ZipDeflate compression read settings.
ZohoSource	A copy activity Zoho server source.

ActivityDependency

Object

Activity dependency information.

Name	Type	Description
activity	string	Activity name.
dependencyConditions	DependencyCondition[]	Match-Condition for the dependency.

ActivityOnInactiveMarkAs

Enumeration

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.

Value	Description
Succeeded	Succeeded
Failed	Failed
Skipped	Skipped

ActivityPolicy

Object

Execution policy for an activity.

Name	Type	Description
retry		Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.
retryIntervalInSeconds	integer (int32) minimum: 30 maximum: 86400	Interval between each retry attempt (in seconds). The default is 30 sec.
secureInput	boolean	When set to true, Input from activity is considered as secure and will not be logged to monitoring.
secureOutput	boolean	When set to true, Output from activity is considered as secure and will not be logged to monitoring.
timeout		Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

ActivityState

Enumeration

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

Value	Description
Active	Active
Inactive	Inactive

AmazonMWSSource

Object

A copy activity Amazon Marketplace Web Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AmazonMWSSource	Copy source type.

AmazonRdsForOraclePartitionSettings

Object

The settings that will be leveraged for AmazonRdsForOracle source partitioning.

Name	Type	Description
partitionColumnName		The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionNames		Names of the physical partitions of AmazonRdsForOracle table.
partitionUpperBound		The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

AmazonRdsForOracleSource

Object

A copy activity AmazonRdsForOracle source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
numberPrecision		The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0.
numberScale		The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0.
oracleReaderQuery		AmazonRdsForOracle reader query. Type: string (or Expression with resultType string).
partitionOption		The partition mechanism that will be used for AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string).
partitionSettings	AmazonRdsForOraclePartitionSettings	The settings that will be leveraged for AmazonRdsForOracle source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AmazonRdsForOracleSource	Copy source type.

AmazonRdsForSqlServerSource

Object

A copy activity Amazon RDS for SQL Server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
produceAdditionalTypes		Which additional types to produce.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	string: AmazonRdsForSqlServerSource	Copy source type.

AmazonRedshiftSource

Object

A copy activity source for Amazon Redshift Source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
redshiftUnloadSettings	RedshiftUnloadSettings	The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AmazonRedshiftSource	Copy source type.

AmazonS3CompatibleReadSettings

Object

Amazon S3 Compatible read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the S3 Compatible object name. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AmazonS3CompatibleReadSettings	The read setting type.
wildcardFileName		Amazon S3 Compatible wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Amazon S3 Compatible wildcardFolderPath. Type: string (or Expression with resultType string).

AmazonS3ReadSettings

Object

Amazon S3 read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AmazonS3ReadSettings	The read setting type.
wildcardFileName		AmazonS3 wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string).

AppendVariableActivity

Object

Append value for a Variable of type Array.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AppendVariable	Type of activity.
typeProperties.value		Value to be appended. Type: could be a static value matching type of the variable item or Expression with resultType matching type of the variable item
typeProperties.variableName	string	Name of the variable whose value needs to be appended to.
userProperties	UserProperty[]	Activity user properties.

AvroSink

Object

A copy activity Avro sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	AvroWriteSettings	Avro format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	Avro store settings.
type	string: AvroSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AvroSource

Object

A copy activity Avro source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Avro store settings.
type	string: AvroSource	Copy source type.

AvroWriteSettings

Object

Avro write settings.

Name	Type	Description
fileNamePrefix		Specifies the file name pattern <fileNamePrefix>_<fileIndex>.<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).
maxRowsPerFile		Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).
recordName	string	Top level record name in write result, which is required in AVRO spec.
recordNamespace	string	Record namespace in the write result.
type	string: AvroWriteSettings	The write setting type.

AzureBlobFSReadSettings

Object

Azure blobFS read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AzureBlobFSReadSettings	The read setting type.
wildcardFileName		Azure blobFS wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string).

AzureBlobFSSink

Object

A copy activity Azure Data Lake Storage Gen2 sink.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureBlobFSSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureBlobFSSource

Object

A copy activity Azure BlobFS source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
skipHeaderLineCount		Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
treatEmptyAsNull		Treat empty as null. Type: boolean (or Expression with resultType boolean).
type	string: AzureBlobFSSource	Copy source type.

AzureBlobFSWriteSettings

Object

Azure blobFS write settings.

Name	Type	Description
blockSizeInMB		Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: AzureBlobFSWriteSettings	The write setting type.

AzureBlobStorageReadSettings

Object

Azure blob read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AzureBlobStorageReadSettings	The read setting type.
wildcardFileName		Azure blob wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Azure blob wildcardFolderPath. Type: string (or Expression with resultType string).

AzureBlobStorageWriteSettings

Object

Azure blob write settings.

Name	Type	Description
blockSizeInMB		Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: AzureBlobStorageWriteSettings	The write setting type.

AzureDatabricksDeltaLakeExportCommand

Object

Azure Databricks Delta Lake export command settings.

Name	Type	Description
dateFormat		Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).
timestampFormat		Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).
type	string: AzureDatabricksDeltaLakeExportCommand	The export setting type.

AzureDatabricksDeltaLakeImportCommand

Object

Azure Databricks Delta Lake import command settings.

Name	Type	Description
dateFormat		Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).
timestampFormat		Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).
type	string: AzureDatabricksDeltaLakeImportCommand	The import setting type.

AzureDatabricksDeltaLakeSink

Object

A copy activity Azure Databricks Delta Lake sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
importSettings	AzureDatabricksDeltaLakeImportCommand	Azure Databricks Delta Lake import settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDatabricksDeltaLakeSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureDatabricksDeltaLakeSource

Object

A copy activity Azure Databricks Delta Lake source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
exportSettings	AzureDatabricksDeltaLakeExportCommand	Azure Databricks Delta Lake export settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDatabricksDeltaLakeSource	Copy source type.

AzureDataExplorerCommandActivity

Object

Azure Data Explorer command activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AzureDataExplorerCommand	Type of activity.
typeProperties.command		A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string).
typeProperties.commandTimeout		Control command timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9]))..)
userProperties	UserProperty[]	Activity user properties.

AzureDataExplorerSink

Object

A copy activity Azure Data Explorer sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
flushImmediately		If set to true, any aggregation will be skipped. Default is false. Type: boolean.
ingestionMappingAsJson		An explicit column mapping description provided in a json format. Type: string.
ingestionMappingName		A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDataExplorerSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureDataExplorerSource

Object

A copy activity Azure Data Explorer (Kusto) source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
noTruncation		The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit.
query		Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9]))..
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDataExplorerSource	Copy source type.

AzureDataLakeStoreReadSettings

Object

Azure data lake store read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
listAfter		Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).
listBefore		Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AzureDataLakeStoreReadSettings	The read setting type.
wildcardFileName		ADLS wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		ADLS wildcardFolderPath. Type: string (or Expression with resultType string).

AzureDataLakeStoreSink

Object

A copy activity Azure Data Lake Store sink.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enableAdlsSingleFileParallel		Single File Parallel.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDataLakeStoreSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureDataLakeStoreSource

Object

A copy activity Azure Data Lake source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureDataLakeStoreSource	Copy source type.

AzureDataLakeStoreWriteSettings

Object

Azure data lake store write settings.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
expiryDateTime		Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of "2018-12-01T05:00:00Z". Default value is NULL. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: AzureDataLakeStoreWriteSettings	The write setting type.

AzureFileStorageReadSettings

Object

Azure File Storage read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: AzureFileStorageReadSettings	The read setting type.
wildcardFileName		Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).

AzureFileStorageWriteSettings

Object

Azure File Storage write settings.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: AzureFileStorageWriteSettings	The write setting type.

AzureFunctionActivity

Object

Azure Function activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AzureFunctionActivity	Type of activity.
typeProperties.body		Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
typeProperties.functionName		Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)
typeProperties.headers		Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
typeProperties.method	AzureFunctionActivityMethod	Rest API method for target endpoint.
userProperties	UserProperty[]	Activity user properties.

AzureFunctionActivityMethod

Enumeration

The list of HTTP methods supported by a AzureFunctionActivity.

Value	Description
GET	GET
POST	POST
PUT	PUT
DELETE	DELETE
OPTIONS	OPTIONS
HEAD	HEAD
TRACE	TRACE

AzureKeyVaultSecretReference

Object

Azure Key Vault secret reference.

Name	Type	Description
secretName		The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
secretVersion		The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
store	LinkedServiceReference	The Azure Key Vault linked service reference.
type	string: AzureKeyVaultSecret	Type of the secret.

AzureMariaDBSource

Object

A copy activity Azure MariaDB source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureMariaDBSource	Copy source type.

AzureMLBatchExecutionActivity

Object

Azure ML Batch Execution activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AzureMLBatchExecution	Type of activity.
typeProperties.globalParameters		Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.
typeProperties.webServiceInputs	<string, AzureMLWebServiceFile>	Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.
typeProperties.webServiceOutputs	<string, AzureMLWebServiceFile>	Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.
userProperties	UserProperty[]	Activity user properties.

AzureMLExecutePipelineActivity

Object

Azure ML Execute Pipeline activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AzureMLExecutePipeline	Type of activity.
typeProperties.continueOnStepFailure		Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).
typeProperties.dataPathAssignments		Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).
typeProperties.experimentName		Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).
typeProperties.mlParentRunId		The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).
typeProperties.mlPipelineEndpointId		ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
typeProperties.mlPipelineId		ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).
typeProperties.mlPipelineParameters		Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).
typeProperties.version		Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

AzureMLUpdateResourceActivity

Object

Azure ML Update Resource management activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: AzureMLUpdateResource	Type of activity.
typeProperties.trainedModelFilePath		The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).
typeProperties.trainedModelLinkedServiceName	LinkedServiceReference	Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.
typeProperties.trainedModelName		Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

AzureMLWebServiceFile

Object

Azure ML WebService Input/Output file

Name	Type	Description
filePath		The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).
linkedServiceName	LinkedServiceReference	Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

AzureMySqlSink

Object

A copy activity Azure MySql sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		A query to execute before starting the copy. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureMySqlSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureMySqlSource

Object

A copy activity Azure MySQL source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureMySqlSource	Copy source type.

AzurePostgreSqlSink

Object

A copy activity Azure Database for PostgreSQL sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		A query to execute before starting the copy. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzurePostgreSqlSink	Copy sink type.
upsertSettings	AzurePostgreSqlSinkUpsertSettings	Azure Database for PostgreSQL upsert option settings
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeMethod	AzurePostgreSqlWriteMethodEnum	The write behavior for the operation. Default is Bulk Insert.

AzurePostgreSqlSinkUpsertSettings

Object

Azure Database for PostgreSQL upsert option settings

Name	Type	Description
keys		Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings).

AzurePostgreSqlSource

Object

A copy activity Azure Database for PostgreSQL source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzurePostgreSqlSource	Copy source type.

AzurePostgreSqlWriteMethodEnum

Enumeration

The write behavior for the operation. Default is Bulk Insert.

Value	Description
BulkInsert	BulkInsert
CopyCommand	CopyCommand
Upsert	Upsert

AzureQueueSink

Object

A copy activity Azure Queue sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureQueueSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureSearchIndexSink

Object

A copy activity Azure Search Index sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureSearchIndexSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	AzureSearchIndexWriteBehaviorType	Specify the write behavior when upserting documents into Azure Search Index.

AzureSearchIndexWriteBehaviorType

Enumeration

Specify the write behavior when upserting documents into Azure Search Index.

Value	Description
Merge	Merge
Upload	Upload

AzureSqlSink

Object

A copy activity Azure SQL sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlWriterStoredProcedureName		SQL writer stored procedure name. Type: string (or Expression with resultType string).
sqlWriterTableType		SQL writer table type. Type: string (or Expression with resultType string).
sqlWriterUseTableLock		Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
storedProcedureParameters		SQL stored procedure parameters.
storedProcedureTableTypeParameterName		The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: AzureSqlSink	Copy sink type.
upsertSettings	SqlUpsertSettings	SQL upsert settings.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)

AzureSqlSource

Object

A copy activity Azure SQL source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
produceAdditionalTypes		Which additional types to produce.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	string: AzureSqlSource	Copy source type.

AzureTableSink

Object

A copy activity Azure Table sink.

Name	Type	Description
azureTableDefaultPartitionKeyValue		Azure Table default partition key value. Type: string (or Expression with resultType string).
azureTableInsertType		Azure Table insert type. Type: string (or Expression with resultType string).
azureTablePartitionKeyName		Azure Table partition key name. Type: string (or Expression with resultType string).
azureTableRowKeyName		Azure Table row key name. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureTableSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

AzureTableSource

Object

A copy activity Azure Table source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
azureTableSourceIgnoreTableNotFound		Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).
azureTableSourceQuery		Azure Table source query. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: AzureTableSource	Copy source type.

BigDataPoolParametrizationReference

Object

Big data pool reference type.

Name	Type	Description
referenceName		Reference big data pool name. Type: string (or Expression with resultType string).
type	BigDataPoolReferenceType	Big data pool reference type.

BigDataPoolReferenceType

Enumeration

Big data pool reference type.

Value	Description
BigDataPoolReference	BigDataPoolReference

BinaryReadSettings

Object

Binary read settings.

Name	Type	Description
compressionProperties	CompressionReadSettings: TarGZipReadSettings TarReadSettings ZipDeflateReadSettings	Compression settings.
type	string: BinaryReadSettings	The read setting type.

BinarySink

Object

A copy activity Binary sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	Binary store settings.
type	string: BinarySink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

BinarySource

Object

A copy activity Binary source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	BinaryReadSettings	Binary format settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Binary store settings.
type	string: BinarySource	Copy source type.

BlobSink

Object

A copy activity Azure Blob sink.

Name	Type	Description
blobWriterAddHeader		Blob writer add header. Type: boolean (or Expression with resultType boolean).
blobWriterDateTimeFormat		Blob writer date time format. Type: string (or Expression with resultType string).
blobWriterOverwriteFiles		Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: BlobSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

BlobSource

Object

A copy activity Azure Blob source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
skipHeaderLineCount		Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
treatEmptyAsNull		Treat empty as null. Type: boolean (or Expression with resultType boolean).
type	string: BlobSource	Copy source type.

CassandraSource

Object

A copy activity source for a Cassandra database.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
consistencyLevel	CassandraSourceReadConsistencyLevels	The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CassandraSource	Copy source type.

CassandraSourceReadConsistencyLevels

Enumeration

The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.

Value	Description
ALL	ALL
EACH_QUORUM	EACH_QUORUM
QUORUM	QUORUM
LOCAL_QUORUM	LOCAL_QUORUM
ONE	ONE
TWO	TWO
THREE	THREE
LOCAL_ONE	LOCAL_ONE
SERIAL	SERIAL
LOCAL_SERIAL	LOCAL_SERIAL

CloudError

Object

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

CommonDataServiceForAppsSink

Object

A copy activity Common Data Service for Apps sink.

Name	Type	Description
alternateKeyName		The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).
bypassBusinessLogicExecution		Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
bypassPowerAutomateFlows		Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
ignoreNullValues		The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CommonDataServiceForAppsSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	DynamicsSinkWriteBehavior	The write behavior for the operation.

CommonDataServiceForAppsSource

Object

A copy activity Common Data Service for Apps source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CommonDataServiceForAppsSource	Copy source type.

ConcurSource

Object

A copy activity Concur Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ConcurSource	Copy source type.

ConfigurationType

Enumeration

The type of the spark config.

Value	Description
Default	Default
Customized	Customized
Artifact	Artifact

ContinuationSettingsReference

Object

Continuation settings for execute data flow activity.

Name	Type	Description
continuationTtlInMinutes		Continuation TTL in minutes.
customizedCheckpointKey		Customized checkpoint key.
idleCondition		Idle condition.

ControlActivity

Object

Base class for all control activities like IfCondition, ForEach , Until.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Container	Type of activity.
userProperties	UserProperty[]	Activity user properties.

CopyActivity

Object

Copy activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
inputs	DatasetReference[]	List of inputs for the activity.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
outputs	DatasetReference[]	List of outputs for the activity.
policy	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Copy	Type of activity.
typeProperties.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.
typeProperties.enableSkipIncompatibleRow		Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.enableStaging		Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.logSettings	LogSettings	Log settings customer needs provide when enabling log.
typeProperties.logStorageSettings	LogStorageSettings	(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.
typeProperties.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.
typeProperties.preserve	CopyActivityTypeProperties.Preserve[]	Preserve rules.
typeProperties.preserveRules	CopyActivityTypeProperties.PreserveRules[]	Preserve Rules.
typeProperties.redirectIncompatibleRowSettings	RedirectIncompatibleRowSettings	Redirect incompatible row settings when EnableSkipIncompatibleRow is true.
typeProperties.sink	CopySink: AvroSink AzureBlobFSSink AzureDataExplorerSink AzureDataLakeStoreSink AzureDatabricksDeltaLakeSink AzureMySqlSink AzurePostgreSqlSink AzureQueueSink AzureSearchIndexSink AzureSqlSink AzureTableSink BinarySink BlobSink 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 TeradataSink WarehouseSink	Copy activity sink.
typeProperties.skipErrorFile	SkipErrorFile	Specify the fault tolerance for data consistency.
typeProperties.source	CopySource: AmazonMWSSource AmazonRdsForOracleSource AmazonRdsForSqlServerSource AmazonRedshiftSource AvroSource AzureBlobFSSource AzureDataExplorerSource AzureDataLakeStoreSource AzureDatabricksDeltaLakeSource 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 ZohoSource	Copy activity source.
typeProperties.stagingSettings	StagingSettings	Specifies interim staging settings when EnableStaging is true.
typeProperties.translator		Copy activity translator. If not specified, tabular translator is used.
typeProperties.validateDataConsistency		Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).
userProperties	UserProperty[]	Activity user properties.

CopyActivityLogSettings

Object

Settings for copy activity log.

Name	Type	Description
enableReliableLogging		Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).
logLevel		Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).

CosmosDbMongoDbApiSink

Object

A copy activity sink for a CosmosDB (MongoDB API) database.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CosmosDbMongoDbApiSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

CosmosDbMongoDbApiSource

Object

A copy activity source for a CosmosDB (MongoDB API) database.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
batchSize		Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
cursorMethods	MongoDbCursorMethodsProperties	Cursor methods for Mongodb query.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
filter		Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CosmosDbMongoDbApiSource	Copy source type.

CosmosDbSqlApiSink

Object

A copy activity Azure CosmosDB (SQL API) Collection sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CosmosDbSqlApiSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

CosmosDbSqlApiSource

Object

A copy activity Azure CosmosDB (SQL API) Collection source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
detectDatetime		Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
pageSize		Page size of the result. Type: integer (or Expression with resultType integer).
preferredRegions		Preferred regions. Type: array of strings (or Expression with resultType array of strings).
query		SQL API query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CosmosDbSqlApiSource	Copy source type.

CouchbaseSource

Object

A copy activity Couchbase server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: CouchbaseSource	Copy source type.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CredentialReference

Object

Credential reference type.

Name	Type	Description
referenceName	string	Reference credential name.
type	CredentialReferenceType	Credential reference type.

CredentialReferenceType

Enumeration

Credential reference type.

Value	Description
CredentialReference	CredentialReference

CustomActivity

Object

Custom activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Custom	Type of activity.
typeProperties.autoUserSpecification		Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).
typeProperties.command		Command for custom activity Type: string (or Expression with resultType string).
typeProperties.extendedProperties		User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
typeProperties.folderPath		Folder path for resource files Type: string (or Expression with resultType string).
typeProperties.referenceObjects	CustomActivityReferenceObject	Reference objects
typeProperties.resourceLinkedService	LinkedServiceReference	Resource linked service reference.
typeProperties.retentionTimeInDays		The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).
userProperties	UserProperty[]	Activity user properties.

CustomActivityReferenceObject

Object

Reference objects for custom activity

Name	Type	Description
datasets	DatasetReference[]	Dataset references.
linkedServices	LinkedServiceReference[]	Linked service references.

DatabricksJobActivity

Object

Databricks Job activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: DatabricksJob	Type of activity.
typeProperties.jobId		The Id of the Databricks Job to be executed. Type: string (or Expression with resultType string).
typeProperties.jobParameters		Job parameters to be used for each run of this job. If the job takes a parameter that is not specified, the default value from the job will be used.
userProperties	UserProperty[]	Activity user properties.

DatabricksNotebookActivity

Object

DatabricksNotebook activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: DatabricksNotebook	Type of activity.
typeProperties.baseParameters		Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
typeProperties.libraries	DatabricksNotebookActivityTypeProperties.Libraries[]	A list of libraries to be installed on the cluster that will execute the job.
typeProperties.notebookPath		The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

DatabricksSparkJarActivity

Object

DatabricksSparkJar activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: DatabricksSparkJar	Type of activity.
typeProperties.libraries	DatabricksSparkJarActivityTypeProperties.Libraries[]	A list of libraries to be installed on the cluster that will execute the job.
typeProperties.mainClassName		The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).
typeProperties.parameters	DatabricksSparkJarActivityTypeProperties.Parameters[]	Parameters that will be passed to the main method.
userProperties	UserProperty[]	Activity user properties.

DatabricksSparkPythonActivity

Object

DatabricksSparkPython activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: DatabricksSparkPython	Type of activity.
typeProperties.libraries	DatabricksSparkPythonActivityTypeProperties.Libraries[]	A list of libraries to be installed on the cluster that will execute the job.
typeProperties.parameters	DatabricksSparkPythonActivityTypeProperties.Parameters[]	Command line parameters that will be passed to the Python file.
typeProperties.pythonFile		The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

DataFlowReference

Object

Data flow reference type.

Name	Type	Description
datasetParameters		Reference data flow parameters from dataset.
parameters		Data flow parameters
referenceName	string	Reference data flow name.
type	DataFlowReferenceType	Data flow reference type.

DataFlowReferenceType

Enumeration

Data flow reference type.

Value	Description
DataFlowReference	DataFlowReference

DataFlowStagingInfo

Object

Staging info for execute data flow activity.

Name	Type	Description
folderPath		Folder path for staging blob. Type: string (or Expression with resultType string)
linkedService	LinkedServiceReference	Staging linked service reference.

DataLakeAnalyticsUSQLActivity

Object

Data Lake Analytics U-SQL activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: DataLakeAnalyticsU-SQL	Type of activity.
typeProperties.compilationMode		Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).
typeProperties.degreeOfParallelism		The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.
typeProperties.parameters		Parameters for U-SQL job request.
typeProperties.priority		Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.
typeProperties.runtimeVersion		Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).
typeProperties.scriptLinkedService	LinkedServiceReference	Script linked service reference.
typeProperties.scriptPath		Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

DatasetReference

Object

Dataset reference type.

Name	Type	Description
parameters		Arguments for dataset.
referenceName	string	Reference dataset name.
type	DatasetReferenceType	Dataset reference type.

DatasetReferenceType

Enumeration

Dataset reference type.

Value	Description
DatasetReference	DatasetReference

Db2Source

Object

A copy activity source for Db2 databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: Db2Source	Copy source type.

DeleteActivity

Object

Delete activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Delete	Type of activity.
typeProperties.dataset	DatasetReference	Delete activity dataset reference.
typeProperties.enableLogging		Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).
typeProperties.logStorageSettings	LogStorageSettings	Log storage settings customer need to provide when enableLogging is true.
typeProperties.maxConcurrentConnections	integer (int32) minimum: 1	The max concurrent connections to connect data source at the same time.
typeProperties.recursive		If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).
typeProperties.storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Delete activity store settings.
userProperties	UserProperty[]	Activity user properties.

DelimitedTextReadSettings

Object

Delimited text read settings.

Name	Type	Description
compressionProperties	CompressionReadSettings: TarGZipReadSettings TarReadSettings ZipDeflateReadSettings	Compression settings.
skipLineCount		Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer).
type	string: DelimitedTextReadSettings	The read setting type.

DelimitedTextSink

Object

A copy activity DelimitedText sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	DelimitedTextWriteSettings	DelimitedText format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	DelimitedText store settings.
type	string: DelimitedTextSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

DelimitedTextSource

Object

A copy activity DelimitedText source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	DelimitedTextReadSettings	DelimitedText format settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	DelimitedText store settings.
type	string: DelimitedTextSource	Copy source type.

DelimitedTextWriteSettings

Object

Delimited text write settings.

Name	Type	Description
fileExtension		The file extension used to create the files. Type: string (or Expression with resultType string).
fileNamePrefix		Specifies the file name pattern <fileNamePrefix>_<fileIndex>.<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).
maxRowsPerFile		Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).
quoteAllText		Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean).
type	string: DelimitedTextWriteSettings	The write setting type.

DependencyCondition

Enumeration

Value	Description
Succeeded	Succeeded
Failed	Failed
Skipped	Skipped
Completed	Completed

DistcpSettings

Object

Distcp settings.

Name	Type	Description
distcpOptions		Specifies the Distcp options. Type: string (or Expression with resultType string).
resourceManagerEndpoint		Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).
tempScriptPath		Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).

DocumentDbCollectionSink

Object

A copy activity Document Database Collection sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
nestingSeparator		Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DocumentDbCollectionSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.

DocumentDbCollectionSource

Object

A copy activity Document Database Collection source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
nestingSeparator		Nested properties separator. Type: string (or Expression with resultType string).
query		Documents query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DocumentDbCollectionSource	Copy source type.

DrillSource

Object

A copy activity Drill server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DrillSource	Copy source type.

DWCopyCommandDefaultValue

Object

Default value.

Name	Type	Description
columnName		Column name. Type: object (or Expression with resultType string).
defaultValue		The default value of the column. Type: object (or Expression with resultType string).

DWCopyCommandSettings

Object

DW Copy Command settings.

Name	Type	Description
additionalOptions	object	Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalOptions": { "MAXERRORS": "1000", "DATEFORMAT": "'ymd'" }
defaultValues	DWCopyCommandDefaultValue[]	Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).

DynamicsAXSource

Object

A copy activity Dynamics AX source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DynamicsAXSource	Copy source type.

DynamicsCrmSink

Object

A copy activity Dynamics CRM sink.

Name	Type	Description
alternateKeyName		The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).
bypassBusinessLogicExecution		Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
bypassPowerAutomateFlows		Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
ignoreNullValues		The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DynamicsCrmSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	DynamicsSinkWriteBehavior	The write behavior for the operation.

DynamicsCrmSource

Object

A copy activity Dynamics CRM source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DynamicsCrmSource	Copy source type.

DynamicsSink

Object

A copy activity Dynamics sink.

Name	Type	Description
alternateKeyName		The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).
bypassBusinessLogicExecution		Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
bypassPowerAutomateFlows		Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
ignoreNullValues		The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DynamicsSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	DynamicsSinkWriteBehavior	The write behavior for the operation.

DynamicsSinkWriteBehavior

Enumeration

Defines values for DynamicsSinkWriteBehavior.

Value	Description
Upsert	Upsert

DynamicsSource

Object

A copy activity Dynamics source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: DynamicsSource	Copy source type.

EloquaSource

Object

A copy activity Eloqua server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: EloquaSource	Copy source type.

ExcelSource

Object

A copy activity excel source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Excel store settings.
type	string: ExcelSource	Copy source type.

ExecuteDataFlowActivity

Object

Execute data flow activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: ExecuteDataFlow	Type of activity.
typeProperties.compute	ExecuteDataFlowActivityTypePropertiesCompute	Compute properties for data flow activity.
typeProperties.continuationSettings	ContinuationSettingsReference	Continuation settings for execute data flow activity.
typeProperties.continueOnError		Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)
typeProperties.dataFlow	DataFlowReference	Data flow reference.
typeProperties.integrationRuntime	IntegrationRuntimeReference	The integration runtime reference.
typeProperties.runConcurrently		Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)
typeProperties.sourceStagingConcurrency		Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer)
typeProperties.staging	DataFlowStagingInfo	Staging info for execute data flow activity.
typeProperties.traceLevel		Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)
userProperties	UserProperty[]	Activity user properties.

ExecuteDataFlowActivityTypePropertiesCompute

Object

Compute properties for data flow activity.

Name	Type	Description
computeType		Compute type of the cluster which will execute data flow job. Possible values include: 'General', 'MemoryOptimized', 'ComputeOptimized'. Type: string (or Expression with resultType string)
coreCount		Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. Type: integer (or Expression with resultType integer)

ExecutePipelineActivity

Object

Execute pipeline activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ExecutePipelineActivityPolicy	Execute pipeline activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: ExecutePipeline	Type of activity.
typeProperties.parameters		Pipeline parameters.
typeProperties.pipeline	PipelineReference	Pipeline reference.
typeProperties.waitOnCompletion	boolean	Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.
userProperties	UserProperty[]	Activity user properties.

ExecutePipelineActivityPolicy

Object

Execution policy for an execute pipeline activity.

Name	Type	Description
secureInput	boolean	When set to true, Input from activity is considered as secure and will not be logged to monitoring.

ExecuteSSISPackageActivity

Object

Execute SSIS package activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: ExecuteSSISPackage	Type of activity.
typeProperties.connectVia	IntegrationRuntimeReference	The integration runtime reference.
typeProperties.environmentPath		The environment path to execute the SSIS package. Type: string (or Expression with resultType string).
typeProperties.executionCredential	SSISExecutionCredential	The package execution credential.
typeProperties.logLocation	SSISLogLocation	SSIS package execution log location.
typeProperties.loggingLevel		The logging level of SSIS package execution. Type: string (or Expression with resultType string).
typeProperties.packageConnectionManagers	object	The package level connection managers to execute the SSIS package.
typeProperties.packageLocation	SSISPackageLocation	SSIS package location.
typeProperties.packageParameters	<string, SSISExecutionParameter>	The package level parameters to execute the SSIS package.
typeProperties.projectConnectionManagers	object	The project level connection managers to execute the SSIS package.
typeProperties.projectParameters	<string, SSISExecutionParameter>	The project level parameters to execute the SSIS package.
typeProperties.propertyOverrides	<string, SSISPropertyOverride>	The property overrides to execute the SSIS package.
typeProperties.runtime		Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

ExecuteWranglingDataflowActivity

Object

Execute power query activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: ExecuteWranglingDataflow	Type of activity.
typeProperties.compute	ExecuteDataFlowActivityTypePropertiesCompute	Compute properties for data flow activity.
typeProperties.continuationSettings	ContinuationSettingsReference	Continuation settings for execute data flow activity.
typeProperties.continueOnError		Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)
typeProperties.dataFlow	DataFlowReference	Data flow reference.
typeProperties.integrationRuntime	IntegrationRuntimeReference	The integration runtime reference.
typeProperties.queries	PowerQuerySinkMapping[]	List of mapping for Power Query mashup query to sink dataset(s).
typeProperties.runConcurrently		Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)
typeProperties.sinks	<string, PowerQuerySink>	(Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName.
typeProperties.sourceStagingConcurrency		Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer)
typeProperties.staging	DataFlowStagingInfo	Staging info for execute data flow activity.
typeProperties.traceLevel		Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)
userProperties	UserProperty[]	Activity user properties.

ExecutionActivity

Object

Base class for all execution activities.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Execution	Type of activity.
userProperties	UserProperty[]	Activity user properties.

Expression

Object

Azure Data Factory expression definition.

Name	Type	Description
type	ExpressionType	Expression type.
value	string	Expression value.

ExpressionType

Enumeration

Expression type.

Value	Description
Expression	Expression

ExpressionV2

Object

Nested representation of a complex expression.

Name	Type	Description
operands	ExpressionV2[]	List of nested expressions.
operators	string[]	Expression operator value Type: list of strings.
type	ExpressionV2Type	Type of expressions supported by the system. Type: string.
value		Value for Constant/Field Type: object.

ExpressionV2Type

Enumeration

Type of expressions supported by the system. Type: string.

Value	Description
Constant	Constant
Field	Field
Unary	Unary
Binary	Binary
NAry	NAry

FailActivity

Object

This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Fail	Type of activity.
typeProperties.errorCode		The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
typeProperties.message		The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

FileServerReadSettings

Object

File server read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileFilter		Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: FileServerReadSettings	The read setting type.
wildcardFileName		FileServer wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		FileServer wildcardFolderPath. Type: string (or Expression with resultType string).

FileServerWriteSettings

Object

File server write settings.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: FileServerWriteSettings	The write setting type.

FileSystemSink

Object

A copy activity file system sink.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: FileSystemSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

FileSystemSource

Object

A copy activity file system source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: FileSystemSource	Copy source type.

FilterActivity

Object

Filter and return results from input array based on the conditions.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Filter	Type of activity.
typeProperties.condition	Expression	Condition to be used for filtering the input.
typeProperties.items	Expression	Input array on which filter should be applied.
userProperties	UserProperty[]	Activity user properties.

ForEachActivity

Object

This activity is used for iterating over a collection and execute given activities.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: ForEach	Type of activity.
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute .
typeProperties.batchCount	integer (int32) maximum: 50	Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).
typeProperties.isSequential	boolean	Should the loop be executed in sequence or in parallel (max 50)
typeProperties.items	Expression	Collection to iterate.
userProperties	UserProperty[]	Activity user properties.

FtpReadSettings

Object

Ftp read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableChunking		If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: FtpReadSettings	The read setting type.
useBinaryTransfer		Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean).
wildcardFileName		Ftp wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Ftp wildcardFolderPath. Type: string (or Expression with resultType string).

GetMetadataActivity

Object

Activity to get metadata of dataset

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: GetMetadata	Type of activity.
typeProperties.dataset	DatasetReference	GetMetadata activity dataset reference.
typeProperties.fieldList	GetMetadataActivityTypeProperties.FieldList[]	Fields of metadata to get from dataset.
typeProperties.formatSettings	FormatReadSettings: BinaryReadSettings DelimitedTextReadSettings JsonReadSettings ParquetReadSettings XmlReadSettings	GetMetadata activity format settings.
typeProperties.storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	GetMetadata activity store settings.
userProperties	UserProperty[]	Activity user properties.

GoogleAdWordsSource

Object

A copy activity Google AdWords service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: GoogleAdWordsSource	Copy source type.

GoogleBigQuerySource

Object

A copy activity Google BigQuery service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: GoogleBigQuerySource	Copy source type.

GoogleBigQueryV2Source

Object

A copy activity Google BigQuery service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: GoogleBigQueryV2Source	Copy source type.

GoogleCloudStorageReadSettings

Object

Google Cloud Storage read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: GoogleCloudStorageReadSettings	The read setting type.
wildcardFileName		Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

GreenplumSource

Object

A copy activity Greenplum Database source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: GreenplumSource	Copy source type.

HBaseSource

Object

A copy activity HBase server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: HBaseSource	Copy source type.

HdfsReadSettings

Object

HDFS read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
distcpSettings	DistcpSettings	Specifies Distcp-related settings.
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: HdfsReadSettings	The read setting type.
wildcardFileName		HDFS wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		HDFS wildcardFolderPath. Type: string (or Expression with resultType string).

HdfsSource

Object

A copy activity HDFS source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
distcpSettings	DistcpSettings	Specifies Distcp-related settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: HdfsSource	Copy source type.

HDInsightActivityDebugInfoOption

Enumeration

The HDInsightActivityDebugInfoOption settings to use.

Value	Description
None	None
Always	Always
Failure	Failure

HDInsightHiveActivity

Object

HDInsight Hive activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: HDInsightHive	Type of activity.
typeProperties.arguments	HDInsightHiveActivityTypeProperties.Arguments[]	User specified arguments to HDInsightActivity.
typeProperties.defines		Allows user to specify defines for Hive job request.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Debug info option.
typeProperties.queryTimeout	integer (int32)	Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)
typeProperties.scriptLinkedService	LinkedServiceReference	Script linked service reference.
typeProperties.scriptPath		Script path. Type: string (or Expression with resultType string).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Storage linked service references.
typeProperties.variables		User specified arguments under hivevar namespace.
userProperties	UserProperty[]	Activity user properties.

HDInsightMapReduceActivity

Object

HDInsight MapReduce activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: HDInsightMapReduce	Type of activity.
typeProperties.arguments	HDInsightMapReduceActivityTypeProperties.Arguments[]	User specified arguments to HDInsightActivity.
typeProperties.className		Class name. Type: string (or Expression with resultType string).
typeProperties.defines		Allows user to specify defines for the MapReduce job request.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Debug info option.
typeProperties.jarFilePath		Jar path. Type: string (or Expression with resultType string).
typeProperties.jarLibs	HDInsightMapReduceActivityTypeProperties.JarLibs[]	Jar libs.
typeProperties.jarLinkedService	LinkedServiceReference	Jar linked service reference.
typeProperties.storageLinkedServices	LinkedServiceReference[]	Storage linked service references.
userProperties	UserProperty[]	Activity user properties.

HDInsightPigActivity

Object

HDInsight Pig activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: HDInsightPig	Type of activity.
typeProperties.arguments		User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array).
typeProperties.defines		Allows user to specify defines for Pig job request.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Debug info option.
typeProperties.scriptLinkedService	LinkedServiceReference	Script linked service reference.
typeProperties.scriptPath		Script path. Type: string (or Expression with resultType string).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Storage linked service references.
userProperties	UserProperty[]	Activity user properties.

HDInsightSparkActivity

Object

HDInsight Spark activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: HDInsightSpark	Type of activity.
typeProperties.arguments	HDInsightSparkActivityTypeProperties.Arguments[]	The user-specified arguments to HDInsightSparkActivity.
typeProperties.className	string	The application's Java/Spark main class.
typeProperties.entryFilePath		The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Debug info option.
typeProperties.proxyUser		The user to impersonate that will execute the job. Type: string (or Expression with resultType string).
typeProperties.rootPath		The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).
typeProperties.sparkConfig		Spark configuration property.
typeProperties.sparkJobLinkedService	LinkedServiceReference	The storage linked service for uploading the entry file and dependencies, and for receiving logs.
userProperties	UserProperty[]	Activity user properties.

HDInsightStreamingActivity

Object

HDInsight streaming activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: HDInsightStreaming	Type of activity.
typeProperties.arguments	HDInsightStreamingActivityTypeProperties.Arguments[]	User specified arguments to HDInsightActivity.
typeProperties.combiner		Combiner executable name. Type: string (or Expression with resultType string).
typeProperties.commandEnvironment	HDInsightStreamingActivityTypeProperties.CommandEnvironment[]	Command line environment values.
typeProperties.defines		Allows user to specify defines for streaming job request.
typeProperties.fileLinkedService	LinkedServiceReference	Linked service reference where the files are located.
typeProperties.filePaths	HDInsightStreamingActivityTypeProperties.FilePaths[]	Paths to streaming job files. Can be directories.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Debug info option.
typeProperties.input		Input blob path. Type: string (or Expression with resultType string).
typeProperties.mapper		Mapper executable name. Type: string (or Expression with resultType string).
typeProperties.output		Output blob path. Type: string (or Expression with resultType string).
typeProperties.reducer		Reducer executable name. Type: string (or Expression with resultType string).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Storage linked service references.
userProperties	UserProperty[]	Activity user properties.

HiveSource

Object

A copy activity Hive Server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: HiveSource	Copy source type.

HttpReadSettings

Object

Http read settings.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
additionalHeaders		The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
requestBody		The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestMethod		The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
requestTimeout		Specifies the timeout for a HTTP client to get HTTP response from HTTP server. Type: string (or Expression with resultType string).
type	string: HttpReadSettings	The read setting type.

HttpSource

Object

A copy activity source for an HTTP file.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: HttpSource	Copy source type.

HubspotSource

Object

A copy activity Hubspot Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: HubspotSource	Copy source type.

IcebergSink

Object

A copy activity Iceberg sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	IcebergWriteSettings	Iceberg format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	Iceberg store settings.
type	string: IcebergSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

IcebergWriteSettings

Object

Iceberg write settings.

Name	Type	Description
type	string: IcebergWriteSettings	The write setting type.

IfConditionActivity

Object

This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: IfCondition	Type of activity.
typeProperties.expression	Expression	An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.
typeProperties.ifFalseActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.
typeProperties.ifTrueActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.
userProperties	UserProperty[]	Activity user properties.

ImpalaSource

Object

A copy activity Impala server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ImpalaSource	Copy source type.

InformixSink

Object

A copy activity Informix sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		A query to execute before starting the copy. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: InformixSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

InformixSource

Object

A copy activity source for Informix.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: InformixSource	Copy source type.

IntegrationRuntimeReference

Object

Integration runtime reference type.

Name	Type	Description
parameters		Arguments for integration runtime.
referenceName	string	Reference integration runtime name.
type	IntegrationRuntimeReferenceType	Type of integration runtime.

IntegrationRuntimeReferenceType

Enumeration

Type of integration runtime.

Value	Description
IntegrationRuntimeReference	IntegrationRuntimeReference

JiraSource

Object

A copy activity Jira Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: JiraSource	Copy source type.

JsonReadSettings

Object

Json read settings.

Name	Type	Description
compressionProperties	CompressionReadSettings: TarGZipReadSettings TarReadSettings ZipDeflateReadSettings	Compression settings.
type	string: JsonReadSettings	The read setting type.

JsonSink

Object

A copy activity Json sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	JsonWriteSettings	Json format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	Json store settings.
type	string: JsonSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

JsonSource

Object

A copy activity Json source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	JsonReadSettings	Json format settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Json store settings.
type	string: JsonSource	Copy source type.

JsonWriteSettings

Object

Json write settings.

Name	Type	Description
filePattern		File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.
type	string: JsonWriteSettings	The write setting type.

LakeHouseReadSettings

Object

Microsoft Fabric Lakehouse Files read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: LakeHouseReadSettings	The read setting type.
wildcardFileName		Microsoft Fabric Lakehouse Files wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Microsoft Fabric Lakehouse Files wildcardFolderPath. Type: string (or Expression with resultType string).

LakeHouseTableSink

Object

A copy activity for Microsoft Fabric Lakehouse Table sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
partitionNameList		Specify the partition column names from sink columns. Type: array of objects (or Expression with resultType array of objects).
partitionOption		Create partitions in folder structure based on one or multiple columns. Each distinct column value (pair) will be a new partition. Possible values include: "None", "PartitionByKey".
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
tableActionOption		The type of table action for Lakehouse Table sink. Possible values include: "None", "Append", "Overwrite".
type	string: LakeHouseTableSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

LakeHouseTableSource

Object

A copy activity source for Microsoft Fabric Lakehouse Table.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
timestampAsOf		Query an older snapshot by timestamp. Type: string (or Expression with resultType string).
type	string: LakeHouseTableSource	Copy source type.
versionAsOf		Query an older snapshot by version. Type: integer (or Expression with resultType integer).

LakeHouseWriteSettings

Object

Microsoft Fabric Lakehouse Files write settings.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
type	string: LakeHouseWriteSettings	The write setting type.

LinkedServiceReference

Object

Linked service reference type.

Name	Type	Description
parameters		Arguments for LinkedService.
referenceName	string	Reference LinkedService name.
type	Type	Linked service reference type.

LogLocationSettings

Object

Log location settings.

Name	Type	Description
linkedServiceName	LinkedServiceReference	Log storage linked service reference.
path		The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

LogSettings

Object

Log settings.

Name	Type	Description
copyActivityLogSettings	CopyActivityLogSettings	Specifies settings for copy activity log.
enableCopyActivityLog		Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean).
logLocationSettings	LogLocationSettings	Log location settings customer needs to provide when enabling log.

LogStorageSettings

Object

(Deprecated. Please use LogSettings) Log storage settings.

Name	Type	Description
enableReliableLogging		Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).
linkedServiceName	LinkedServiceReference	Log storage linked service reference.
logLevel		Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).
path		The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).

LookupActivity

Object

Lookup activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Lookup	Type of activity.
typeProperties.dataset	DatasetReference	Lookup activity dataset reference.
typeProperties.firstRowOnly		Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).
typeProperties.source	CopySource: AmazonMWSSource AmazonRdsForOracleSource AmazonRdsForSqlServerSource AmazonRedshiftSource AvroSource AzureBlobFSSource AzureDataExplorerSource AzureDataLakeStoreSource AzureDatabricksDeltaLakeSource 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 ZohoSource	Dataset-specific source properties, same as copy activity source.
typeProperties.treatDecimalAsString		Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean).
userProperties	UserProperty[]	Activity user properties.

MagentoSource

Object

A copy activity Magento server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MagentoSource	Copy source type.

MariaDBSource

Object

A copy activity MariaDB server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MariaDBSource	Copy source type.

MarketoSource

Object

A copy activity Marketo server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MarketoSource	Copy source type.

MetadataItem

Object

Specify the name and value of custom metadata item.

Name	Type	Description
name		Metadata item key name. Type: string (or Expression with resultType string).
value		Metadata item value. Type: string (or Expression with resultType string).

MicrosoftAccessSink

Object

A copy activity Microsoft Access sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		A query to execute before starting the copy. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MicrosoftAccessSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

MicrosoftAccessSource

Object

A copy activity source for Microsoft Access.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MicrosoftAccessSource	Copy source type.

MongoDbAtlasSink

Object

A copy activity MongoDB Atlas sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MongoDbAtlasSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

MongoDbAtlasSource

Object

A copy activity source for a MongoDB Atlas database.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
batchSize		Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
cursorMethods	MongoDbCursorMethodsProperties	Cursor methods for Mongodb query
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
filter		Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MongoDbAtlasSource	Copy source type.

MongoDbCursorMethodsProperties

Object

Cursor methods for Mongodb query

Name	Type	Description
limit		Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).
project		Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).
skip		Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).
sort		Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

MongoDbSource

Object

A copy activity source for a MongoDB database.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MongoDbSource	Copy source type.

MongoDbV2Sink

Object

A copy activity MongoDB sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MongoDbV2Sink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).

MongoDbV2Source

Object

A copy activity source for a MongoDB database.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
batchSize		Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
cursorMethods	MongoDbCursorMethodsProperties	Cursor methods for Mongodb query
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
filter		Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MongoDbV2Source	Copy source type.

MySqlSource

Object

A copy activity source for MySQL databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: MySqlSource	Copy source type.

NetezzaPartitionSettings

Object

The settings that will be leveraged for Netezza source partitioning.

Name	Type	Description
partitionColumnName		The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionUpperBound		The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

NetezzaSource

Object

A copy activity Netezza source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Netezza read in parallel. Possible values include: "None", "DataSlice", "DynamicRange".
partitionSettings	NetezzaPartitionSettings	The settings that will be leveraged for Netezza source partitioning.
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: NetezzaSource	Copy source type.

NotebookParameter

Object

Notebook parameter.

Name	Type	Description
type	NotebookParameterType	Notebook parameter type.
value		Notebook parameter value. Type: string (or Expression with resultType string).

NotebookParameterType

Enumeration

Notebook parameter type.

Value	Description
string	string
int	int
float	float
bool	bool

NotebookReferenceType

Enumeration

Synapse notebook reference type.

Value	Description
NotebookReference	NotebookReference

ODataSource

Object

A copy activity source for OData source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		OData query. For example, "$top=1". Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ODataSource	Copy source type.

OdbcSink

Object

A copy activity ODBC sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		A query to execute before starting the copy. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: OdbcSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

OdbcSource

Object

A copy activity source for ODBC databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: OdbcSource	Copy source type.

Office365Source

Object

A copy activity source for an Office 365 service.

Name	Type	Description
allowedGroups		The groups containing all the users. Type: array of strings (or Expression with resultType array of strings).
dateFilterColumn		The Column to apply the <paramref name="StartTime"/> and <paramref name="EndTime"/>. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
endTime		End time of the requested range for this dataset. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
outputColumns		The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). itemType: OutputColumn. Example: [ { "name": "Id" }, { "name": "CreatedDateTime" } ]
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
startTime		Start time of the requested range for this dataset. Type: string (or Expression with resultType string).
type	string: Office365Source	Copy source type.
userScopeFilterUri		The user scope uri. Type: string (or Expression with resultType string).

OracleCloudStorageReadSettings

Object

Oracle Cloud Storage read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
prefix		The prefix filter for the Oracle Cloud Storage object name. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: OracleCloudStorageReadSettings	The read setting type.
wildcardFileName		Oracle Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Oracle Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

OraclePartitionSettings

Object

The settings that will be leveraged for Oracle source partitioning.

Name	Type	Description
partitionColumnName		The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionNames		Names of the physical partitions of Oracle table.
partitionUpperBound		The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

OracleServiceCloudSource

Object

A copy activity Oracle Service Cloud source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: OracleServiceCloudSource	Copy source type.

OracleSink

Object

A copy activity Oracle sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: OracleSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

OracleSource

Object

A copy activity Oracle source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
numberPrecision		The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0.
numberScale		The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0.
oracleReaderQuery		Oracle reader query. Type: string (or Expression with resultType string).
partitionOption		The partition mechanism that will be used for Oracle read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".
partitionSettings	OraclePartitionSettings	The settings that will be leveraged for Oracle source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: OracleSource	Copy source type.

OrcSink

Object

A copy activity ORC sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	OrcWriteSettings	ORC format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	ORC store settings.
type	string: OrcSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

OrcSource

Object

A copy activity ORC source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	ORC store settings.
type	string: OrcSource	Copy source type.

OrcWriteSettings

Object

Orc write settings.

Name	Type	Description
fileNamePrefix		Specifies the file name pattern <fileNamePrefix>_<fileIndex>.<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).
maxRowsPerFile		Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).
type	string: OrcWriteSettings	The write setting type.

ParameterSpecification

Object

Definition of a single parameter for an entity.

Name	Type	Description
defaultValue		Default value of parameter.
type	ParameterType	Parameter type.

ParameterType

Enumeration

Parameter type.

Value	Description
Object	Object
String	String
Int	Int
Float	Float
Bool	Bool
Array	Array
SecureString	SecureString

ParquetReadSettings

Object

Parquet read settings.

Name	Type	Description
compressionProperties	CompressionReadSettings: TarGZipReadSettings TarReadSettings ZipDeflateReadSettings	Compression settings.
type	string: ParquetReadSettings	The read setting type.

ParquetSink

Object

A copy activity Parquet sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	ParquetWriteSettings	Parquet format settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreWriteSettings: AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings LakeHouseWriteSettings SftpWriteSettings	Parquet store settings.
type	string: ParquetSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

ParquetSource

Object

A copy activity Parquet source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	ParquetReadSettings	Parquet format settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Parquet store settings.
type	string: ParquetSource	Copy source type.

ParquetWriteSettings

Object

Parquet write settings.

Name	Type	Description
fileNamePrefix		Specifies the file name pattern <fileNamePrefix>_<fileIndex>.<fileExtension> when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).
maxRowsPerFile		Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).
type	string: ParquetWriteSettings	The write setting type.

PaypalSource

Object

A copy activity Paypal Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: PaypalSource	Copy source type.

PhoenixSource

Object

A copy activity Phoenix server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: PhoenixSource	Copy source type.

PipelineElapsedTimeMetricPolicy

Object

Pipeline ElapsedTime Metric Policy.

Name	Type	Description
duration		TimeSpan value, after which an Azure Monitoring Metric is fired.

PipelineFolder

Object

The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Name	Type	Description
name	string	The name of the folder that this Pipeline is in.

PipelinePolicy

Object

Pipeline Policy.

Name	Type	Description
elapsedTimeMetric	PipelineElapsedTimeMetricPolicy	Pipeline ElapsedTime Metric Policy.

PipelineReference

Object

Pipeline reference type.

Name	Type	Description
name	string	Reference name.
referenceName	string	Reference pipeline name.
type	PipelineReferenceType	Pipeline reference type.

PipelineReferenceType

Enumeration

Pipeline reference type.

Value	Description
PipelineReference	PipelineReference

PipelineResource

Object

Pipeline resource type.

Name	Type	Description
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities in pipeline.
properties.annotations	Pipeline.Annotations[]	List of tags that can be used for describing the Pipeline.
properties.concurrency	integer (int32) minimum: 1	The max number of concurrent runs for the pipeline.
properties.description	string	The description of the pipeline.
properties.folder	PipelineFolder	The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
properties.parameters	<string, ParameterSpecification>	List of parameters for pipeline.
properties.policy	PipelinePolicy	Pipeline Policy.
properties.runDimensions		Dimensions emitted by Pipeline.
properties.variables	<string, VariableSpecification>	List of variables for pipeline.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PolybaseSettings

Object

PolyBase settings.

Name	Type	Description
rejectSampleValue		Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.
rejectType	PolybaseSettingsRejectType	Reject type.
rejectValue		Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.
useTypeDefault		Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).

PolybaseSettingsRejectType

Enumeration

Indicates whether the RejectValue property is specified as a literal value or a percentage.

Value	Description
value	value
percentage	percentage

PostgreSqlSource

Object

A copy activity source for PostgreSQL databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: PostgreSqlSource	Copy source type.

PostgreSqlV2Source

Object

A copy activity source for PostgreSQL databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: PostgreSqlV2Source	Copy source type.

PowerQuerySink

Object

Power query sink.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
rejectedDataLinkedService	LinkedServiceReference	Rejected data linked service reference.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.
script	string	sink script.

PowerQuerySinkMapping

Object

Map Power Query mashup query to sink dataset(s).

Name	Type	Description
dataflowSinks	PowerQuerySink[]	List of sinks mapped to Power Query mashup query.
queryName	string	Name of the query in Power Query mashup document.

PrestoSource

Object

A copy activity Presto server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: PrestoSource	Copy source type.

QuickBooksSource

Object

A copy activity QuickBooks server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: QuickBooksSource	Copy source type.

RedirectIncompatibleRowSettings

Object

Redirect incompatible row settings

Name	Type	Description
linkedServiceName		Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).
path		The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).

RedshiftUnloadSettings

Object

The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

Name	Type	Description
bucketName		The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).
s3LinkedServiceName	LinkedServiceReference	The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.

RelationalSource

Object

A copy activity source for various relational databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: RelationalSource	Copy source type.

ResponsysSource

Object

A copy activity Responsys source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ResponsysSource	Copy source type.

RestSink

Object

A copy activity Rest service Sink.

Name	Type	Description
additionalHeaders		The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpCompressionType		Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
requestInterval		The time to await before sending next request, in milliseconds
requestMethod		The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: RestSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

RestSource

Object

A copy activity Rest service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type).
additionalHeaders		The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
paginationRules		The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
requestBody		The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestInterval		The time to await before sending next page request.
requestMethod		The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: RestSource	Copy source type.

SalesforceMarketingCloudSource

Object

A copy activity Salesforce Marketing Cloud source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceMarketingCloudSource	Copy source type.

SalesforceServiceCloudSink

Object

A copy activity Salesforce Service Cloud sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
externalIdFieldName		The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignoreNullValues		The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceServiceCloudSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	SalesforceSinkWriteBehavior	The write behavior for the operation. Default is Insert.

SalesforceServiceCloudSource

Object

A copy activity Salesforce Service Cloud source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
readBehavior		The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceServiceCloudSource	Copy source type.

SalesforceServiceCloudV2Sink

Object

A copy activity Salesforce Service Cloud V2 sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
externalIdFieldName		The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignoreNullValues		The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceServiceCloudV2Sink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	SalesforceV2SinkWriteBehavior	The write behavior for the operation. Default is Insert.

SalesforceServiceCloudV2Source

Object

A copy activity Salesforce Service Cloud V2 source.

Name	Type	Description
SOQLQuery		Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string).
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
includeDeletedObjects		This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceServiceCloudV2Source	Copy source type.

SalesforceSink

Object

A copy activity Salesforce sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
externalIdFieldName		The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignoreNullValues		The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	SalesforceSinkWriteBehavior	The write behavior for the operation. Default is Insert.

SalesforceSinkWriteBehavior

Enumeration

The write behavior for the operation. Default is Insert.

Value	Description
Insert	Insert
Upsert	Upsert

SalesforceSource

Object

A copy activity Salesforce source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
readBehavior		The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceSource	Copy source type.

SalesforceV2Sink

Object

A copy activity Salesforce V2 sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
externalIdFieldName		The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignoreNullValues		The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceV2Sink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	SalesforceV2SinkWriteBehavior	The write behavior for the operation. Default is Insert.

SalesforceV2SinkWriteBehavior

Enumeration

The write behavior for the operation. Default is Insert.

Value	Description
Insert	Insert
Upsert	Upsert

SalesforceV2Source

Object

A copy activity Salesforce V2 source.

Name	Type	Description
SOQLQuery		Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string).
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
includeDeletedObjects		This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
pageSize		Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer).
partitionOption		Partition option for the SalesforceV2 connector in copy activity, AutoDetect or None. Type: string (or Expression with resultType string).
query		You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SalesforceV2Source	Copy source type.

SapBwSource

Object

A copy activity source for SapBW server via MDX.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		MDX query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapBwSource	Copy source type.

SapCloudForCustomerSink

Object

A copy activity SAP Cloud for Customer sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapCloudForCustomerSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior	SapCloudForCustomerSinkWriteBehavior	The write behavior for the operation. Default is 'Insert'.

SapCloudForCustomerSinkWriteBehavior

Enumeration

The write behavior for the operation. Default is 'Insert'.

Value	Description
Insert	Insert
Update	Update

SapCloudForCustomerSource

Object

A copy activity source for SAP Cloud for Customer source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		SAP Cloud for Customer OData query. For example, "$top=1". Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapCloudForCustomerSource	Copy source type.

SapEccSource

Object

A copy activity source for SAP ECC source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		SAP ECC OData query. For example, "$top=1". Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapEccSource	Copy source type.

SapHanaPartitionSettings

Object

The settings that will be leveraged for SAP HANA source partitioning.

Name	Type	Description
partitionColumnName		The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

SapHanaSource

Object

A copy activity source for SAP HANA source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
packetSize		The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "SapHanaDynamicRange".
partitionSettings	SapHanaPartitionSettings	The settings that will be leveraged for SAP HANA source partitioning.
query		SAP HANA Sql query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapHanaSource	Copy source type.

SapOdpSource

Object

A copy activity source for SAP ODP source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
extractionMode		The extraction mode. Allowed value include: Full, Delta and Recovery. The default value is Full. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
projection		Specifies the columns to be selected from source data. Type: array of objects(projection) (or Expression with resultType array of objects).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
selection		Specifies the selection conditions from source data. Type: array of objects(selection) (or Expression with resultType array of objects).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
subscriberProcess		The subscriber process to manage the delta process. Type: string (or Expression with resultType string).
type	string: SapOdpSource	Copy source type.

SapOpenHubSource

Object

A copy activity source for SAP Business Warehouse Open Hub Destination source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
baseRequestId		The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).
customRfcReadTableFunctionModule		Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
excludeLastRequest		Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sapDataColumnDelimiter		The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapOpenHubSource	Copy source type.

SapTablePartitionSettings

Object

The settings that will be leveraged for SAP table source partitioning.

Name	Type	Description
maxPartitionsNumber		The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string).
partitionColumnName		The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionUpperBound		The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

SapTableSource

Object

A copy activity source for SAP Table source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
batchSize		Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
customRfcReadTableFunctionModule		Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
partitionSettings	SapTablePartitionSettings	The settings that will be leveraged for SAP table source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
rfcTableFields		The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
rfcTableOptions		The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
rowCount		The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
rowSkips		The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
sapDataColumnDelimiter		The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SapTableSource	Copy source type.

ScriptActivity

Object

Script activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Script	Type of activity.
typeProperties.logSettings	ScriptActivityTypePropertiesLogSettings	Log settings of script activity.
typeProperties.returnMultistatementResult		Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean).
typeProperties.scriptBlockExecutionTimeout		ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
typeProperties.scripts	ScriptActivityScriptBlock[]	Array of script blocks. Type: array.
typeProperties.treatDecimalAsString		Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean).
userProperties	UserProperty[]	Activity user properties.

ScriptActivityLogDestination

Enumeration

The destination of logs. Type: string.

Value	Description
ActivityOutput	ActivityOutput
ExternalStore	ExternalStore

ScriptActivityParameter

Object

Parameters of a script block.

Name	Type	Description
direction	ScriptActivityParameterDirection	The direction of the parameter.
name		The name of the parameter. Type: string (or Expression with resultType string).
size	integer (int32)	The size of the output direction parameter.
type	ScriptActivityParameterType	The type of the parameter.
value		The value of the parameter. Type: string (or Expression with resultType string).

ScriptActivityParameterDirection

Enumeration

The direction of the parameter.

Value	Description
Input	Input
Output	Output
InputOutput	InputOutput

ScriptActivityParameterType

Enumeration

The type of the parameter.

Value	Description
Boolean	Boolean
DateTime	DateTime
DateTimeOffset	DateTimeOffset
Decimal	Decimal
Double	Double
Guid	Guid
Int16	Int16
Int32	Int32
Int64	Int64
Single	Single
String	String
Timespan	Timespan

ScriptActivityScriptBlock

Object

Script block of scripts.

Name	Type	Description
parameters	ScriptActivityParameter[]	Array of script parameters. Type: array.
text		The query text. Type: string (or Expression with resultType string).
type		The type of the query. Please refer to the ScriptType for valid options. Type: string (or Expression with resultType string).

ScriptActivityTypePropertiesLogSettings

Object

Log settings of script activity.

Name	Type	Description
logDestination	ScriptActivityLogDestination	The destination of logs. Type: string.
logLocationSettings	LogLocationSettings	Log location settings customer needs to provide when enabling log.

SecureInputOutputPolicy

Object

Execution policy for an activity that supports secure input and output.

Name	Type	Description
secureInput	boolean	When set to true, Input from activity is considered as secure and will not be logged to monitoring.
secureOutput	boolean	When set to true, Output from activity is considered as secure and will not be logged to monitoring.

SecureString

Object

Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

Name	Type	Description
type	string: SecureString	Type of the secret.
value	string	Value of secure string.

ServiceNowSource

Object

A copy activity ServiceNow server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ServiceNowSource	Copy source type.

ServiceNowV2Source

Object

A copy activity ServiceNowV2 server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
expression	ExpressionV2	Expression to filter data from source.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
pageSize		Page size of the result. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ServiceNowV2Source	Copy source type.

SetVariableActivity

Object

Set value for a Variable.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	SecureInputOutputPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: SetVariable	Type of activity.
typeProperties.setSystemVariable	boolean	If set to true, it sets the pipeline run return value.
typeProperties.value		Value to be set. Could be a static value or Expression.
typeProperties.variableName	string	Name of the variable whose value needs to be set.
userProperties	UserProperty[]	Activity user properties.

SftpReadSettings

Object

Sftp read settings.

Name	Type	Description
deleteFilesAfterCompletion		Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableChunking		If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery		Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath		Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
modifiedDatetimeEnd		The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart		The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath		Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive		If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type	string: SftpReadSettings	The read setting type.
wildcardFileName		Sftp wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath		Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

SftpWriteSettings

Object

Sftp write settings.

Name	Type	Description
copyBehavior		The type of copy behavior for copy sink.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
metadata	MetadataItem[]	Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).
operationTimeout		Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).
type	string: SftpWriteSettings	The write setting type.
useTempFileRename		Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).

SharePointOnlineListSource

Object

A copy activity source for sharePoint online list source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
httpRequestTimeout		The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		The OData query to filter the data in SharePoint Online list. For example, "$top=1". Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SharePointOnlineListSource	Copy source type.

ShopifySource

Object

A copy activity Shopify Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ShopifySource	Copy source type.

SkipErrorFile

Object

Skip error file.

Name	Type	Description
dataInconsistency		Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean).
fileMissing		Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean).

SnowflakeExportCopyCommand

Object

Snowflake export command settings.

Name	Type	Description
additionalCopyOptions		Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" }
additionalFormatOptions		Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "OVERWRITE": "TRUE", "MAX_FILE_SIZE": "'FALSE'" }
storageIntegration		The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string).
type	string: SnowflakeExportCopyCommand	The export setting type.

SnowflakeImportCopyCommand

Object

Snowflake import command settings.

Name	Type	Description
additionalCopyOptions		Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" }
additionalFormatOptions		Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "FORCE": "TRUE", "LOAD_UNCERTAIN_FILES": "'FALSE'" }
storageIntegration		The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string).
type	string: SnowflakeImportCopyCommand	The import setting type.

SnowflakeSink

Object

A copy activity snowflake sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
importSettings	SnowflakeImportCopyCommand	Snowflake import settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SnowflakeSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

SnowflakeSource

Object

A copy activity snowflake source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
exportSettings	SnowflakeExportCopyCommand	Snowflake export settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Snowflake Sql query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SnowflakeSource	Copy source type.

SnowflakeV2Sink

Object

A copy activity snowflake sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
importSettings	SnowflakeImportCopyCommand	Snowflake import settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SnowflakeV2Sink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

SnowflakeV2Source

Object

A copy activity snowflake source.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
exportSettings	SnowflakeExportCopyCommand	Snowflake export settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Snowflake Sql query. Type: string (or Expression with resultType string).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SnowflakeV2Source	Copy source type.

SparkConfigurationParametrizationReference

Object

Spark configuration reference.

Name	Type	Description
referenceName		Reference spark configuration name. Type: string (or Expression with resultType string).
type	SparkConfigurationReferenceType	Spark configuration reference type.

SparkConfigurationReferenceType

Enumeration

Spark configuration reference type.

Value	Description
SparkConfigurationReference	SparkConfigurationReference

SparkJobReferenceType

Enumeration

Synapse spark job reference type.

Value	Description
SparkJobDefinitionReference	SparkJobDefinitionReference

SparkSource

Object

A copy activity Spark Server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SparkSource	Copy source type.

SqlDWSink

Object

A copy activity SQL Data Warehouse sink.

Name	Type	Description
allowCopyCommand		Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
allowPolyBase		Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
copyCommandSettings	DWCopyCommandSettings	Specifies Copy Command related settings when allowCopyCommand is true.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
polyBaseSettings	PolybaseSettings	Specifies PolyBase-related settings when allowPolyBase is true.
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlWriterUseTableLock		Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: SqlDWSink	Copy sink type.
upsertSettings	SqlDWUpsertSettings	SQL DW upsert settings.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)

SqlDWSource

Object

A copy activity SQL Data Warehouse source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL Data Warehouse reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.
type	string: SqlDWSource	Copy source type.

SqlDWUpsertSettings

Object

Sql DW upsert option settings

Name	Type	Description
interimSchemaName		Schema name for interim table. Type: string (or Expression with resultType string).
keys		Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings).

SqlMISink

Object

A copy activity Azure SQL Managed Instance sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlWriterStoredProcedureName		SQL writer stored procedure name. Type: string (or Expression with resultType string).
sqlWriterTableType		SQL writer table type. Type: string (or Expression with resultType string).
sqlWriterUseTableLock		Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
storedProcedureParameters		SQL stored procedure parameters.
storedProcedureTableTypeParameterName		The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: SqlMISink	Copy sink type.
upsertSettings	SqlUpsertSettings	SQL upsert settings.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)

SqlMISource

Object

A copy activity Azure SQL Managed Instance source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
produceAdditionalTypes		Which additional types to produce.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	string: SqlMISource	Copy source type.

SqlPartitionSettings

Object

The settings that will be leveraged for Sql source partitioning.

Name	Type	Description
partitionColumnName		The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).
partitionUpperBound		The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

SqlServerSink

Object

A copy activity SQL server sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlWriterStoredProcedureName		SQL writer stored procedure name. Type: string (or Expression with resultType string).
sqlWriterTableType		SQL writer table type. Type: string (or Expression with resultType string).
sqlWriterUseTableLock		Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
storedProcedureParameters		SQL stored procedure parameters.
storedProcedureTableTypeParameterName		The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: SqlServerSink	Copy sink type.
upsertSettings	SqlUpsertSettings	SQL upsert settings.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Write behavior when copying data into sql server. Type: string (or Expression with resultType string).

SqlServerSource

Object

A copy activity SQL server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
produceAdditionalTypes		Which additional types to produce.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	string: SqlServerSource	Copy source type.

SqlServerStoredProcedureActivity

Object

SQL stored procedure activity type.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: SqlServerStoredProcedure	Type of activity.
typeProperties.storedProcedureName		Stored procedure name. Type: string (or Expression with resultType string).
typeProperties.storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
userProperties	UserProperty[]	Activity user properties.

SqlSink

Object

A copy activity SQL sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlWriterStoredProcedureName		SQL writer stored procedure name. Type: string (or Expression with resultType string).
sqlWriterTableType		SQL writer table type. Type: string (or Expression with resultType string).
sqlWriterUseTableLock		Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
storedProcedureParameters		SQL stored procedure parameters.
storedProcedureTableTypeParameterName		The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: SqlSink	Copy sink type.
upsertSettings	SqlUpsertSettings	SQL upsert settings.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Write behavior when copying data into sql. Type: string (or Expression with resultType string).

SqlSource

Object

A copy activity SQL source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		SQL reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	string: SqlSource	Copy source type.

SqlUpsertSettings

Object

Sql upsert option settings

Name	Type	Description
interimSchemaName		Schema name for interim table. Type: string (or Expression with resultType string).
keys		Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings).
useTempDB		Specifies whether to use temp db for upsert interim table. Type: boolean (or Expression with resultType boolean).

SquareSource

Object

A copy activity Square Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SquareSource	Copy source type.

SSISAccessCredential

Object

SSIS access credential.

Name	Type	Description
domain		Domain for windows authentication. Type: string (or Expression with resultType string).
password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for windows authentication.
userName		UseName for windows authentication. Type: string (or Expression with resultType string).

SSISChildPackage

Object

SSIS embedded child package.

Name	Type	Description
packageContent		Content for embedded child package. Type: string (or Expression with resultType string).
packageLastModifiedDate	string	Last modified date for embedded child package.
packageName	string	Name for embedded child package.
packagePath		Path for embedded child package. Type: string (or Expression with resultType string).

SSISExecutionCredential

Object

SSIS package execution credential.

Name	Type	Description
domain		Domain for windows authentication. Type: string (or Expression with resultType string).
password	SecureString	Password for windows authentication.
userName		UseName for windows authentication. Type: string (or Expression with resultType string).

SSISExecutionParameter

Object

SSIS execution parameter.

Name	Type	Description
value		SSIS package execution parameter value. Type: string (or Expression with resultType string).

SSISLogLocation

Object

SSIS package execution log location

Name	Type	Description
logPath		The SSIS package execution log path. Type: string (or Expression with resultType string).
type	SsisLogLocationType	The type of SSIS log location.
typeProperties.accessCredential	SSISAccessCredential	The package execution log access credential.
typeProperties.logRefreshInterval		Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

SsisLogLocationType

Enumeration

The type of SSIS log location.

Value	Description
File	File

SSISPackageLocation

Object

SSIS package location.

Name	Type	Description
packagePath		The SSIS package path. Type: string (or Expression with resultType string).
type	SsisPackageLocationType	The type of SSIS package location.
typeProperties.accessCredential	SSISAccessCredential	The package access credential.
typeProperties.childPackages	SSISChildPackage[]	The embedded child package list.
typeProperties.configurationAccessCredential	SSISAccessCredential	The configuration file access credential.
typeProperties.configurationPath		The configuration file of the package execution. Type: string (or Expression with resultType string).
typeProperties.packageContent		The embedded package content. Type: string (or Expression with resultType string).
typeProperties.packageLastModifiedDate	string	The embedded package last modified date.
typeProperties.packageName	string	The package name.
typeProperties.packagePassword	SecretBase: AzureKeyVaultSecretReference SecureString	Password of the package.

SsisPackageLocationType

Enumeration

The type of SSIS package location.

Value	Description
SSISDB	SSISDB
File	File
InlinePackage	InlinePackage
PackageStore	PackageStore

SSISPropertyOverride

Object

SSIS property override.

Name	Type	Description
isSensitive	boolean	Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true
value		SSIS package property override value. Type: string (or Expression with resultType string).

StagingSettings

Object

Staging settings.

Name	Type	Description
enableCompression		Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
linkedServiceName	LinkedServiceReference	Staging linked service reference.
path		The path to storage for storing the interim data. Type: string (or Expression with resultType string).

SwitchActivity

Object

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Switch	Type of activity.
typeProperties.cases	SwitchCase[]	List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.
typeProperties.defaultActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.
typeProperties.on	Expression	An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.
userProperties	UserProperty[]	Activity user properties.

SwitchCase

Object

Switch cases with have a value and corresponding activities.

Name	Type	Description
activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute for satisfied case condition.
value	string	Expected value that satisfies the expression result of the 'on' property.

SybaseSource

Object

A copy activity source for Sybase databases.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		Database query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: SybaseSource	Copy source type.

SynapseNotebookActivity

Object

Execute Synapse notebook activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: SynapseNotebook	Type of activity.
typeProperties.conf		Spark configuration properties, which will override the 'conf' of the notebook you provide.
typeProperties.configurationType	ConfigurationType	The type of the spark config.
typeProperties.driverSize		Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string).
typeProperties.executorSize		Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string).
typeProperties.notebook	SynapseNotebookReference	Synapse notebook reference.
typeProperties.numExecutors		Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide. Type: integer (or Expression with resultType integer).
typeProperties.parameters	<string, NotebookParameter>	Notebook parameters.
typeProperties.sparkConfig		Spark configuration property.
typeProperties.sparkPool	BigDataPoolParametrizationReference	The name of the big data pool which will be used to execute the notebook.
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	The spark configuration of the spark job.
userProperties	UserProperty[]	Activity user properties.

SynapseNotebookReference

Object

Synapse notebook reference type.

Name	Type	Description
referenceName		Reference notebook name. Type: string (or Expression with resultType string).
type	NotebookReferenceType	Synapse notebook reference type.

SynapseSparkJobDefinitionActivity

Object

Execute spark job activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: SparkJob	Type of activity.
typeProperties.args	SynapseSparkJobActivityTypeProperties.Args[]	User specified arguments to SynapseSparkJobDefinitionActivity.
typeProperties.className		The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string).
typeProperties.conf		Spark configuration properties, which will override the 'conf' of the spark job definition you provide.
typeProperties.configurationType	ConfigurationType	The type of the spark config.
typeProperties.driverSize		Number of core and memory to be used for driver allocated in the specified Spark pool for the job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
typeProperties.executorSize		Number of core and memory to be used for executors allocated in the specified Spark pool for the job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string).
typeProperties.file		The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string).
typeProperties.files	SynapseSparkJobActivityTypeProperties.Files[]	(Deprecated. Please use pythonCodeReference and filesV2) Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.
typeProperties.filesV2	SynapseSparkJobActivityTypeProperties.FilesV2[]	Additional files used for reference in the main definition file, which will override the 'jars' and 'files' of the spark job definition you provide.
typeProperties.numExecutors		Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide. Type: integer (or Expression with resultType integer).
typeProperties.pythonCodeReference	SynapseSparkJobActivityTypeProperties.PythonCodeReference[]	Additional python code files used for reference in the main definition file, which will override the 'pyFiles' of the spark job definition you provide.
typeProperties.scanFolder		Scanning subfolders from the root folder of the main definition file, these files will be added as reference files. The folders named 'jars', 'pyFiles', 'files' or 'archives' will be scanned, and the folders name are case sensitive. Type: boolean (or Expression with resultType boolean).
typeProperties.sparkConfig		Spark configuration property.
typeProperties.sparkJob	SynapseSparkJobReference	Synapse spark job reference.
typeProperties.targetBigDataPool	BigDataPoolParametrizationReference	The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide.
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	The spark configuration of the spark job.
userProperties	UserProperty[]	Activity user properties.

SynapseSparkJobReference

Object

Synapse spark job reference type.

Name	Type	Description
referenceName		Reference spark job name. Expression with resultType string.
type	SparkJobReferenceType	Synapse spark job reference type.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TabularSource

Object

Copy activity sources of tabular type.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: TabularSource	Copy source type.

TarGZipReadSettings

Object

The TarGZip compression read settings.

Name	Type	Description
preserveCompressionFileNameAsFolder		Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).
type	string: TarGZipReadSettings	The Compression setting type.

TarReadSettings

Object

The Tar compression read settings.

Name	Type	Description
preserveCompressionFileNameAsFolder		Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).
type	string: TarReadSettings	The Compression setting type.

TeradataImportCommand

Object

Teradata import command settings.

Name	Type	Description
additionalFormatOptions		Additional format options for Teradata Copy Command. The format options only applies to direct copy from CSV source. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "timeFormat": "HHhMImSSs" }
type	string: TeradataImportCommand	The import setting type.

TeradataPartitionSettings

Object

The settings that will be leveraged for teradata source partitioning.

Name	Type	Description
partitionColumnName		The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string).
partitionLowerBound		The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).
partitionUpperBound		The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).

TeradataSink

Object

A copy activity Teradata sink.

Name	Type	Description
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
importSettings	TeradataImportCommand	Teradata import settings.
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: TeradataSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).

TeradataSource

Object

A copy activity Teradata source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for teradata read in parallel. Possible values include: "None", "Hash", "DynamicRange".
partitionSettings	TeradataPartitionSettings	The settings that will be leveraged for teradata source partitioning.
query		Teradata query. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: TeradataSource	Copy source type.

Type

Enumeration

Linked service reference type.

Value	Description
LinkedServiceReference	LinkedServiceReference

UntilActivity

Object

This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Until	Type of activity.
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	List of activities to execute.
typeProperties.expression	Expression	An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true
typeProperties.timeout		Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
userProperties	UserProperty[]	Activity user properties.

UserProperty

Object

User property.

Name	Type	Description
name	string	User property name.
value		User property value. Type: string (or Expression with resultType string).

ValidationActivity

Object

This activity verifies that an external resource exists.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Validation	Type of activity.
typeProperties.childItems		Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).
typeProperties.dataset	DatasetReference	Validation activity dataset reference.
typeProperties.minimumSize		Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).
typeProperties.sleep		A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).
typeProperties.timeout		Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
userProperties	UserProperty[]	Activity user properties.

VariableSpecification

Object

Definition of a single variable for a Pipeline.

Name	Type	Description
defaultValue		Default value of variable.
type	VariableType	Variable type.

VariableType

Enumeration

Variable type.

Value	Description
String	String
Bool	Bool
Array	Array

VerticaSource

Object

A copy activity Vertica source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: VerticaSource	Copy source type.

WaitActivity

Object

This activity suspends pipeline execution for the specified interval.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: Wait	Type of activity.
typeProperties.waitTimeInSeconds		Duration in seconds. Type: integer (or Expression with resultType integer).
userProperties	UserProperty[]	Activity user properties.

WarehouseSink

Object

A copy activity Microsoft Fabric Warehouse sink.

Name	Type	Description
allowCopyCommand		Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
copyCommandSettings	DWCopyCommandSettings	Specifies Copy Command related settings when allowCopyCommand is true.
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
preCopyScript		SQL pre-copy script. Type: string (or Expression with resultType string).
sinkRetryCount		Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait		Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
tableOption		The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	string: WarehouseSink	Copy sink type.
writeBatchSize		Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout		Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
writeBehavior		Write behavior when copying data into azure Microsoft Fabric Data Warehouse. Type: DWWriteBehaviorEnum (or Expression with resultType DWWriteBehaviorEnum)

WarehouseSource

Object

A copy activity Microsoft Fabric Warehouse source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
isolationLevel		Specifies the transaction locking behavior for the Microsoft Fabric Warehouse source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
partitionOption		The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".
partitionSettings	SqlPartitionSettings	The settings that will be leveraged for Sql source partitioning.
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sqlReaderQuery		Microsoft Fabric Warehouse reader query. Type: string (or Expression with resultType string).
sqlReaderStoredProcedureName		Name of the stored procedure for a Microsoft Fabric Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
storedProcedureParameters		Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.
type	string: WarehouseSource	Copy source type.

WebActivity

Object

Web activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
linkedServiceName	LinkedServiceReference	Linked service reference.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	ActivityPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: WebActivity	Type of activity.
typeProperties.authentication	WebActivityAuthentication	Authentication method used for calling the endpoint.
typeProperties.body		Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
typeProperties.connectVia	IntegrationRuntimeReference	The integration runtime reference.
typeProperties.datasets	DatasetReference[]	List of datasets passed to web endpoint.
typeProperties.disableCertValidation	boolean	When set to true, Certificate validation will be disabled.
typeProperties.headers		Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
typeProperties.httpRequestTimeout		Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes
typeProperties.linkedServices	LinkedServiceReference[]	List of linked services passed to web endpoint.
typeProperties.method	WebActivityMethod	Rest API method for target endpoint.
typeProperties.turnOffAsync	boolean	Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.
typeProperties.url		Web activity target endpoint and path. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

WebActivityAuthentication

Object

Web activity authentication properties.

Name	Type	Description
credential	CredentialReference	The credential reference containing authentication information.
password	SecretBase: AzureKeyVaultSecretReference SecureString	Password for the PFX file or basic authentication / Secret when used for ServicePrincipal
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	Base64-encoded contents of a PFX file or Certificate when used for ServicePrincipal
resource		Resource for which Azure Auth token will be requested when using MSI Authentication. Type: string (or Expression with resultType string).
type	string	Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal)
userTenant		TenantId for which Azure Auth token will be requested when using ServicePrincipal Authentication. Type: string (or Expression with resultType string).
username		Web activity authentication user name for basic authentication or ClientID when used for ServicePrincipal. Type: string (or Expression with resultType string).

WebActivityMethod

Enumeration

The list of HTTP methods supported by a WebActivity.

Value	Description
GET	GET
POST	POST
PUT	PUT
DELETE	DELETE

WebHookActivity

Object

WebHook activity.

Name	Type	Description
dependsOn	ActivityDependency[]	Activity depends on condition.
description	string	Activity description.
name	string	Activity name.
onInactiveMarkAs	ActivityOnInactiveMarkAs	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	SecureInputOutputPolicy	Activity policy.
state	ActivityState	Activity state. This is an optional property and if not provided, the state will be Active by default.
type	string: WebHook	Type of activity.
typeProperties.authentication	WebActivityAuthentication	Authentication method used for calling the endpoint.
typeProperties.body		Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
typeProperties.headers		Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
typeProperties.method	WebHookActivityMethod	Rest API method for target endpoint.
typeProperties.reportStatusOnCallBack		When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).
typeProperties.timeout	string	The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
typeProperties.url		WebHook activity target endpoint and path. Type: string (or Expression with resultType string).
userProperties	UserProperty[]	Activity user properties.

WebHookActivityMethod

Enumeration

The list of HTTP methods supported by a WebHook activity.

Value	Description
POST	POST

WebSource

Object

A copy activity source for web page table.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: WebSource	Copy source type.

XeroSource

Object

A copy activity Xero Service source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: XeroSource	Copy source type.

XmlReadSettings

Object

Xml read settings.

Name	Type	Description
compressionProperties	CompressionReadSettings: TarGZipReadSettings TarReadSettings ZipDeflateReadSettings	Compression settings.
detectDataType		Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).
namespacePrefixes		Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: "{"http://www.example.com/xml":"prefix"}" Type: object (or Expression with resultType object).
namespaces		Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).
type	string: XmlReadSettings	The read setting type.
validationMode		Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string).

XmlSource

Object

A copy activity Xml source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
formatSettings	XmlReadSettings	Xml format settings.
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
storeSettings	StoreReadSettings: AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings LakeHouseReadSettings OracleCloudStorageReadSettings SftpReadSettings	Xml store settings.
type	string: XmlSource	Copy source type.

ZipDeflateReadSettings

Object

The ZipDeflate compression read settings.

Name	Type	Description
preserveZipFileNameAsFolder		Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).
type	string: ZipDeflateReadSettings	The Compression setting type.

ZohoSource

Object

A copy activity Zoho server source.

Name	Type	Description
additionalColumns		Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection		If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections		The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
query		A query to retrieve data from source. Type: string (or Expression with resultType string).
queryTimeout		Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
sourceRetryCount		Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait		Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
type	string: ZohoSource	Copy source type.

Share via

Pipelines - Get

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

Pipelines_Get

Sample request

Sample response

Definitions

ActivityDependency

ActivityOnInactiveMarkAs

ActivityPolicy

ActivityState

AmazonMWSSource

AmazonRdsForOraclePartitionSettings

AmazonRdsForOracleSource

AmazonRdsForSqlServerSource

AmazonRedshiftSource

AmazonS3CompatibleReadSettings

AmazonS3ReadSettings

AppendVariableActivity

AvroSink

AvroSource

AvroWriteSettings

AzureBlobFSReadSettings

AzureBlobFSSink

AzureBlobFSSource

AzureBlobFSWriteSettings

AzureBlobStorageReadSettings

AzureBlobStorageWriteSettings

AzureDatabricksDeltaLakeExportCommand

AzureDatabricksDeltaLakeImportCommand

AzureDatabricksDeltaLakeSink

AzureDatabricksDeltaLakeSource

AzureDataExplorerCommandActivity

AzureDataExplorerSink

AzureDataExplorerSource

AzureDataLakeStoreReadSettings

AzureDataLakeStoreSink

AzureDataLakeStoreSource

AzureDataLakeStoreWriteSettings

AzureFileStorageReadSettings

AzureFileStorageWriteSettings

AzureFunctionActivity

AzureFunctionActivityMethod

AzureKeyVaultSecretReference

AzureMariaDBSource

AzureMLBatchExecutionActivity

AzureMLExecutePipelineActivity

AzureMLUpdateResourceActivity

AzureMLWebServiceFile

AzureMySqlSink

AzureMySqlSource

AzurePostgreSqlSink

AzurePostgreSqlSinkUpsertSettings

AzurePostgreSqlSource

AzurePostgreSqlWriteMethodEnum

AzureQueueSink

AzureSearchIndexSink

AzureSearchIndexWriteBehaviorType

AzureSqlSink

AzureSqlSource

AzureTableSink

AzureTableSource

BigDataPoolParametrizationReference

BigDataPoolReferenceType

BinaryReadSettings

BinarySink

BinarySource

BlobSink

BlobSource

CassandraSource

CassandraSourceReadConsistencyLevels

CloudError

CommonDataServiceForAppsSink

CommonDataServiceForAppsSource