Microsoft.DataFactory factories/pipelines
The factories/pipelines resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
Template format
To create a Microsoft.DataFactory/factories/pipelines resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2018-06-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
annotations: [
any
]
concurrency: int
description: 'string'
folder: {
name: 'string'
}
parameters: {}
policy: {
elapsedTimeMetric: {
duration: any()
}
}
runDimensions: {}
variables: {}
}
}
Activity objects
Set the type property to specify the type of object.
For AppendVariable, use:
For AzureDataExplorerCommand, use:
type: 'AzureDataExplorerCommand'
typeProperties: {
command: any()
commandTimeout: any()
}
For AzureFunctionActivity, use:
type: 'AzureFunctionActivity'
typeProperties: {
body: any()
functionName: any()
headers: any()
method: 'string'
}
For AzureMLBatchExecution, use:
type: 'AzureMLBatchExecution'
typeProperties: {
globalParameters: {}
webServiceInputs: {}
webServiceOutputs: {}
}
For AzureMLExecutePipeline, use:
type: 'AzureMLExecutePipeline'
typeProperties: {
continueOnStepFailure: any()
dataPathAssignments: any()
experimentName: any()
mlParentRunId: any()
mlPipelineEndpointId: any()
mlPipelineId: any()
mlPipelineParameters: any()
version: any()
}
For AzureMLUpdateResource, use:
type: 'AzureMLUpdateResource'
typeProperties: {
trainedModelFilePath: any()
trainedModelLinkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
trainedModelName: any()
}
For Copy, use:
type: 'Copy'
inputs: [
{
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
]
outputs: [
{
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
]
typeProperties: {
dataIntegrationUnits: any()
enableSkipIncompatibleRow: any()
enableStaging: any()
logSettings: {
copyActivityLogSettings: {
enableReliableLogging: any()
logLevel: any()
}
enableCopyActivityLog: any()
logLocationSettings: {
linkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
path: any()
}
}
logStorageSettings: {
enableReliableLogging: any()
linkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
logLevel: any()
path: any()
}
parallelCopies: any()
preserve: [
any
]
preserveRules: [
any
]
redirectIncompatibleRowSettings: {
linkedServiceName: any()
path: any()
}
sink: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
sinkRetryCount: any()
sinkRetryWait: any()
writeBatchSize: any()
writeBatchTimeout: any()
type: 'string'
// For remaining properties, see CopySink objects
}
skipErrorFile: {
dataInconsistency: any()
fileMissing: any()
}
source: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
sourceRetryCount: any()
sourceRetryWait: any()
type: 'string'
// For remaining properties, see CopySource objects
}
stagingSettings: {
enableCompression: any()
linkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
path: any()
}
translator: any()
validateDataConsistency: any()
}
For Custom, use:
type: 'Custom'
typeProperties: {
autoUserSpecification: any()
command: any()
extendedProperties: {}
folderPath: any()
referenceObjects: {
datasets: [
{
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
]
linkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
}
resourceLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
retentionTimeInDays: any()
}
For DatabricksNotebook, use:
type: 'DatabricksNotebook'
typeProperties: {
baseParameters: {}
libraries: [
{
}
]
notebookPath: any()
}
For DatabricksSparkJar, use:
type: 'DatabricksSparkJar'
typeProperties: {
libraries: [
{
}
]
mainClassName: any()
parameters: [
any
]
}
For DatabricksSparkPython, use:
type: 'DatabricksSparkPython'
typeProperties: {
libraries: [
{
}
]
parameters: [
any
]
pythonFile: any()
}
For DataLakeAnalyticsU-SQL, use:
type: 'DataLakeAnalyticsU-SQL'
typeProperties: {
compilationMode: any()
degreeOfParallelism: any()
parameters: {}
priority: any()
runtimeVersion: any()
scriptLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
scriptPath: any()
}
For Delete, use:
type: 'Delete'
typeProperties: {
dataset: {
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
enableLogging: any()
logStorageSettings: {
enableReliableLogging: any()
linkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
logLevel: any()
path: any()
}
maxConcurrentConnections: int
recursive: any()
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
}
For ExecuteDataFlow, use:
type: 'ExecuteDataFlow'
typeProperties: {
compute: {
computeType: any()
coreCount: any()
}
continueOnError: any()
dataFlow: {
datasetParameters: any()
parameters: {}
referenceName: 'string'
type: 'DataFlowReference'
}
integrationRuntime: {
parameters: {}
referenceName: 'string'
type: 'IntegrationRuntimeReference'
}
runConcurrently: any()
staging: {
folderPath: any()
linkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
}
traceLevel: any()
}
For ExecutePipeline, use:
type: 'ExecutePipeline'
policy: {
secureInput: bool
}
typeProperties: {
parameters: {}
pipeline: {
name: 'string'
referenceName: 'string'
type: 'PipelineReference'
}
waitOnCompletion: bool
}
For ExecuteSSISPackage, use:
type: 'ExecuteSSISPackage'
typeProperties: {
connectVia: {
parameters: {}
referenceName: 'string'
type: 'IntegrationRuntimeReference'
}
environmentPath: any()
executionCredential: {
domain: any()
password: {
type: 'string'
value: 'string'
}
userName: any()
}
loggingLevel: any()
logLocation: {
logPath: any()
type: 'File'
typeProperties: {
accessCredential: {
domain: any()
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any()
}
logRefreshInterval: any()
}
}
packageConnectionManagers: {}
packageLocation: {
packagePath: any()
type: 'string'
typeProperties: {
accessCredential: {
domain: any()
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any()
}
childPackages: [
{
packageContent: any()
packageLastModifiedDate: 'string'
packageName: 'string'
packagePath: any()
}
]
configurationAccessCredential: {
domain: any()
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any()
}
configurationPath: any()
packageContent: any()
packageLastModifiedDate: 'string'
packageName: 'string'
packagePassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
packageParameters: {}
projectConnectionManagers: {}
projectParameters: {}
propertyOverrides: {}
runtime: any()
}
For ExecuteWranglingDataflow, use:
type: 'ExecuteWranglingDataflow'
policy: {
retry: any()
retryIntervalInSeconds: int
secureInput: bool
secureOutput: bool
timeout: any()
}
typeProperties: {
compute: {
computeType: any()
coreCount: any()
}
continueOnError: any()
dataFlow: {
datasetParameters: any()
parameters: {}
referenceName: 'string'
type: 'DataFlowReference'
}
integrationRuntime: {
parameters: {}
referenceName: 'string'
type: 'IntegrationRuntimeReference'
}
queries: [
{
dataflowSinks: [
{
dataset: {
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
description: 'string'
flowlet: {
datasetParameters: any()
parameters: {}
referenceName: 'string'
type: 'DataFlowReference'
}
linkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
name: 'string'
schemaLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
script: 'string'
}
]
queryName: 'string'
}
]
runConcurrently: any()
sinks: {}
staging: {
folderPath: any()
linkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
}
traceLevel: any()
}
For Fail, use:
For Filter, use:
type: 'Filter'
typeProperties: {
condition: {
type: 'Expression'
value: 'string'
}
items: {
type: 'Expression'
value: 'string'
}
}
For ForEach, use:
type: 'ForEach'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
batchCount: int
isSequential: bool
items: {
type: 'Expression'
value: 'string'
}
}
For GetMetadata, use:
type: 'GetMetadata'
typeProperties: {
dataset: {
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
fieldList: [
any
]
formatSettings: {
type: 'string'
// For remaining properties, see FormatReadSettings objects
}
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
}
For HDInsightHive, use:
type: 'HDInsightHive'
typeProperties: {
arguments: [
any
]
defines: {}
getDebugInfo: 'string'
queryTimeout: int
scriptLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
scriptPath: any()
storageLinkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
variables: [
any
]
}
For HDInsightMapReduce, use:
type: 'HDInsightMapReduce'
typeProperties: {
arguments: [
any
]
className: any()
defines: {}
getDebugInfo: 'string'
jarFilePath: any()
jarLibs: [
any
]
jarLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
storageLinkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
}
For HDInsightPig, use:
type: 'HDInsightPig'
typeProperties: {
arguments: any()
defines: {}
getDebugInfo: 'string'
scriptLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
scriptPath: any()
storageLinkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
}
For HDInsightSpark, use:
type: 'HDInsightSpark'
typeProperties: {
arguments: [
any
]
className: 'string'
entryFilePath: any()
getDebugInfo: 'string'
proxyUser: any()
rootPath: any()
sparkConfig: {}
sparkJobLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
}
For HDInsightStreaming, use:
type: 'HDInsightStreaming'
typeProperties: {
arguments: [
any
]
combiner: any()
commandEnvironment: [
any
]
defines: {}
fileLinkedService: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
filePaths: [
any
]
getDebugInfo: 'string'
input: any()
mapper: any()
output: any()
reducer: any()
storageLinkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
}
For IfCondition, use:
type: 'IfCondition'
typeProperties: {
expression: {
type: 'Expression'
value: 'string'
}
ifFalseActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
ifTrueActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
}
For Lookup, use:
type: 'Lookup'
typeProperties: {
dataset: {
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
firstRowOnly: any()
source: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
sourceRetryCount: any()
sourceRetryWait: any()
type: 'string'
// For remaining properties, see CopySource objects
}
}
For Script, use:
type: 'Script'
typeProperties: {
logSettings: {
logDestination: 'string'
logLocationSettings: {
linkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
path: any()
}
}
scripts: [
{
parameters: [
{
direction: 'string'
name: any()
size: int
type: 'string'
value: any()
}
]
text: any()
type: 'string'
}
]
}
For SetVariable, use:
For SqlServerStoredProcedure, use:
type: 'SqlServerStoredProcedure'
typeProperties: {
storedProcedureName: any()
storedProcedureParameters: any()
}
For Switch, use:
type: 'Switch'
typeProperties: {
cases: [
{
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
value: 'string'
}
]
defaultActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
on: {
type: 'Expression'
value: 'string'
}
}
For Until, use:
type: 'Until'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
userProperties: [
{
name: 'string'
value: any()
}
]
type: 'string'
// For remaining properties, see Activity objects
}
]
expression: {
type: 'Expression'
value: 'string'
}
timeout: any()
}
For Validation, use:
type: 'Validation'
typeProperties: {
childItems: any()
dataset: {
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
minimumSize: any()
sleep: any()
timeout: any()
}
For Wait, use:
For WebActivity, use:
type: 'WebActivity'
typeProperties: {
authentication: {
credential: {
referenceName: 'string'
type: 'CredentialReference'
}
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
pfx: {
type: 'string'
// For remaining properties, see SecretBase objects
}
resource: any()
type: 'string'
username: any()
userTenant: any()
}
body: any()
connectVia: {
parameters: {}
referenceName: 'string'
type: 'IntegrationRuntimeReference'
}
datasets: [
{
parameters: {}
referenceName: 'string'
type: 'DatasetReference'
}
]
disableCertValidation: bool
headers: any()
linkedServices: [
{
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
]
method: 'string'
url: any()
}
For WebHook, use:
type: 'WebHook'
typeProperties: {
authentication: {
credential: {
referenceName: 'string'
type: 'CredentialReference'
}
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
pfx: {
type: 'string'
// For remaining properties, see SecretBase objects
}
resource: any()
type: 'string'
username: any()
userTenant: any()
}
body: any()
headers: any()
method: 'POST'
reportStatusOnCallBack: any()
timeout: 'string'
url: any()
}
CopySink objects
Set the type property to specify the type of object.
For AvroSink, use:
type: 'AvroSink'
formatSettings: {
fileNamePrefix: any()
maxRowsPerFile: any()
recordName: 'string'
recordNamespace: 'string'
type: 'string'
}
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For AzureBlobFSSink, use:
For AzureDatabricksDeltaLakeSink, use:
type: 'AzureDatabricksDeltaLakeSink'
importSettings: {
dateFormat: any()
timestampFormat: any()
type: 'string'
}
preCopyScript: any()
For AzureDataExplorerSink, use:
type: 'AzureDataExplorerSink'
flushImmediately: any()
ingestionMappingAsJson: any()
ingestionMappingName: any()
For AzureDataLakeStoreSink, use:
For AzureMySqlSink, use:
For AzurePostgreSqlSink, use:
For AzureQueueSink, use:
For AzureSearchIndexSink, use:
For AzureSqlSink, use:
type: 'AzureSqlSink'
preCopyScript: any()
sqlWriterStoredProcedureName: any()
sqlWriterTableType: any()
sqlWriterUseTableLock: any()
storedProcedureParameters: {}
storedProcedureTableTypeParameterName: any()
tableOption: any()
upsertSettings: {
interimSchemaName: any()
keys: any()
useTempDB: any()
}
writeBehavior: any()
For AzureTableSink, use:
type: 'AzureTableSink'
azureTableDefaultPartitionKeyValue: any()
azureTableInsertType: any()
azureTablePartitionKeyName: any()
azureTableRowKeyName: any()
For BinarySink, use:
type: 'BinarySink'
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For BlobSink, use:
type: 'BlobSink'
blobWriterAddHeader: any()
blobWriterDateTimeFormat: any()
blobWriterOverwriteFiles: any()
copyBehavior: any()
metadata: [
{
name: any()
value: any()
}
]
For CommonDataServiceForAppsSink, use:
type: 'CommonDataServiceForAppsSink'
alternateKeyName: any()
ignoreNullValues: any()
writeBehavior: 'Upsert'
For CosmosDbMongoDbApiSink, use:
For CosmosDbSqlApiSink, use:
For DelimitedTextSink, use:
type: 'DelimitedTextSink'
formatSettings: {
fileExtension: any()
fileNamePrefix: any()
maxRowsPerFile: any()
quoteAllText: any()
type: 'string'
}
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For DocumentDbCollectionSink, use:
For DynamicsCrmSink, use:
type: 'DynamicsCrmSink'
alternateKeyName: any()
ignoreNullValues: any()
writeBehavior: 'Upsert'
For DynamicsSink, use:
type: 'DynamicsSink'
alternateKeyName: any()
ignoreNullValues: any()
writeBehavior: 'Upsert'
For FileSystemSink, use:
For InformixSink, use:
For JsonSink, use:
type: 'JsonSink'
formatSettings: {
filePattern: any()
type: 'string'
}
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For MicrosoftAccessSink, use:
For MongoDbAtlasSink, use:
For MongoDbV2Sink, use:
For OdbcSink, use:
For OracleSink, use:
For OrcSink, use:
type: 'OrcSink'
formatSettings: {
fileNamePrefix: any()
maxRowsPerFile: any()
type: 'string'
}
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For ParquetSink, use:
type: 'ParquetSink'
formatSettings: {
fileNamePrefix: any()
maxRowsPerFile: any()
type: 'string'
}
storeSettings: {
copyBehavior: any()
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreWriteSettings objects
}
For RestSink, use:
type: 'RestSink'
additionalHeaders: any()
httpCompressionType: any()
httpRequestTimeout: any()
requestInterval: any()
requestMethod: any()
For SalesforceServiceCloudSink, use:
type: 'SalesforceServiceCloudSink'
externalIdFieldName: any()
ignoreNullValues: any()
writeBehavior: 'string'
For SalesforceSink, use:
type: 'SalesforceSink'
externalIdFieldName: any()
ignoreNullValues: any()
writeBehavior: 'string'
For SapCloudForCustomerSink, use:
For SnowflakeSink, use:
type: 'SnowflakeSink'
importSettings: {
additionalCopyOptions: {}
additionalFormatOptions: {}
type: 'string'
}
preCopyScript: any()
For SqlDWSink, use:
type: 'SqlDWSink'
allowCopyCommand: any()
allowPolyBase: any()
copyCommandSettings: {
additionalOptions: {}
defaultValues: [
{
columnName: any()
defaultValue: any()
}
]
}
polyBaseSettings: {
rejectSampleValue: any()
rejectType: 'string'
rejectValue: any()
useTypeDefault: any()
}
preCopyScript: any()
sqlWriterUseTableLock: any()
tableOption: any()
upsertSettings: {
interimSchemaName: any()
keys: any()
}
writeBehavior: any()
For SqlMISink, use:
type: 'SqlMISink'
preCopyScript: any()
sqlWriterStoredProcedureName: any()
sqlWriterTableType: any()
sqlWriterUseTableLock: any()
storedProcedureParameters: {}
storedProcedureTableTypeParameterName: any()
tableOption: any()
upsertSettings: {
interimSchemaName: any()
keys: any()
useTempDB: any()
}
writeBehavior: any()
For SqlServerSink, use:
type: 'SqlServerSink'
preCopyScript: any()
sqlWriterStoredProcedureName: any()
sqlWriterTableType: any()
sqlWriterUseTableLock: any()
storedProcedureParameters: {}
storedProcedureTableTypeParameterName: any()
tableOption: any()
upsertSettings: {
interimSchemaName: any()
keys: any()
useTempDB: any()
}
writeBehavior: any()
For SqlSink, use:
type: 'SqlSink'
preCopyScript: any()
sqlWriterStoredProcedureName: any()
sqlWriterTableType: any()
sqlWriterUseTableLock: any()
storedProcedureParameters: {}
storedProcedureTableTypeParameterName: any()
tableOption: any()
upsertSettings: {
interimSchemaName: any()
keys: any()
useTempDB: any()
}
writeBehavior: any()
StoreWriteSettings objects
Set the type property to specify the type of object.
For AzureBlobFSWriteSettings, use:
For AzureBlobStorageWriteSettings, use:
For AzureDataLakeStoreWriteSettings, use:
For AzureFileStorageWriteSettings, use:
For FileServerWriteSettings, use:
For SftpWriteSettings, use:
CopySource objects
Set the type property to specify the type of object.
For AmazonMWSSource, use:
For AmazonRdsForOracleSource, use:
type: 'AmazonRdsForOracleSource'
additionalColumns: any()
oracleReaderQuery: any()
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionNames: any()
partitionUpperBound: any()
}
queryTimeout: any()
For AmazonRdsForSqlServerSource, use:
type: 'AmazonRdsForSqlServerSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
produceAdditionalTypes: any()
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: {}
For AmazonRedshiftSource, use:
type: 'AmazonRedshiftSource'
query: any()
redshiftUnloadSettings: {
bucketName: any()
s3LinkedServiceName: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
}
For AvroSource, use:
type: 'AvroSource'
additionalColumns: any()
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For AzureBlobFSSource, use:
type: 'AzureBlobFSSource'
recursive: any()
skipHeaderLineCount: any()
treatEmptyAsNull: any()
For AzureDatabricksDeltaLakeSource, use:
type: 'AzureDatabricksDeltaLakeSource'
exportSettings: {
dateFormat: any()
timestampFormat: any()
type: 'string'
}
query: any()
For AzureDataExplorerSource, use:
type: 'AzureDataExplorerSource'
additionalColumns: any()
noTruncation: any()
query: any()
queryTimeout: any()
For AzureDataLakeStoreSource, use:
For AzureMariaDBSource, use:
For AzureMySqlSource, use:
For AzurePostgreSqlSource, use:
For AzureSqlSource, use:
type: 'AzureSqlSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
produceAdditionalTypes: any()
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: {}
For AzureTableSource, use:
type: 'AzureTableSource'
azureTableSourceIgnoreTableNotFound: any()
azureTableSourceQuery: any()
For BinarySource, use:
type: 'BinarySource'
formatSettings: {
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
type: 'string'
}
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For BlobSource, use:
For CassandraSource, use:
For CommonDataServiceForAppsSource, use:
For ConcurSource, use:
For CosmosDbMongoDbApiSource, use:
type: 'CosmosDbMongoDbApiSource'
additionalColumns: any()
batchSize: any()
cursorMethods: {
limit: any()
project: any()
skip: any()
sort: any()
}
filter: any()
queryTimeout: any()
For CosmosDbSqlApiSource, use:
type: 'CosmosDbSqlApiSource'
additionalColumns: any()
detectDatetime: any()
pageSize: any()
preferredRegions: any()
query: any()
For CouchbaseSource, use:
For Db2Source, use:
For DelimitedTextSource, use:
type: 'DelimitedTextSource'
additionalColumns: any()
formatSettings: {
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
skipLineCount: any()
type: 'string'
}
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For DocumentDbCollectionSource, use:
type: 'DocumentDbCollectionSource'
additionalColumns: any()
nestingSeparator: any()
query: any()
queryTimeout: any()
For DrillSource, use:
For DynamicsAXSource, use:
For DynamicsCrmSource, use:
For DynamicsSource, use:
For EloquaSource, use:
For ExcelSource, use:
type: 'ExcelSource'
additionalColumns: any()
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For FileSystemSource, use:
For GoogleAdWordsSource, use:
For GoogleBigQuerySource, use:
For GreenplumSource, use:
For HBaseSource, use:
For HdfsSource, use:
type: 'HdfsSource'
distcpSettings: {
distcpOptions: any()
resourceManagerEndpoint: any()
tempScriptPath: any()
}
recursive: any()
For HiveSource, use:
For HttpSource, use:
For HubspotSource, use:
For ImpalaSource, use:
For InformixSource, use:
For JiraSource, use:
For JsonSource, use:
type: 'JsonSource'
additionalColumns: any()
formatSettings: {
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
type: 'string'
}
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For MagentoSource, use:
For MariaDBSource, use:
For MarketoSource, use:
For MicrosoftAccessSource, use:
For MongoDbAtlasSource, use:
type: 'MongoDbAtlasSource'
additionalColumns: any()
batchSize: any()
cursorMethods: {
limit: any()
project: any()
skip: any()
sort: any()
}
filter: any()
queryTimeout: any()
For MongoDbSource, use:
For MongoDbV2Source, use:
type: 'MongoDbV2Source'
additionalColumns: any()
batchSize: any()
cursorMethods: {
limit: any()
project: any()
skip: any()
sort: any()
}
filter: any()
queryTimeout: any()
For MySqlSource, use:
For NetezzaSource, use:
type: 'NetezzaSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
query: any()
For ODataSource, use:
For OdbcSource, use:
For Office365Source, use:
type: 'Office365Source'
allowedGroups: any()
dateFilterColumn: any()
endTime: any()
outputColumns: any()
startTime: any()
userScopeFilterUri: any()
For OracleServiceCloudSource, use:
For OracleSource, use:
type: 'OracleSource'
additionalColumns: any()
oracleReaderQuery: any()
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionNames: any()
partitionUpperBound: any()
}
queryTimeout: any()
For OrcSource, use:
type: 'OrcSource'
additionalColumns: any()
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For ParquetSource, use:
type: 'ParquetSource'
additionalColumns: any()
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For PaypalSource, use:
For PhoenixSource, use:
For PostgreSqlSource, use:
For PrestoSource, use:
For QuickBooksSource, use:
For RelationalSource, use:
For ResponsysSource, use:
For RestSource, use:
type: 'RestSource'
additionalColumns: any()
additionalHeaders: any()
httpRequestTimeout: any()
paginationRules: any()
requestBody: any()
requestInterval: any()
requestMethod: any()
For SalesforceMarketingCloudSource, use:
For SalesforceServiceCloudSource, use:
type: 'SalesforceServiceCloudSource'
additionalColumns: any()
query: any()
readBehavior: 'string'
For SalesforceSource, use:
For SapBwSource, use:
For SapCloudForCustomerSource, use:
For SapEccSource, use:
For SapHanaSource, use:
type: 'SapHanaSource'
packetSize: any()
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
}
query: any()
For SapOpenHubSource, use:
type: 'SapOpenHubSource'
baseRequestId: any()
customRfcReadTableFunctionModule: any()
excludeLastRequest: any()
sapDataColumnDelimiter: any()
For SapTableSource, use:
type: 'SapTableSource'
batchSize: any()
customRfcReadTableFunctionModule: any()
partitionOption: any()
partitionSettings: {
maxPartitionsNumber: any()
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
rfcTableFields: any()
rfcTableOptions: any()
rowCount: any()
rowSkips: any()
sapDataColumnDelimiter: any()
For ServiceNowSource, use:
For SharePointOnlineListSource, use:
For ShopifySource, use:
For SnowflakeSource, use:
type: 'SnowflakeSource'
exportSettings: {
additionalCopyOptions: {}
additionalFormatOptions: {}
type: 'string'
}
query: any()
For SparkSource, use:
For SqlDWSource, use:
type: 'SqlDWSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: any()
For SqlMISource, use:
type: 'SqlMISource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
produceAdditionalTypes: any()
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: {}
For SqlServerSource, use:
type: 'SqlServerSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
produceAdditionalTypes: any()
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: {}
For SqlSource, use:
type: 'SqlSource'
isolationLevel: any()
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
sqlReaderQuery: any()
sqlReaderStoredProcedureName: any()
storedProcedureParameters: {}
For SquareSource, use:
For SybaseSource, use:
For TeradataSource, use:
type: 'TeradataSource'
partitionOption: any()
partitionSettings: {
partitionColumnName: any()
partitionLowerBound: any()
partitionUpperBound: any()
}
query: any()
For VerticaSource, use:
For WebSource, use:
For XeroSource, use:
For XmlSource, use:
type: 'XmlSource'
additionalColumns: any()
formatSettings: {
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
detectDataType: any()
namespacePrefixes: any()
namespaces: any()
type: 'string'
validationMode: any()
}
storeSettings: {
disableMetricsCollection: any()
maxConcurrentConnections: any()
type: 'string'
// For remaining properties, see StoreReadSettings objects
}
For ZohoSource, use:
StoreReadSettings objects
Set the type property to specify the type of object.
For AmazonS3CompatibleReadSettings, use:
type: 'AmazonS3CompatibleReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For AmazonS3ReadSettings, use:
type: 'AmazonS3ReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For AzureBlobFSReadSettings, use:
type: 'AzureBlobFSReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For AzureBlobStorageReadSettings, use:
type: 'AzureBlobStorageReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For AzureDataLakeStoreReadSettings, use:
type: 'AzureDataLakeStoreReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
listAfter: any()
listBefore: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For AzureFileStorageReadSettings, use:
type: 'AzureFileStorageReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For FileServerReadSettings, use:
type: 'FileServerReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileFilter: any()
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For FtpReadSettings, use:
type: 'FtpReadSettings'
deleteFilesAfterCompletion: any()
disableChunking: any()
enablePartitionDiscovery: bool
fileListPath: any()
partitionRootPath: any()
recursive: any()
useBinaryTransfer: bool
wildcardFileName: any()
wildcardFolderPath: any()
For GoogleCloudStorageReadSettings, use:
type: 'GoogleCloudStorageReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For HdfsReadSettings, use:
type: 'HdfsReadSettings'
deleteFilesAfterCompletion: any()
distcpSettings: {
distcpOptions: any()
resourceManagerEndpoint: any()
tempScriptPath: any()
}
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For HttpReadSettings, use:
type: 'HttpReadSettings'
additionalHeaders: any()
enablePartitionDiscovery: bool
partitionRootPath: any()
requestBody: any()
requestMethod: any()
requestTimeout: any()
For OracleCloudStorageReadSettings, use:
type: 'OracleCloudStorageReadSettings'
deleteFilesAfterCompletion: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
prefix: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
For SftpReadSettings, use:
type: 'SftpReadSettings'
deleteFilesAfterCompletion: any()
disableChunking: any()
enablePartitionDiscovery: bool
fileListPath: any()
modifiedDatetimeEnd: any()
modifiedDatetimeStart: any()
partitionRootPath: any()
recursive: any()
wildcardFileName: any()
wildcardFolderPath: any()
CompressionReadSettings objects
Set the type property to specify the type of object.
For TarGZipReadSettings, use:
For TarReadSettings, use:
For ZipDeflateReadSettings, use:
SecretBase objects
Set the type property to specify the type of object.
For AzureKeyVaultSecret, use:
type: 'AzureKeyVaultSecret'
secretName: any()
secretVersion: any()
store: {
parameters: {}
referenceName: 'string'
type: 'LinkedServiceReference'
}
For SecureString, use:
FormatReadSettings objects
Set the type property to specify the type of object.
For BinaryReadSettings, use:
type: 'BinaryReadSettings'
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
For DelimitedTextReadSettings, use:
type: 'DelimitedTextReadSettings'
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
skipLineCount: any()
For JsonReadSettings, use:
type: 'JsonReadSettings'
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
For XmlReadSettings, use:
type: 'XmlReadSettings'
compressionProperties: {
type: 'string'
// For remaining properties, see CompressionReadSettings objects
}
detectDataType: any()
namespacePrefixes: any()
namespaces: any()
validationMode: any()
Property values
factories/pipelines
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.DataFactory/factories/pipelines' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2018-06-01' |
| name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
string (required) Character limit: 1-260 Valid characters: Can't use: <>*#.%&:\\+?/ or control charactersStart with alphanumeric. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: factories |
| properties | A data factory pipeline. | Pipeline (required) |
Pipeline
| Name | Description | Value |
|---|---|---|
| activities | List of activities in pipeline. | Activity[] |
| annotations | List of tags that can be used for describing the Pipeline. | any[] |
| concurrency | The max number of concurrent runs for the pipeline. | int |
| description | The description of the pipeline. | string |
| folder | The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. | PipelineFolder |
| parameters | Definition of all parameters for an entity. | object |
| policy | Pipeline Policy. | PipelinePolicy |
| runDimensions | Dimensions emitted by Pipeline. | object |
| variables | Definition of variable for a Pipeline. | object |
Activity
| Name | Description | Value |
|---|---|---|
| dependsOn | Activity depends on condition. | ActivityDependency[] |
| description | Activity description. | string |
| name | Activity name. | string (required) |
| userProperties | Activity user properties. | UserProperty[] |
| type | Set the object type | AppendVariable AzureDataExplorerCommand AzureFunctionActivity AzureMLBatchExecution AzureMLExecutePipeline AzureMLUpdateResource Copy Custom DatabricksNotebook DatabricksSparkJar DatabricksSparkPython DataLakeAnalyticsU-SQL Delete ExecuteDataFlow ExecutePipeline ExecuteSSISPackage ExecuteWranglingDataflow Fail Filter ForEach GetMetadata HDInsightHive HDInsightMapReduce HDInsightPig HDInsightSpark HDInsightStreaming IfCondition Lookup Script SetVariable SqlServerStoredProcedure Switch Until Validation Wait WebActivity WebHook |
ActivityDependency
| Name | Description | Value |
|---|---|---|
| activity | Activity name. | string (required) |
| dependencyConditions | Match-Condition for the dependency. | String array containing any of: 'Completed' 'Failed' 'Skipped' 'Succeeded' |
UserProperty
| Name | Description | Value |
|---|---|---|
| name | User property name. | string (required) |
| value | Any object | For Bicep, you can use the any() function.(required) |
AppendVariableActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AppendVariable' |
| typeProperties | AppendVariable activity properties. | AppendVariableActivityTypeProperties (required) |
AppendVariableActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| value | Any object | For Bicep, you can use the any() function. |
| variableName | Name of the variable whose value needs to be appended to. | string |
AzureDataExplorerCommandActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AzureDataExplorerCommand' |
| typeProperties | Azure Data Explorer command activity properties. | AzureDataExplorerCommandActivityTypeProperties (required) |
AzureDataExplorerCommandActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| command | Any object | For Bicep, you can use the any() function.(required) |
| commandTimeout | Any object | For Bicep, you can use the any() function. |
AzureFunctionActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AzureFunctionActivity' |
| typeProperties | Azure Function activity type properties. | AzureFunctionActivityTypeProperties (required) |
AzureFunctionActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| body | Any object | For Bicep, you can use the any() function. |
| functionName | Any object | For Bicep, you can use the any() function.(required) |
| headers | Any object | For Bicep, you can use the any() function. |
| method | The list of HTTP methods supported by a AzureFunctionActivity. | 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'POST' 'PUT' 'TRACE' |
AzureMLBatchExecutionActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AzureMLBatchExecution' |
| typeProperties | Azure ML Batch Execution activity properties. | AzureMLBatchExecutionActivityTypeProperties (required) |
AzureMLBatchExecutionActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| 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. | object |
| webServiceInputs | 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. | object |
| webServiceOutputs | 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. | object |
AzureMLExecutePipelineActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AzureMLExecutePipeline' |
| typeProperties | Azure ML Execute Pipeline activity properties. | AzureMLExecutePipelineActivityTypeProperties (required) |
AzureMLExecutePipelineActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| continueOnStepFailure | Any object | For Bicep, you can use the any() function. |
| dataPathAssignments | Any object | For Bicep, you can use the any() function. |
| experimentName | Any object | For Bicep, you can use the any() function. |
| mlParentRunId | Any object | For Bicep, you can use the any() function. |
| mlPipelineEndpointId | Any object | For Bicep, you can use the any() function. |
| mlPipelineId | Any object | For Bicep, you can use the any() function. |
| mlPipelineParameters | Any object | For Bicep, you can use the any() function. |
| version | Any object | For Bicep, you can use the any() function. |
AzureMLUpdateResourceActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'AzureMLUpdateResource' |
| typeProperties | Azure ML Update Resource activity properties. | AzureMLUpdateResourceActivityTypeProperties (required) |
AzureMLUpdateResourceActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| trainedModelFilePath | Any object | For Bicep, you can use the any() function.(required) |
| trainedModelLinkedServiceName | Linked service reference type. | LinkedServiceReference (required) |
| trainedModelName | Any object | For Bicep, you can use the any() function.(required) |
LinkedServiceReference
| Name | Description | Value |
|---|---|---|
| parameters | An object mapping parameter names to argument values. | object |
| referenceName | Reference LinkedService name. | string (required) |
| type | Linked service reference type. | 'LinkedServiceReference' |
CopyActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Copy' |
| inputs | List of inputs for the activity. | DatasetReference[] |
| outputs | List of outputs for the activity. | DatasetReference[] |
| typeProperties | Copy activity properties. | CopyActivityTypeProperties (required) |
DatasetReference
| Name | Description | Value |
|---|---|---|
| parameters | An object mapping parameter names to argument values. | object |
| referenceName | Reference dataset name. | string (required) |
| type | Dataset reference type. | 'DatasetReference' |
CopyActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| dataIntegrationUnits | Any object | For Bicep, you can use the any() function. |
| enableSkipIncompatibleRow | Any object | For Bicep, you can use the any() function. |
| enableStaging | Any object | For Bicep, you can use the any() function. |
| logSettings | Log settings. | LogSettings |
| logStorageSettings | (Deprecated. Please use LogSettings) Log storage settings. | LogStorageSettings |
| parallelCopies | Any object | For Bicep, you can use the any() function. |
| preserve | Preserve rules. | any[] |
| preserveRules | Preserve Rules. | any[] |
| redirectIncompatibleRowSettings | Redirect incompatible row settings | RedirectIncompatibleRowSettings |
| sink | A copy activity sink. | CopySink (required) |
| skipErrorFile | Skip error file. | SkipErrorFile |
| source | A copy activity source. | CopySource (required) |
| stagingSettings | Staging settings. | StagingSettings |
| translator | Any object | For Bicep, you can use the any() function. |
| validateDataConsistency | Any object | For Bicep, you can use the any() function. |
LogSettings
| Name | Description | Value |
|---|---|---|
| copyActivityLogSettings | Settings for copy activity log. | CopyActivityLogSettings |
| enableCopyActivityLog | Any object | For Bicep, you can use the any() function. |
| logLocationSettings | Log location settings. | LogLocationSettings (required) |
CopyActivityLogSettings
| Name | Description | Value |
|---|---|---|
| enableReliableLogging | Any object | For Bicep, you can use the any() function. |
| logLevel | Any object | For Bicep, you can use the any() function. |
LogLocationSettings
| Name | Description | Value |
|---|---|---|
| linkedServiceName | Linked service reference type. | LinkedServiceReference (required) |
| path | Any object | For Bicep, you can use the any() function. |
LogStorageSettings
| Name | Description | Value |
|---|---|---|
| enableReliableLogging | Any object | For Bicep, you can use the any() function. |
| linkedServiceName | Linked service reference type. | LinkedServiceReference (required) |
| logLevel | Any object | For Bicep, you can use the any() function. |
| path | Any object | For Bicep, you can use the any() function. |
RedirectIncompatibleRowSettings
| Name | Description | Value |
|---|---|---|
| linkedServiceName | Any object | For Bicep, you can use the any() function.(required) |
| path | Any object | For Bicep, you can use the any() function. |
CopySink
AvroSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AvroSink' |
| formatSettings | Avro write settings. | AvroWriteSettings |
| storeSettings | Connector write settings. | StoreWriteSettings |
AvroWriteSettings
| Name | Description | Value |
|---|---|---|
| fileNamePrefix | Any object | For Bicep, you can use the any() function. |
| maxRowsPerFile | Any object | For Bicep, you can use the any() function. |
| recordName | Top level record name in write result, which is required in AVRO spec. | string |
| recordNamespace | Record namespace in the write result. | string |
| type | The write setting type. | string (required) |
StoreWriteSettings
| Name | Description | Value |
|---|---|---|
| copyBehavior | Any object | For Bicep, you can use the any() function. |
| disableMetricsCollection | Any object | For Bicep, you can use the any() function. |
| maxConcurrentConnections | Any object | For Bicep, you can use the any() function. |
| type | Set the object type | AzureBlobFSWriteSettings AzureBlobStorageWriteSettings AzureDataLakeStoreWriteSettings AzureFileStorageWriteSettings FileServerWriteSettings SftpWriteSettings |
AzureBlobFSWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'AzureBlobFSWriteSettings' |
| blockSizeInMB | Any object | For Bicep, you can use the any() function. |
AzureBlobStorageWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'AzureBlobStorageWriteSettings' |
| blockSizeInMB | Any object | For Bicep, you can use the any() function. |
AzureDataLakeStoreWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'AzureDataLakeStoreWriteSettings' |
| expiryDateTime | Any object | For Bicep, you can use the any() function. |
AzureFileStorageWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'AzureFileStorageWriteSettings' |
FileServerWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'FileServerWriteSettings' |
SftpWriteSettings
| Name | Description | Value |
|---|---|---|
| type | The write setting type. | 'SftpWriteSettings' |
| operationTimeout | Any object | For Bicep, you can use the any() function. |
| useTempFileRename | Any object | For Bicep, you can use the any() function. |
AzureBlobFSSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureBlobFSSink' |
| copyBehavior | Any object | For Bicep, you can use the any() function. |
| metadata | Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). | MetadataItem[] |
MetadataItem
| Name | Description | Value |
|---|---|---|
| name | Any object | For Bicep, you can use the any() function. |
| value | Any object | For Bicep, you can use the any() function. |
AzureDatabricksDeltaLakeSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureDatabricksDeltaLakeSink' |
| importSettings | Azure Databricks Delta Lake import command settings. | AzureDatabricksDeltaLakeImportCommand |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
AzureDatabricksDeltaLakeImportCommand
| Name | Description | Value |
|---|---|---|
| dateFormat | Any object | For Bicep, you can use the any() function. |
| timestampFormat | Any object | For Bicep, you can use the any() function. |
| type | The import setting type. | string (required) |
AzureDataExplorerSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureDataExplorerSink' |
| flushImmediately | Any object | For Bicep, you can use the any() function. |
| ingestionMappingAsJson | Any object | For Bicep, you can use the any() function. |
| ingestionMappingName | Any object | For Bicep, you can use the any() function. |
AzureDataLakeStoreSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureDataLakeStoreSink' |
| copyBehavior | Any object | For Bicep, you can use the any() function. |
| enableAdlsSingleFileParallel | Any object | For Bicep, you can use the any() function. |
AzureMySqlSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureMySqlSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
AzurePostgreSqlSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzurePostgreSqlSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
AzureQueueSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureQueueSink' |
AzureSearchIndexSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureSearchIndexSink' |
| writeBehavior | Specify the write behavior when upserting documents into Azure Search Index. | 'Merge' 'Upload' |
AzureSqlSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureSqlSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
| sqlWriterStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| sqlWriterTableType | Any object | For Bicep, you can use the any() function. |
| sqlWriterUseTableLock | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | SQL stored procedure parameters. | object |
| storedProcedureTableTypeParameterName | Any object | For Bicep, you can use the any() function. |
| tableOption | Any object | For Bicep, you can use the any() function. |
| upsertSettings | Sql upsert option settings | SqlUpsertSettings |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
SqlUpsertSettings
| Name | Description | Value |
|---|---|---|
| interimSchemaName | Any object | For Bicep, you can use the any() function. |
| keys | Any object | For Bicep, you can use the any() function. |
| useTempDB | Any object | For Bicep, you can use the any() function. |
AzureTableSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'AzureTableSink' |
| azureTableDefaultPartitionKeyValue | Any object | For Bicep, you can use the any() function. |
| azureTableInsertType | Any object | For Bicep, you can use the any() function. |
| azureTablePartitionKeyName | Any object | For Bicep, you can use the any() function. |
| azureTableRowKeyName | Any object | For Bicep, you can use the any() function. |
BinarySink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'BinarySink' |
| storeSettings | Connector write settings. | StoreWriteSettings |
BlobSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'BlobSink' |
| blobWriterAddHeader | Any object | For Bicep, you can use the any() function. |
| blobWriterDateTimeFormat | Any object | For Bicep, you can use the any() function. |
| blobWriterOverwriteFiles | Any object | For Bicep, you can use the any() function. |
| copyBehavior | Any object | For Bicep, you can use the any() function. |
| metadata | Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). | MetadataItem[] |
CommonDataServiceForAppsSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'CommonDataServiceForAppsSink' |
| alternateKeyName | Any object | For Bicep, you can use the any() function. |
| ignoreNullValues | Any object | For Bicep, you can use the any() function. |
| writeBehavior | Defines values for DynamicsSinkWriteBehavior. | 'Upsert' |
CosmosDbMongoDbApiSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'CosmosDbMongoDbApiSink' |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
CosmosDbSqlApiSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'CosmosDbSqlApiSink' |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
DelimitedTextSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'DelimitedTextSink' |
| formatSettings | Delimited text write settings. | DelimitedTextWriteSettings |
| storeSettings | Connector write settings. | StoreWriteSettings |
DelimitedTextWriteSettings
| Name | Description | Value |
|---|---|---|
| fileExtension | Any object | For Bicep, you can use the any() function.(required) |
| fileNamePrefix | Any object | For Bicep, you can use the any() function. |
| maxRowsPerFile | Any object | For Bicep, you can use the any() function. |
| quoteAllText | Any object | For Bicep, you can use the any() function. |
| type | The write setting type. | string (required) |
DocumentDbCollectionSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'DocumentDbCollectionSink' |
| nestingSeparator | Any object | For Bicep, you can use the any() function. |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
DynamicsCrmSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'DynamicsCrmSink' |
| alternateKeyName | Any object | For Bicep, you can use the any() function. |
| ignoreNullValues | Any object | For Bicep, you can use the any() function. |
| writeBehavior | Defines values for DynamicsSinkWriteBehavior. | 'Upsert' |
DynamicsSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'DynamicsSink' |
| alternateKeyName | Any object | For Bicep, you can use the any() function. |
| ignoreNullValues | Any object | For Bicep, you can use the any() function. |
| writeBehavior | Defines values for DynamicsSinkWriteBehavior. | 'Upsert' |
FileSystemSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'FileSystemSink' |
| copyBehavior | Any object | For Bicep, you can use the any() function. |
InformixSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'InformixSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
JsonSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'JsonSink' |
| formatSettings | Json write settings. | JsonWriteSettings |
| storeSettings | Connector write settings. | StoreWriteSettings |
JsonWriteSettings
| Name | Description | Value |
|---|---|---|
| filePattern | Any object | For Bicep, you can use the any() function. |
| type | The write setting type. | string (required) |
MicrosoftAccessSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'MicrosoftAccessSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
MongoDbAtlasSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'MongoDbAtlasSink' |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
MongoDbV2Sink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'MongoDbV2Sink' |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
OdbcSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'OdbcSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
OracleSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'OracleSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
OrcSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'OrcSink' |
| formatSettings | Orc write settings. | OrcWriteSettings |
| storeSettings | Connector write settings. | StoreWriteSettings |
OrcWriteSettings
| Name | Description | Value |
|---|---|---|
| fileNamePrefix | Any object | For Bicep, you can use the any() function. |
| maxRowsPerFile | Any object | For Bicep, you can use the any() function. |
| type | The write setting type. | string (required) |
ParquetSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'ParquetSink' |
| formatSettings | Parquet write settings. | ParquetWriteSettings |
| storeSettings | Connector write settings. | StoreWriteSettings |
ParquetWriteSettings
| Name | Description | Value |
|---|---|---|
| fileNamePrefix | Any object | For Bicep, you can use the any() function. |
| maxRowsPerFile | Any object | For Bicep, you can use the any() function. |
| type | The write setting type. | string (required) |
RestSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'RestSink' |
| additionalHeaders | Any object | For Bicep, you can use the any() function. |
| httpCompressionType | Any object | For Bicep, you can use the any() function. |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| requestInterval | Any object | For Bicep, you can use the any() function. |
| requestMethod | Any object | For Bicep, you can use the any() function. |
SalesforceServiceCloudSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SalesforceServiceCloudSink' |
| externalIdFieldName | Any object | For Bicep, you can use the any() function. |
| ignoreNullValues | Any object | For Bicep, you can use the any() function. |
| writeBehavior | The write behavior for the operation. Default is Insert. | 'Insert' 'Upsert' |
SalesforceSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SalesforceSink' |
| externalIdFieldName | Any object | For Bicep, you can use the any() function. |
| ignoreNullValues | Any object | For Bicep, you can use the any() function. |
| writeBehavior | The write behavior for the operation. Default is Insert. | 'Insert' 'Upsert' |
SapCloudForCustomerSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SapCloudForCustomerSink' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| writeBehavior | The write behavior for the operation. Default is 'Insert'. | 'Insert' 'Update' |
SnowflakeSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SnowflakeSink' |
| importSettings | Snowflake import command settings. | SnowflakeImportCopyCommand |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
SnowflakeImportCopyCommand
| Name | Description | Value |
|---|---|---|
| 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'" } | object |
| 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'" } | object |
| type | The import setting type. | string (required) |
SqlDWSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SqlDWSink' |
| allowCopyCommand | Any object | For Bicep, you can use the any() function. |
| allowPolyBase | Any object | For Bicep, you can use the any() function. |
| copyCommandSettings | DW Copy Command settings. | DWCopyCommandSettings |
| polyBaseSettings | PolyBase settings. | PolybaseSettings |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
| sqlWriterUseTableLock | Any object | For Bicep, you can use the any() function. |
| tableOption | Any object | For Bicep, you can use the any() function. |
| upsertSettings | Sql DW upsert option settings | SqlDWUpsertSettings |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
DWCopyCommandSettings
| Name | Description | Value |
|---|---|---|
| additionalOptions | 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'" } | object |
| defaultValues | 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). | DWCopyCommandDefaultValue[] |
DWCopyCommandDefaultValue
| Name | Description | Value |
|---|---|---|
| columnName | Any object | For Bicep, you can use the any() function. |
| defaultValue | Any object | For Bicep, you can use the any() function. |
PolybaseSettings
| Name | Description | Value |
|---|---|---|
| rejectSampleValue | Any object | For Bicep, you can use the any() function. |
| rejectType | Indicates whether the RejectValue property is specified as a literal value or a percentage. | 'percentage' 'value' |
| rejectValue | Any object | For Bicep, you can use the any() function. |
| useTypeDefault | Any object | For Bicep, you can use the any() function. |
SqlDWUpsertSettings
| Name | Description | Value |
|---|---|---|
| interimSchemaName | Any object | For Bicep, you can use the any() function. |
| keys | Any object | For Bicep, you can use the any() function. |
SqlMISink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SqlMISink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
| sqlWriterStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| sqlWriterTableType | Any object | For Bicep, you can use the any() function. |
| sqlWriterUseTableLock | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | SQL stored procedure parameters. | object |
| storedProcedureTableTypeParameterName | Any object | For Bicep, you can use the any() function. |
| tableOption | Any object | For Bicep, you can use the any() function. |
| upsertSettings | Sql upsert option settings | SqlUpsertSettings |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
SqlServerSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SqlServerSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
| sqlWriterStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| sqlWriterTableType | Any object | For Bicep, you can use the any() function. |
| sqlWriterUseTableLock | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | SQL stored procedure parameters. | object |
| storedProcedureTableTypeParameterName | Any object | For Bicep, you can use the any() function. |
| tableOption | Any object | For Bicep, you can use the any() function. |
| upsertSettings | Sql upsert option settings | SqlUpsertSettings |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
SqlSink
| Name | Description | Value |
|---|---|---|
| type | Copy sink type. | 'SqlSink' |
| preCopyScript | Any object | For Bicep, you can use the any() function. |
| sqlWriterStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| sqlWriterTableType | Any object | For Bicep, you can use the any() function. |
| sqlWriterUseTableLock | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | SQL stored procedure parameters. | object |
| storedProcedureTableTypeParameterName | Any object | For Bicep, you can use the any() function. |
| tableOption | Any object | For Bicep, you can use the any() function. |
| upsertSettings | Sql upsert option settings | SqlUpsertSettings |
| writeBehavior | Any object | For Bicep, you can use the any() function. |
SkipErrorFile
| Name | Description | Value |
|---|---|---|
| dataInconsistency | Any object | For Bicep, you can use the any() function. |
| fileMissing | Any object | For Bicep, you can use the any() function. |
CopySource
AmazonMWSSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AmazonMWSSource' |
| query | Any object | For Bicep, you can use the any() function. |
AmazonRdsForOracleSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AmazonRdsForOracleSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| oracleReaderQuery | Any object | For Bicep, you can use the any() function. |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for AmazonRdsForOracle source partitioning. | AmazonRdsForOraclePartitionSettings |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
AmazonRdsForOraclePartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionNames | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
AmazonRdsForSqlServerSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AmazonRdsForSqlServerSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| produceAdditionalTypes | Any object | For Bicep, you can use the any() function. |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". | object |
SqlPartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
AmazonRedshiftSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AmazonRedshiftSource' |
| query | Any object | For Bicep, you can use the any() function. |
| 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. | RedshiftUnloadSettings |
RedshiftUnloadSettings
| Name | Description | Value |
|---|---|---|
| bucketName | Any object | For Bicep, you can use the any() function.(required) |
| s3LinkedServiceName | Linked service reference type. | LinkedServiceReference (required) |
AvroSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AvroSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| storeSettings | Connector read setting. | StoreReadSettings |
StoreReadSettings
| Name | Description | Value |
|---|---|---|
| disableMetricsCollection | Any object | For Bicep, you can use the any() function. |
| maxConcurrentConnections | Any object | For Bicep, you can use the any() function. |
| type | Set the object type | AmazonS3CompatibleReadSettings AmazonS3ReadSettings AzureBlobFSReadSettings AzureBlobStorageReadSettings AzureDataLakeStoreReadSettings AzureFileStorageReadSettings FileServerReadSettings FtpReadSettings GoogleCloudStorageReadSettings HdfsReadSettings HttpReadSettings OracleCloudStorageReadSettings SftpReadSettings |
AmazonS3CompatibleReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AmazonS3CompatibleReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AmazonS3ReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AmazonS3ReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AzureBlobFSReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AzureBlobFSReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AzureBlobStorageReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AzureBlobStorageReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AzureDataLakeStoreReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AzureDataLakeStoreReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| listAfter | Any object | For Bicep, you can use the any() function. |
| listBefore | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AzureFileStorageReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'AzureFileStorageReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
FileServerReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'FileServerReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileFilter | Any object | For Bicep, you can use the any() function. |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
FtpReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'FtpReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| disableChunking | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| useBinaryTransfer | Specify whether to use binary transfer mode for FTP stores. | bool |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
GoogleCloudStorageReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'GoogleCloudStorageReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
HdfsReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'HdfsReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| distcpSettings | Distcp settings. | DistcpSettings |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
DistcpSettings
| Name | Description | Value |
|---|---|---|
| distcpOptions | Any object | For Bicep, you can use the any() function. |
| resourceManagerEndpoint | Any object | For Bicep, you can use the any() function.(required) |
| tempScriptPath | Any object | For Bicep, you can use the any() function.(required) |
HttpReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'HttpReadSettings' |
| additionalHeaders | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| requestBody | Any object | For Bicep, you can use the any() function. |
| requestMethod | Any object | For Bicep, you can use the any() function. |
| requestTimeout | Any object | For Bicep, you can use the any() function. |
OracleCloudStorageReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'OracleCloudStorageReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| prefix | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
SftpReadSettings
| Name | Description | Value |
|---|---|---|
| type | The read setting type. | 'SftpReadSettings' |
| deleteFilesAfterCompletion | Any object | For Bicep, you can use the any() function. |
| disableChunking | Any object | For Bicep, you can use the any() function. |
| enablePartitionDiscovery | Indicates whether to enable partition discovery. | bool |
| fileListPath | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeEnd | Any object | For Bicep, you can use the any() function. |
| modifiedDatetimeStart | Any object | For Bicep, you can use the any() function. |
| partitionRootPath | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
| wildcardFileName | Any object | For Bicep, you can use the any() function. |
| wildcardFolderPath | Any object | For Bicep, you can use the any() function. |
AzureBlobFSSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureBlobFSSource' |
| recursive | Any object | For Bicep, you can use the any() function. |
| skipHeaderLineCount | Any object | For Bicep, you can use the any() function. |
| treatEmptyAsNull | Any object | For Bicep, you can use the any() function. |
AzureDatabricksDeltaLakeSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureDatabricksDeltaLakeSource' |
| exportSettings | Azure Databricks Delta Lake export command settings. | AzureDatabricksDeltaLakeExportCommand |
| query | Any object | For Bicep, you can use the any() function. |
AzureDatabricksDeltaLakeExportCommand
| Name | Description | Value |
|---|---|---|
| dateFormat | Any object | For Bicep, you can use the any() function. |
| timestampFormat | Any object | For Bicep, you can use the any() function. |
| type | The export setting type. | string (required) |
AzureDataExplorerSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureDataExplorerSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| noTruncation | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function.(required) |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
AzureDataLakeStoreSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureDataLakeStoreSource' |
| recursive | Any object | For Bicep, you can use the any() function. |
AzureMariaDBSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureMariaDBSource' |
| query | Any object | For Bicep, you can use the any() function. |
AzureMySqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureMySqlSource' |
| query | Any object | For Bicep, you can use the any() function. |
AzurePostgreSqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzurePostgreSqlSource' |
| query | Any object | For Bicep, you can use the any() function. |
AzureSqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureSqlSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| produceAdditionalTypes | Any object | For Bicep, you can use the any() function. |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". | object |
AzureTableSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'AzureTableSource' |
| azureTableSourceIgnoreTableNotFound | Any object | For Bicep, you can use the any() function. |
| azureTableSourceQuery | Any object | For Bicep, you can use the any() function. |
BinarySource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'BinarySource' |
| formatSettings | Binary read settings. | BinaryReadSettings |
| storeSettings | Connector read setting. | StoreReadSettings |
BinaryReadSettings
| Name | Description | Value |
|---|---|---|
| compressionProperties | Compression read settings. | CompressionReadSettings |
| type | The read setting type. | string (required) |
CompressionReadSettings
| Name | Description | Value |
|---|---|---|
| type | Set the object type | TarGZipReadSettings TarReadSettings ZipDeflateReadSettings |
TarGZipReadSettings
| Name | Description | Value |
|---|---|---|
| type | The Compression setting type. | 'TarGZipReadSettings' |
| preserveCompressionFileNameAsFolder | Any object | For Bicep, you can use the any() function. |
TarReadSettings
| Name | Description | Value |
|---|---|---|
| type | The Compression setting type. | 'TarReadSettings' |
| preserveCompressionFileNameAsFolder | Any object | For Bicep, you can use the any() function. |
ZipDeflateReadSettings
| Name | Description | Value |
|---|---|---|
| type | The Compression setting type. | 'ZipDeflateReadSettings' |
| preserveZipFileNameAsFolder | Any object | For Bicep, you can use the any() function. |
BlobSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'BlobSource' |
| recursive | Any object | For Bicep, you can use the any() function. |
| skipHeaderLineCount | Any object | For Bicep, you can use the any() function. |
| treatEmptyAsNull | Any object | For Bicep, you can use the any() function. |
CassandraSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'CassandraSource' |
| consistencyLevel | 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. | 'ALL' 'EACH_QUORUM' 'LOCAL_ONE' 'LOCAL_QUORUM' 'LOCAL_SERIAL' 'ONE' 'QUORUM' 'SERIAL' 'THREE' 'TWO' |
| query | Any object | For Bicep, you can use the any() function. |
CommonDataServiceForAppsSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'CommonDataServiceForAppsSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
ConcurSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ConcurSource' |
| query | Any object | For Bicep, you can use the any() function. |
CosmosDbMongoDbApiSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'CosmosDbMongoDbApiSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| batchSize | Any object | For Bicep, you can use the any() function. |
| cursorMethods | Cursor methods for Mongodb query | MongoDbCursorMethodsProperties |
| filter | Any object | For Bicep, you can use the any() function. |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
MongoDbCursorMethodsProperties
| Name | Description | Value |
|---|---|---|
| limit | Any object | For Bicep, you can use the any() function. |
| project | Any object | For Bicep, you can use the any() function. |
| skip | Any object | For Bicep, you can use the any() function. |
| sort | Any object | For Bicep, you can use the any() function. |
CosmosDbSqlApiSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'CosmosDbSqlApiSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| detectDatetime | Any object | For Bicep, you can use the any() function. |
| pageSize | Any object | For Bicep, you can use the any() function. |
| preferredRegions | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
CouchbaseSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'CouchbaseSource' |
| query | Any object | For Bicep, you can use the any() function. |
Db2Source
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'Db2Source' |
| query | Any object | For Bicep, you can use the any() function. |
DelimitedTextSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DelimitedTextSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| formatSettings | Delimited text read settings. | DelimitedTextReadSettings |
| storeSettings | Connector read setting. | StoreReadSettings |
DelimitedTextReadSettings
| Name | Description | Value |
|---|---|---|
| compressionProperties | Compression read settings. | CompressionReadSettings |
| skipLineCount | Any object | For Bicep, you can use the any() function. |
| type | The read setting type. | string (required) |
DocumentDbCollectionSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DocumentDbCollectionSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| nestingSeparator | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
DrillSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DrillSource' |
| query | Any object | For Bicep, you can use the any() function. |
DynamicsAXSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DynamicsAXSource' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
DynamicsCrmSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DynamicsCrmSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
DynamicsSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'DynamicsSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
EloquaSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'EloquaSource' |
| query | Any object | For Bicep, you can use the any() function. |
ExcelSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ExcelSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| storeSettings | Connector read setting. | StoreReadSettings |
FileSystemSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'FileSystemSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| recursive | Any object | For Bicep, you can use the any() function. |
GoogleAdWordsSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'GoogleAdWordsSource' |
| query | Any object | For Bicep, you can use the any() function. |
GoogleBigQuerySource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'GoogleBigQuerySource' |
| query | Any object | For Bicep, you can use the any() function. |
GreenplumSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'GreenplumSource' |
| query | Any object | For Bicep, you can use the any() function. |
HBaseSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'HBaseSource' |
| query | Any object | For Bicep, you can use the any() function. |
HdfsSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'HdfsSource' |
| distcpSettings | Distcp settings. | DistcpSettings |
| recursive | Any object | For Bicep, you can use the any() function. |
HiveSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'HiveSource' |
| query | Any object | For Bicep, you can use the any() function. |
HttpSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'HttpSource' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
HubspotSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'HubspotSource' |
| query | Any object | For Bicep, you can use the any() function. |
ImpalaSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ImpalaSource' |
| query | Any object | For Bicep, you can use the any() function. |
InformixSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'InformixSource' |
| query | Any object | For Bicep, you can use the any() function. |
JiraSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'JiraSource' |
| query | Any object | For Bicep, you can use the any() function. |
JsonSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'JsonSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| formatSettings | Json read settings. | JsonReadSettings |
| storeSettings | Connector read setting. | StoreReadSettings |
JsonReadSettings
| Name | Description | Value |
|---|---|---|
| compressionProperties | Compression read settings. | CompressionReadSettings |
| type | The read setting type. | string (required) |
MagentoSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MagentoSource' |
| query | Any object | For Bicep, you can use the any() function. |
MariaDBSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MariaDBSource' |
| query | Any object | For Bicep, you can use the any() function. |
MarketoSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MarketoSource' |
| query | Any object | For Bicep, you can use the any() function. |
MicrosoftAccessSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MicrosoftAccessSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
MongoDbAtlasSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MongoDbAtlasSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| batchSize | Any object | For Bicep, you can use the any() function. |
| cursorMethods | Cursor methods for Mongodb query | MongoDbCursorMethodsProperties |
| filter | Any object | For Bicep, you can use the any() function. |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
MongoDbSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MongoDbSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
MongoDbV2Source
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MongoDbV2Source' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| batchSize | Any object | For Bicep, you can use the any() function. |
| cursorMethods | Cursor methods for Mongodb query | MongoDbCursorMethodsProperties |
| filter | Any object | For Bicep, you can use the any() function. |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
MySqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'MySqlSource' |
| query | Any object | For Bicep, you can use the any() function. |
NetezzaSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'NetezzaSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Netezza source partitioning. | NetezzaPartitionSettings |
| query | Any object | For Bicep, you can use the any() function. |
NetezzaPartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
ODataSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ODataSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
OdbcSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'OdbcSource' |
| query | Any object | For Bicep, you can use the any() function. |
Office365Source
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'Office365Source' |
| allowedGroups | Any object | For Bicep, you can use the any() function. |
| dateFilterColumn | Any object | For Bicep, you can use the any() function. |
| endTime | Any object | For Bicep, you can use the any() function. |
| outputColumns | Any object | For Bicep, you can use the any() function. |
| startTime | Any object | For Bicep, you can use the any() function. |
| userScopeFilterUri | Any object | For Bicep, you can use the any() function. |
OracleServiceCloudSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'OracleServiceCloudSource' |
| query | Any object | For Bicep, you can use the any() function. |
OracleSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'OracleSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| oracleReaderQuery | Any object | For Bicep, you can use the any() function. |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Oracle source partitioning. | OraclePartitionSettings |
| queryTimeout | Any object | For Bicep, you can use the any() function. |
OraclePartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionNames | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
OrcSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'OrcSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| storeSettings | Connector read setting. | StoreReadSettings |
ParquetSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ParquetSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| storeSettings | Connector read setting. | StoreReadSettings |
PaypalSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'PaypalSource' |
| query | Any object | For Bicep, you can use the any() function. |
PhoenixSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'PhoenixSource' |
| query | Any object | For Bicep, you can use the any() function. |
PostgreSqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'PostgreSqlSource' |
| query | Any object | For Bicep, you can use the any() function. |
PrestoSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'PrestoSource' |
| query | Any object | For Bicep, you can use the any() function. |
QuickBooksSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'QuickBooksSource' |
| query | Any object | For Bicep, you can use the any() function. |
RelationalSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'RelationalSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
ResponsysSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ResponsysSource' |
| query | Any object | For Bicep, you can use the any() function. |
RestSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'RestSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| additionalHeaders | Any object | For Bicep, you can use the any() function. |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| paginationRules | Any object | For Bicep, you can use the any() function. |
| requestBody | Any object | For Bicep, you can use the any() function. |
| requestInterval | Any object | For Bicep, you can use the any() function. |
| requestMethod | Any object | For Bicep, you can use the any() function. |
SalesforceMarketingCloudSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SalesforceMarketingCloudSource' |
| query | Any object | For Bicep, you can use the any() function. |
SalesforceServiceCloudSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SalesforceServiceCloudSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
| readBehavior | The read behavior for the operation. Default is Query. | 'Query' 'QueryAll' |
SalesforceSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SalesforceSource' |
| query | Any object | For Bicep, you can use the any() function. |
| readBehavior | The read behavior for the operation. Default is Query. | 'Query' 'QueryAll' |
SapBwSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapBwSource' |
| query | Any object | For Bicep, you can use the any() function. |
SapCloudForCustomerSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapCloudForCustomerSource' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
SapEccSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapEccSource' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
SapHanaSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapHanaSource' |
| packetSize | Any object | For Bicep, you can use the any() function. |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for SAP HANA source partitioning. | SapHanaPartitionSettings |
| query | Any object | For Bicep, you can use the any() function. |
SapHanaPartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
SapOpenHubSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapOpenHubSource' |
| baseRequestId | Any object | For Bicep, you can use the any() function. |
| customRfcReadTableFunctionModule | Any object | For Bicep, you can use the any() function. |
| excludeLastRequest | Any object | For Bicep, you can use the any() function. |
| sapDataColumnDelimiter | Any object | For Bicep, you can use the any() function. |
SapTableSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SapTableSource' |
| batchSize | Any object | For Bicep, you can use the any() function. |
| customRfcReadTableFunctionModule | Any object | For Bicep, you can use the any() function. |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for SAP table source partitioning. | SapTablePartitionSettings |
| rfcTableFields | Any object | For Bicep, you can use the any() function. |
| rfcTableOptions | Any object | For Bicep, you can use the any() function. |
| rowCount | Any object | For Bicep, you can use the any() function. |
| rowSkips | Any object | For Bicep, you can use the any() function. |
| sapDataColumnDelimiter | Any object | For Bicep, you can use the any() function. |
SapTablePartitionSettings
| Name | Description | Value |
|---|---|---|
| maxPartitionsNumber | Any object | For Bicep, you can use the any() function. |
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
ServiceNowSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ServiceNowSource' |
| query | Any object | For Bicep, you can use the any() function. |
SharePointOnlineListSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SharePointOnlineListSource' |
| httpRequestTimeout | Any object | For Bicep, you can use the any() function. |
| query | Any object | For Bicep, you can use the any() function. |
ShopifySource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ShopifySource' |
| query | Any object | For Bicep, you can use the any() function. |
SnowflakeSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SnowflakeSource' |
| exportSettings | Snowflake export command settings. | SnowflakeExportCopyCommand |
| query | Any object | For Bicep, you can use the any() function. |
SnowflakeExportCopyCommand
| Name | Description | Value |
|---|---|---|
| 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'" } | object |
| 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'" } | object |
| type | The export setting type. | string (required) |
SparkSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SparkSource' |
| query | Any object | For Bicep, you can use the any() function. |
SqlDWSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SqlDWSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Any object | For Bicep, you can use the any() function. |
SqlMISource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SqlMISource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| produceAdditionalTypes | Any object | For Bicep, you can use the any() function. |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". | object |
SqlServerSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SqlServerSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| produceAdditionalTypes | Any object | For Bicep, you can use the any() function. |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". | object |
SqlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SqlSource' |
| isolationLevel | Any object | For Bicep, you can use the any() function. |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for Sql source partitioning. | SqlPartitionSettings |
| sqlReaderQuery | Any object | For Bicep, you can use the any() function. |
| sqlReaderStoredProcedureName | Any object | For Bicep, you can use the any() function. |
| storedProcedureParameters | Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". | object |
SquareSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SquareSource' |
| query | Any object | For Bicep, you can use the any() function. |
SybaseSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'SybaseSource' |
| query | Any object | For Bicep, you can use the any() function. |
TeradataSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'TeradataSource' |
| partitionOption | Any object | For Bicep, you can use the any() function. |
| partitionSettings | The settings that will be leveraged for teradata source partitioning. | TeradataPartitionSettings |
| query | Any object | For Bicep, you can use the any() function. |
TeradataPartitionSettings
| Name | Description | Value |
|---|---|---|
| partitionColumnName | Any object | For Bicep, you can use the any() function. |
| partitionLowerBound | Any object | For Bicep, you can use the any() function. |
| partitionUpperBound | Any object | For Bicep, you can use the any() function. |
VerticaSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'VerticaSource' |
| query | Any object | For Bicep, you can use the any() function. |
WebSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'WebSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
XeroSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'XeroSource' |
| query | Any object | For Bicep, you can use the any() function. |
XmlSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'XmlSource' |
| additionalColumns | Any object | For Bicep, you can use the any() function. |
| formatSettings | Xml read settings. | XmlReadSettings |
| storeSettings | Connector read setting. | StoreReadSettings |
XmlReadSettings
| Name | Description | Value |
|---|---|---|
| compressionProperties | Compression read settings. | CompressionReadSettings |
| detectDataType | Any object | For Bicep, you can use the any() function. |
| namespacePrefixes | Any object | For Bicep, you can use the any() function. |
| namespaces | Any object | For Bicep, you can use the any() function. |
| type | The read setting type. | string (required) |
| validationMode | Any object | For Bicep, you can use the any() function. |
ZohoSource
| Name | Description | Value |
|---|---|---|
| type | Copy source type. | 'ZohoSource' |
| query | Any object | For Bicep, you can use the any() function. |
StagingSettings
| Name | Description | Value |
|---|---|---|
| enableCompression | Any object | For Bicep, you can use the any() function. |
| linkedServiceName | Linked service reference type. | LinkedServiceReference (required) |
| path | Any object | For Bicep, you can use the any() function. |
CustomActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Custom' |
| typeProperties | Custom activity properties. | CustomActivityTypeProperties (required) |
CustomActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| autoUserSpecification | Any object | For Bicep, you can use the any() function. |
| command | Any object | For Bicep, you can use the any() function.(required) |
| 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. | object |
| folderPath | Any object | For Bicep, you can use the any() function. |
| referenceObjects | Reference objects for custom activity | CustomActivityReferenceObject |
| resourceLinkedService | Linked service reference type. | LinkedServiceReference |
| retentionTimeInDays | Any object | For Bicep, you can use the any() function. |
CustomActivityReferenceObject
| Name | Description | Value |
|---|---|---|
| datasets | Dataset references. | DatasetReference[] |
| linkedServices | Linked service references. | LinkedServiceReference[] |
DatabricksNotebookActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'DatabricksNotebook' |
| typeProperties | Databricks Notebook activity properties. | DatabricksNotebookActivityTypeProperties (required) |
DatabricksNotebookActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| 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. | object |
| libraries | A list of libraries to be installed on the cluster that will execute the job. | object |
| notebookPath | Any object | For Bicep, you can use the any() function.(required) |
DatabricksSparkJarActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'DatabricksSparkJar' |
| typeProperties | Databricks SparkJar activity properties. | DatabricksSparkJarActivityTypeProperties (required) |
DatabricksSparkJarActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| libraries | A list of libraries to be installed on the cluster that will execute the job. | object |
| mainClassName | Any object | For Bicep, you can use the any() function.(required) |
| parameters | Parameters that will be passed to the main method. | any[] |
DatabricksSparkPythonActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'DatabricksSparkPython' |
| typeProperties | Databricks SparkPython activity properties. | DatabricksSparkPythonActivityTypeProperties (required) |
DatabricksSparkPythonActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| libraries | A list of libraries to be installed on the cluster that will execute the job. | object |
| parameters | Command line parameters that will be passed to the Python file. | any[] |
| pythonFile | Any object | For Bicep, you can use the any() function.(required) |
DataLakeAnalyticsUsqlActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'DataLakeAnalyticsU-SQL' |
| typeProperties | DataLakeAnalyticsU-SQL activity properties. | DataLakeAnalyticsUsqlActivityTypeProperties (required) |
DataLakeAnalyticsUsqlActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| compilationMode | Any object | For Bicep, you can use the any() function. |
| degreeOfParallelism | Any object | For Bicep, you can use the any() function. |
| parameters | Parameters for U-SQL job request. | object |
| priority | Any object | For Bicep, you can use the any() function. |
| runtimeVersion | Any object | For Bicep, you can use the any() function. |
| scriptLinkedService | Linked service reference type. | LinkedServiceReference (required) |
| scriptPath | Any object | For Bicep, you can use the any() function.(required) |
DeleteActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Delete' |
| typeProperties | Delete activity properties. | DeleteActivityTypeProperties (required) |
DeleteActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| dataset | Dataset reference type. | DatasetReference (required) |
| enableLogging | Any object | For Bicep, you can use the any() function. |
| logStorageSettings | (Deprecated. Please use LogSettings) Log storage settings. | LogStorageSettings |
| maxConcurrentConnections | The max concurrent connections to connect data source at the same time. | int |
| recursive | Any object | For Bicep, you can use the any() function. |
| storeSettings | Connector read setting. | StoreReadSettings |
ExecuteDataFlowActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'ExecuteDataFlow' |
| typeProperties | Execute data flow activity properties. | ExecuteDataFlowActivityTypeProperties (required) |
ExecuteDataFlowActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| compute | Compute properties for data flow activity. | ExecuteDataFlowActivityTypePropertiesCompute |
| continueOnError | Any object | For Bicep, you can use the any() function. |
| dataFlow | Data flow reference type. | DataFlowReference (required) |
| integrationRuntime | Integration runtime reference type. | IntegrationRuntimeReference |
| runConcurrently | Any object | For Bicep, you can use the any() function. |
| staging | Staging info for execute data flow activity. | DataFlowStagingInfo |
| traceLevel | Any object | For Bicep, you can use the any() function. |
ExecuteDataFlowActivityTypePropertiesCompute
| Name | Description | Value |
|---|---|---|
| computeType | Any object | For Bicep, you can use the any() function. |
| coreCount | Any object | For Bicep, you can use the any() function. |
DataFlowReference
| Name | Description | Value |
|---|---|---|
| datasetParameters | Any object | For Bicep, you can use the any() function. |
| parameters | An object mapping parameter names to argument values. | object |
| referenceName | Reference data flow name. | string (required) |
| type | Data flow reference type. | 'DataFlowReference' |
IntegrationRuntimeReference
| Name | Description | Value |
|---|---|---|
| parameters | An object mapping parameter names to argument values. | object |
| referenceName | Reference integration runtime name. | string (required) |
| type | Type of integration runtime. | 'IntegrationRuntimeReference' |
DataFlowStagingInfo
| Name | Description | Value |
|---|---|---|
| folderPath | Any object | For Bicep, you can use the any() function. |
| linkedService | Linked service reference type. | LinkedServiceReference |
ExecutePipelineActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'ExecutePipeline' |
| policy | Execution policy for an execute pipeline activity. | ExecutePipelineActivityPolicy |
| typeProperties | Execute pipeline activity properties. | ExecutePipelineActivityTypeProperties (required) |
ExecutePipelineActivityPolicy
| Name | Description | Value |
|---|---|---|
| secureInput | When set to true, Input from activity is considered as secure and will not be logged to monitoring. | bool |
ExecutePipelineActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| parameters | An object mapping parameter names to argument values. | object |
| pipeline | Pipeline reference type. | PipelineReference (required) |
| waitOnCompletion | Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. | bool |
PipelineReference
| Name | Description | Value |
|---|---|---|
| name | Reference name. | string |
| referenceName | Reference pipeline name. | string (required) |
| type | Pipeline reference type. | 'PipelineReference' |
ExecuteSsisPackageActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'ExecuteSSISPackage' |
| typeProperties | Execute SSIS package activity properties. | ExecuteSsisPackageActivityTypeProperties (required) |
ExecuteSsisPackageActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| connectVia | Integration runtime reference type. | IntegrationRuntimeReference (required) |
| environmentPath | Any object | For Bicep, you can use the any() function. |
| executionCredential | SSIS package execution credential. | SsisExecutionCredential |
| loggingLevel | Any object | For Bicep, you can use the any() function. |
| logLocation | SSIS package execution log location | SsisLogLocation |
| packageConnectionManagers | The package level connection managers to execute the SSIS package. | object |
| packageLocation | SSIS package location. | SsisPackageLocation (required) |
| packageParameters | The package level parameters to execute the SSIS package. | object |
| projectConnectionManagers | The project level connection managers to execute the SSIS package. | object |
| projectParameters | The project level parameters to execute the SSIS package. | object |
| propertyOverrides | The property overrides to execute the SSIS package. | object |
| runtime | Any object | For Bicep, you can use the any() function. |
SsisExecutionCredential
| Name | Description | Value |
|---|---|---|
| domain | Any object | For Bicep, you can use the any() function.(required) |
| password | Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. | SecureString (required) |
| userName | Any object | For Bicep, you can use the any() function.(required) |
SecureString
| Name | Description | Value |
|---|---|---|
| type | Type of the secret. | string (required) |
| value | Value of secure string. | string (required) |
SsisLogLocation
| Name | Description | Value |
|---|---|---|
| logPath | Any object | For Bicep, you can use the any() function.(required) |
| type | The type of SSIS log location. | 'File' |
| typeProperties | SSIS package execution log location properties. | SsisLogLocationTypeProperties (required) |
SsisLogLocationTypeProperties
| Name | Description | Value |
|---|---|---|
| accessCredential | SSIS access credential. | SsisAccessCredential |
| logRefreshInterval | Any object | For Bicep, you can use the any() function. |
SsisAccessCredential
| Name | Description | Value |
|---|---|---|
| domain | Any object | For Bicep, you can use the any() function.(required) |
| password | The base definition of a secret type. | SecretBase (required) |
| userName | Any object | For Bicep, you can use the any() function.(required) |
SecretBase
| Name | Description | Value |
|---|---|---|
| type | Set the object type | AzureKeyVaultSecret SecureString |
AzureKeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretName | Any object | For Bicep, you can use the any() function.(required) |
| secretVersion | Any object | For Bicep, you can use the any() function. |
| store | Linked service reference type. | LinkedServiceReference (required) |
| type | Type of the secret. | string (required) |
SsisPackageLocation
| Name | Description | Value |
|---|---|---|
| packagePath | Any object | For Bicep, you can use the any() function. |
| type | The type of SSIS package location. | 'File' 'InlinePackage' 'PackageStore' 'SSISDB' |
| typeProperties | SSIS package location properties. | SsisPackageLocationTypeProperties |
SsisPackageLocationTypeProperties
| Name | Description | Value |
|---|---|---|
| accessCredential | SSIS access credential. | SsisAccessCredential |
| childPackages | The embedded child package list. | SsisChildPackage[] |
| configurationAccessCredential | SSIS access credential. | SsisAccessCredential |
| configurationPath | Any object | For Bicep, you can use the any() function. |
| packageContent | Any object | For Bicep, you can use the any() function. |
| packageLastModifiedDate | The embedded package last modified date. | string |
| packageName | The package name. | string |
| packagePassword | The base definition of a secret type. | SecretBase |
SsisChildPackage
| Name | Description | Value |
|---|---|---|
| packageContent | Any object | For Bicep, you can use the any() function.(required) |
| packageLastModifiedDate | Last modified date for embedded child package. | string |
| packageName | Name for embedded child package. | string |
| packagePath | Any object | For Bicep, you can use the any() function.(required) |
ExecuteWranglingDataflowActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'ExecuteWranglingDataflow' |
| policy | Execution policy for an activity. | ActivityPolicy |
| typeProperties | Execute power query data flow activity properties. | ExecutePowerQueryActivityTypeProperties (required) |
ActivityPolicy
| Name | Description | Value |
|---|---|---|
| retry | Any object | For Bicep, you can use the any() function. |
| retryIntervalInSeconds | Interval between each retry attempt (in seconds). The default is 30 sec. | int |
| secureInput | When set to true, Input from activity is considered as secure and will not be logged to monitoring. | bool |
| secureOutput | When set to true, Output from activity is considered as secure and will not be logged to monitoring. | bool |
| timeout | Any object | For Bicep, you can use the any() function. |
ExecutePowerQueryActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| compute | Compute properties for data flow activity. | ExecuteDataFlowActivityTypePropertiesCompute |
| continueOnError | Any object | For Bicep, you can use the any() function. |
| dataFlow | Data flow reference type. | DataFlowReference (required) |
| integrationRuntime | Integration runtime reference type. | IntegrationRuntimeReference |
| queries | List of mapping for Power Query mashup query to sink dataset(s). | PowerQuerySinkMapping[] |
| runConcurrently | Any object | For Bicep, you can use the any() function. |
| sinks | (Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName. | object |
| staging | Staging info for execute data flow activity. | DataFlowStagingInfo |
| traceLevel | Any object | For Bicep, you can use the any() function. |
PowerQuerySinkMapping
| Name | Description | Value |
|---|---|---|
| dataflowSinks | List of sinks mapped to Power Query mashup query. | PowerQuerySink[] |
| queryName | Name of the query in Power Query mashup document. | string |
PowerQuerySink
| Name | Description | Value |
|---|---|---|
| dataset | Dataset reference type. | DatasetReference |
| description | Transformation description. | string |
| flowlet | Data flow reference type. | DataFlowReference |
| linkedService | Linked service reference type. | LinkedServiceReference |
| name | Transformation name. | string (required) |
| schemaLinkedService | Linked service reference type. | LinkedServiceReference |
| script | sink script. | string |
FailActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Fail' |
| typeProperties | Fail activity properties. | FailActivityTypeProperties (required) |
FailActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| errorCode | Any object | For Bicep, you can use the any() function.(required) |
| message | Any object | For Bicep, you can use the any() function.(required) |
FilterActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Filter' |
| typeProperties | Filter activity properties. | FilterActivityTypeProperties (required) |
FilterActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| condition | Azure Data Factory expression definition. | Expression (required) |
| items | Azure Data Factory expression definition. | Expression (required) |
Expression
| Name | Description | Value |
|---|---|---|
| type | Expression type. | 'Expression' |
| value | Expression value. | string (required) |
ForEachActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'ForEach' |
| typeProperties | ForEach activity properties. | ForEachActivityTypeProperties (required) |
ForEachActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| activities | List of activities to execute . | Activity[] (required) |
| batchCount | Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). | int |
| isSequential | Should the loop be executed in sequence or in parallel (max 50) | bool |
| items | Azure Data Factory expression definition. | Expression (required) |
GetMetadataActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'GetMetadata' |
| typeProperties | GetMetadata activity properties. | GetMetadataActivityTypeProperties (required) |
GetMetadataActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| dataset | Dataset reference type. | DatasetReference (required) |
| fieldList | Fields of metadata to get from dataset. | any[] |
| formatSettings | Format read settings. | FormatReadSettings |
| storeSettings | Connector read setting. | StoreReadSettings |
FormatReadSettings
| Name | Description | Value |
|---|---|---|
| type | Set the object type | BinaryReadSettings DelimitedTextReadSettings JsonReadSettings XmlReadSettings |
HDInsightHiveActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'HDInsightHive' |
| typeProperties | HDInsight Hive activity properties. | HDInsightHiveActivityTypeProperties (required) |
HDInsightHiveActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| arguments | User specified arguments to HDInsightActivity. | any[] |
| defines | Allows user to specify defines for Hive job request. | object |
| getDebugInfo | The HDInsightActivityDebugInfoOption settings to use. | 'Always' 'Failure' 'None' |
| queryTimeout | Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package) | int |
| scriptLinkedService | Linked service reference type. | LinkedServiceReference |
| scriptPath | Any object | For Bicep, you can use the any() function. |
| storageLinkedServices | Storage linked service references. | LinkedServiceReference[] |
| variables | User specified arguments under hivevar namespace. | any[] |
HDInsightMapReduceActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'HDInsightMapReduce' |
| typeProperties | HDInsight MapReduce activity properties. | HDInsightMapReduceActivityTypeProperties (required) |
HDInsightMapReduceActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| arguments | User specified arguments to HDInsightActivity. | any[] |
| className | Any object | For Bicep, you can use the any() function.(required) |
| defines | Allows user to specify defines for the MapReduce job request. | object |
| getDebugInfo | The HDInsightActivityDebugInfoOption settings to use. | 'Always' 'Failure' 'None' |
| jarFilePath | Any object | For Bicep, you can use the any() function.(required) |
| jarLibs | Jar libs. | any[] |
| jarLinkedService | Linked service reference type. | LinkedServiceReference |
| storageLinkedServices | Storage linked service references. | LinkedServiceReference[] |
HDInsightPigActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'HDInsightPig' |
| typeProperties | HDInsight Pig activity properties. | HDInsightPigActivityTypeProperties (required) |
HDInsightPigActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| arguments | Any object | For Bicep, you can use the any() function. |
| defines | Allows user to specify defines for Pig job request. | object |
| getDebugInfo | The HDInsightActivityDebugInfoOption settings to use. | 'Always' 'Failure' 'None' |
| scriptLinkedService | Linked service reference type. | LinkedServiceReference |
| scriptPath | Any object | For Bicep, you can use the any() function. |
| storageLinkedServices | Storage linked service references. | LinkedServiceReference[] |
HDInsightSparkActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'HDInsightSpark' |
| typeProperties | HDInsight spark activity properties. | HDInsightSparkActivityTypeProperties (required) |
HDInsightSparkActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| arguments | The user-specified arguments to HDInsightSparkActivity. | any[] |
| className | The application's Java/Spark main class. | string |
| entryFilePath | Any object | For Bicep, you can use the any() function.(required) |
| getDebugInfo | The HDInsightActivityDebugInfoOption settings to use. | 'Always' 'Failure' 'None' |
| proxyUser | Any object | For Bicep, you can use the any() function. |
| rootPath | Any object | For Bicep, you can use the any() function.(required) |
| sparkConfig | Spark configuration property. | object |
| sparkJobLinkedService | Linked service reference type. | LinkedServiceReference |
HDInsightStreamingActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'HDInsightStreaming' |
| typeProperties | HDInsight streaming activity properties. | HDInsightStreamingActivityTypeProperties (required) |
HDInsightStreamingActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| arguments | User specified arguments to HDInsightActivity. | any[] |
| combiner | Any object | For Bicep, you can use the any() function. |
| commandEnvironment | Command line environment values. | any[] |
| defines | Allows user to specify defines for streaming job request. | object |
| fileLinkedService | Linked service reference type. | LinkedServiceReference |
| filePaths | Paths to streaming job files. Can be directories. | any[] (required) |
| getDebugInfo | The HDInsightActivityDebugInfoOption settings to use. | 'Always' 'Failure' 'None' |
| input | Any object | For Bicep, you can use the any() function.(required) |
| mapper | Any object | For Bicep, you can use the any() function.(required) |
| output | Any object | For Bicep, you can use the any() function.(required) |
| reducer | Any object | For Bicep, you can use the any() function.(required) |
| storageLinkedServices | Storage linked service references. | LinkedServiceReference[] |
IfConditionActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'IfCondition' |
| typeProperties | IfCondition activity properties. | IfConditionActivityTypeProperties (required) |
IfConditionActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| expression | Azure Data Factory expression definition. | Expression (required) |
| ifFalseActivities | 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. | Activity[] |
| ifTrueActivities | 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. | Activity[] |
LookupActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Lookup' |
| typeProperties | Lookup activity properties. | LookupActivityTypeProperties (required) |
LookupActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| dataset | Dataset reference type. | DatasetReference (required) |
| firstRowOnly | Any object | For Bicep, you can use the any() function. |
| source | A copy activity source. | CopySource (required) |
ScriptActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Script' |
| typeProperties | Script activity properties. | ScriptActivityTypeProperties (required) |
ScriptActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| logSettings | Log settings of script activity. | ScriptActivityTypePropertiesLogSettings |
| scripts | Array of script blocks. Type: array. | ScriptActivityScriptBlock[] |
ScriptActivityTypePropertiesLogSettings
| Name | Description | Value |
|---|---|---|
| logDestination | The destination of logs. Type: string. | 'ActivityOutput' 'ExternalStore' |
| logLocationSettings | Log location settings. | LogLocationSettings |
ScriptActivityScriptBlock
| Name | Description | Value |
|---|---|---|
| parameters | Array of script parameters. Type: array. | ScriptActivityParameter[] |
| text | Any object | For Bicep, you can use the any() function.(required) |
| type | The type of the query. Type: string. | 'NonQuery' 'Query' |
ScriptActivityParameter
| Name | Description | Value |
|---|---|---|
| direction | The direction of the parameter. | 'Input' 'InputOutput' 'Output' |
| name | Any object | For Bicep, you can use the any() function. |
| size | The size of the output direction parameter. | int |
| type | The type of the parameter. | 'Boolean' 'DateTime' 'DateTimeOffset' 'Decimal' 'Double' 'Guid' 'Int16' 'Int32' 'Int64' 'Single' 'String' 'Timespan' |
| value | Any object | For Bicep, you can use the any() function. |
SetVariableActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'SetVariable' |
| typeProperties | SetVariable activity properties. | SetVariableActivityTypeProperties (required) |
SetVariableActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| value | Any object | For Bicep, you can use the any() function. |
| variableName | Name of the variable whose value needs to be set. | string |
SqlServerStoredProcedureActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'SqlServerStoredProcedure' |
| typeProperties | SQL stored procedure activity properties. | SqlServerStoredProcedureActivityTypeProperties (required) |
SqlServerStoredProcedureActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| storedProcedureName | Any object | For Bicep, you can use the any() function.(required) |
| storedProcedureParameters | Any object | For Bicep, you can use the any() function. |
SwitchActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Switch' |
| typeProperties | Switch activity properties. | SwitchActivityTypeProperties (required) |
SwitchActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| cases | 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. | SwitchCase[] |
| defaultActivities | 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. | Activity[] |
| on | Azure Data Factory expression definition. | Expression (required) |
SwitchCase
| Name | Description | Value |
|---|---|---|
| activities | List of activities to execute for satisfied case condition. | Activity[] |
| value | Expected value that satisfies the expression result of the 'on' property. | string |
UntilActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Until' |
| typeProperties | Until activity properties. | UntilActivityTypeProperties (required) |
UntilActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| activities | List of activities to execute. | Activity[] (required) |
| expression | Azure Data Factory expression definition. | Expression (required) |
| timeout | Any object | For Bicep, you can use the any() function. |
ValidationActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Validation' |
| typeProperties | Validation activity properties. | ValidationActivityTypeProperties (required) |
ValidationActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| childItems | Any object | For Bicep, you can use the any() function. |
| dataset | Dataset reference type. | DatasetReference (required) |
| minimumSize | Any object | For Bicep, you can use the any() function. |
| sleep | Any object | For Bicep, you can use the any() function. |
| timeout | Any object | For Bicep, you can use the any() function. |
WaitActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'Wait' |
| typeProperties | Wait activity properties. | WaitActivityTypeProperties (required) |
WaitActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| waitTimeInSeconds | Any object | For Bicep, you can use the any() function.(required) |
WebActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'WebActivity' |
| typeProperties | Web activity type properties. | WebActivityTypeProperties (required) |
WebActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Web activity authentication properties. | WebActivityAuthentication |
| body | Any object | For Bicep, you can use the any() function. |
| connectVia | Integration runtime reference type. | IntegrationRuntimeReference |
| datasets | List of datasets passed to web endpoint. | DatasetReference[] |
| disableCertValidation | When set to true, Certificate validation will be disabled. | bool |
| headers | Any object | For Bicep, you can use the any() function. |
| linkedServices | List of linked services passed to web endpoint. | LinkedServiceReference[] |
| method | The list of HTTP methods supported by a WebActivity. | 'DELETE' 'GET' 'POST' 'PUT' |
| url | Any object | For Bicep, you can use the any() function.(required) |
WebActivityAuthentication
| Name | Description | Value |
|---|---|---|
| credential | Credential reference type. | CredentialReference |
| password | The base definition of a secret type. | SecretBase |
| pfx | The base definition of a secret type. | SecretBase |
| resource | Any object | For Bicep, you can use the any() function. |
| type | Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal) | string |
| username | Any object | For Bicep, you can use the any() function. |
| userTenant | Any object | For Bicep, you can use the any() function. |
CredentialReference
| Name | Description | Value |
|---|---|---|
| referenceName | Reference credential name. | string (required) |
| type | Credential reference type. | 'CredentialReference' |
WebHookActivity
| Name | Description | Value |
|---|---|---|
| type | Type of activity. | 'WebHook' |
| typeProperties | WebHook activity type properties. | WebHookActivityTypeProperties (required) |
WebHookActivityTypeProperties
| Name | Description | Value |
|---|---|---|
| authentication | Web activity authentication properties. | WebActivityAuthentication |
| body | Any object | For Bicep, you can use the any() function. |
| headers | Any object | For Bicep, you can use the any() function. |
| method | The list of HTTP methods supported by a WebHook activity. | 'POST' |
| reportStatusOnCallBack | Any object | For Bicep, you can use the any() function. |
| timeout | 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])). | string |
| url | Any object | For Bicep, you can use the any() function.(required) |
PipelineFolder
| Name | Description | Value |
|---|---|---|
| name | The name of the folder that this Pipeline is in. | string |
PipelinePolicy
| Name | Description | Value |
|---|---|---|
| elapsedTimeMetric | Pipeline ElapsedTime Metric Policy. | PipelineElapsedTimeMetricPolicy |
PipelineElapsedTimeMetricPolicy
| Name | Description | Value |
|---|---|---|
| duration | Any object | For Bicep, you can use the any() function. |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a Data Factory, copy from Salesforce to Blob |
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs |
| Bulk copy using Azure Data Factory |
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |