Microsoft.DataFactory factories/pipelines 2017-09-01-preview

Article
03/13/2024

Bicep resource definition

The factories/pipelines resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/pipelines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2017-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
            {customized property}: any()
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    annotations: [
      any
    ]
    concurrency: int
    description: 'string'
    parameters: {
      {customized property}: {
        defaultValue: any()
        type: 'string'
      }
    }
  }
}

Activity objects

Set the type property to specify the type of object.

For AzureMLBatchExecution, use:

  type: 'AzureMLBatchExecution'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    globalParameters: {
      {customized property}: any()
    }
    webServiceInputs: {
      {customized property}: {
        filePath: any()
        linkedServiceName: {
          parameters: {
            {customized property}: any()
          }
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
      }
    }
    webServiceOutputs: {
      {customized property}: {
        filePath: any()
        linkedServiceName: {
          parameters: {
            {customized property}: any()
          }
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
      }
    }
  }

For AzureMLUpdateResource, use:

  type: 'AzureMLUpdateResource'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    trainedModelFilePath: any()
    trainedModelLinkedServiceName: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    trainedModelName: any()
  }

For Copy, use:

  type: 'Copy'
  inputs: [
    {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'DatasetReference'
    }
  ]
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  outputs: [
    {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'DatasetReference'
    }
  ]
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    cloudDataMovementUnits: any()
    enableSkipIncompatibleRow: any()
    enableStaging: any()
    parallelCopies: any()
    redirectIncompatibleRowSettings: {
      linkedServiceName: any()
      path: any()
      {customized property}: any()
    }
    sink: {
      sinkRetryCount: any()
      sinkRetryWait: any()
      writeBatchSize: any()
      writeBatchTimeout: any()
      // For remaining properties, see CopySink objects
    }
    source: {
      sourceRetryCount: any()
      sourceRetryWait: any()
      // For remaining properties, see CopySource objects
    }
    stagingSettings: {
      enableCompression: any()
      linkedServiceName: {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
      path: any()
      {customized property}: any()
    }
    translator: any()
  }

For Custom, use:

  type: 'Custom'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    command: any()
    extendedProperties: {
      {customized property}: any()
    }
    folderPath: any()
    referenceObjects: {
      datasets: [
        {
          parameters: {
            {customized property}: any()
          }
          referenceName: 'string'
          type: 'DatasetReference'
        }
      ]
      linkedServices: [
        {
          parameters: {
            {customized property}: any()
          }
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
      ]
    }
    resourceLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
  }

For DatabricksNotebook, use:

  type: 'DatabricksNotebook'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    baseParameters: {
      {customized property}: any()
    }
    notebookPath: any()
  }

For DataLakeAnalyticsU-SQL, use:

  type: 'DataLakeAnalyticsU-SQL'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    compilationMode: any()
    degreeOfParallelism: any()
    parameters: {
      {customized property}: any()
    }
    priority: any()
    runtimeVersion: any()
    scriptLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    scriptPath: any()
  }

For ExecutePipeline, use:

  type: 'ExecutePipeline'
  typeProperties: {
    parameters: {
      {customized property}: any()
    }
    pipeline: {
      name: 'string'
      referenceName: 'string'
      type: 'PipelineReference'
    }
    waitOnCompletion: bool
  }

For ExecuteSSISPackage, use:

  type: 'ExecuteSSISPackage'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    connectVia: {
      parameters: {
        {customized property}: any()
      }
      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: {
      {customized property}: {
        {customized property}: {
          value: any()
        }
      }
    }
    packageLocation: {
      packagePath: any()
      type: 'string'
      typeProperties: {
        accessCredential: {
          domain: any()
          password: {
            type: 'string'
            // For remaining properties, see SecretBase objects
          }
          userName: any()
        }
        configurationPath: any()
        packagePassword: {
          type: 'string'
          // For remaining properties, see SecretBase objects
        }
      }
    }
    packageParameters: {
      {customized property}: {
        value: any()
      }
    }
    projectConnectionManagers: {
      {customized property}: {
        {customized property}: {
          value: any()
        }
      }
    }
    projectParameters: {
      {customized property}: {
        value: any()
      }
    }
    propertyOverrides: {
      {customized property}: {
        isSensitive: bool
        value: any()
      }
    }
    runtime: any()
  }

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'
            ]
            {customized property}: any()
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    batchCount: int
    isSequential: bool
    items: {
      type: 'Expression'
      value: 'string'
    }
  }

For GetMetadata, use:

  type: 'GetMetadata'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    dataset: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'DatasetReference'
    }
    fieldList: [
      any
    ]
  }

For HDInsightHive, use:

  type: 'HDInsightHive'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    arguments: [
      any
    ]
    defines: {
      {customized property}: any()
    }
    getDebugInfo: 'string'
    scriptLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    scriptPath: any()
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
  }

For HDInsightMapReduce, use:

  type: 'HDInsightMapReduce'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    arguments: [
      any
    ]
    className: any()
    defines: {
      {customized property}: any()
    }
    getDebugInfo: 'string'
    jarFilePath: any()
    jarLibs: [
      any
    ]
    jarLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
  }

For HDInsightPig, use:

  type: 'HDInsightPig'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    arguments: [
      any
    ]
    defines: {
      {customized property}: any()
    }
    getDebugInfo: 'string'
    scriptLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    scriptPath: any()
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
  }

For HDInsightSpark, use:

  type: 'HDInsightSpark'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    arguments: [
      any
    ]
    className: 'string'
    entryFilePath: any()
    getDebugInfo: 'string'
    proxyUser: any()
    rootPath: any()
    sparkConfig: {
      {customized property}: any()
    }
    sparkJobLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
  }

For HDInsightStreaming, use:

  type: 'HDInsightStreaming'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    arguments: [
      any
    ]
    combiner: any()
    commandEnvironment: [
      any
    ]
    defines: {
      {customized property}: any()
    }
    fileLinkedService: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'LinkedServiceReference'
    }
    filePaths: [
      any
    ]
    getDebugInfo: 'string'
    input: any()
    mapper: any()
    output: any()
    reducer: any()
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
  }

For IfCondition, use:

  type: 'IfCondition'
  typeProperties: {
    expression: {
      type: 'Expression'
      value: 'string'
    }
    ifFalseActivities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
            {customized property}: any()
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    ifTrueActivities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
            {customized property}: any()
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
  }

For Lookup, use:

  type: 'Lookup'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    dataset: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'DatasetReference'
    }
    firstRowOnly: any()
    source: {
      sourceRetryCount: any()
      sourceRetryWait: any()
      // For remaining properties, see CopySource objects
    }
  }

For SqlServerStoredProcedure, use:

  type: 'SqlServerStoredProcedure'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    storedProcedureName: any()
    storedProcedureParameters: {
      {customized property}: {
        type: 'string'
        value: any()
      }
    }
  }

For Until, use:

  type: 'Until'
  typeProperties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
            {customized property}: any()
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    expression: {
      type: 'Expression'
      value: 'string'
    }
    timeout: any()
  }

For Wait, use:

  type: 'Wait'
  typeProperties: {
    waitTimeInSeconds: int
  }

For WebActivity, use:

  type: 'WebActivity'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    authentication: {
      password: {
        type: 'string'
        value: 'string'
      }
      pfx: {
        type: 'string'
        value: 'string'
      }
      resource: 'string'
      type: 'string'
      username: 'string'
    }
    body: any()
    datasets: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'DatasetReference'
      }
    ]
    disableCertValidation: bool
    headers: any()
    linkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
    method: 'string'
    url: any()
  }

CopySink objects

Set the type property to specify the type of object.

CopySource objects

Set the type property to specify the type of object.

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  type: 'AzureKeyVaultSecret'
  secretName: any()
  secretVersion: any()
  store: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }

For SecureString, use:

  type: 'SecureString'
  value: 'string'

Property values

factories/pipelines

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 1-260 Valid characters: Can't use: `<>*#.%&:\\+?/` or control characters Start 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	Properties of the 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 Constraints: Min value = 1
description	The description of the pipeline.	string
parameters	List of parameters for pipeline.	ParameterDefinitionSpecification

Activity

Name	Description	Value
dependsOn	Activity depends on condition.	ActivityDependency[]
description	Activity description.	string
name	Activity name.	string (required)
type	Set the object type	AzureMLBatchExecution AzureMLUpdateResource Copy Custom DatabricksNotebook DataLakeAnalyticsU-SQL ExecutePipeline ExecuteSSISPackage Filter ForEach GetMetadata HDInsightHive HDInsightMapReduce HDInsightPig HDInsightSpark HDInsightStreaming IfCondition Lookup SqlServerStoredProcedure Until Wait WebActivity (required)

ActivityDependency

Name	Description	Value
activity	Activity name.	string (required)
dependencyConditions	Match-Condition for the dependency.	String array containing any of: 'Completed' 'Failed' 'Skipped' 'Succeeded' (required)
{customized property}		For Bicep, you can use the any() function.

AzureMLBatchExecutionActivity

Name	Description	Value
type	Type of activity.	'AzureMLBatchExecution' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Batch Execution activity properties.	AzureMLBatchExecutionActivityTypeProperties (required)

LinkedServiceReference

Name	Description	Value
parameters	Arguments for LinkedService.	ParameterValueSpecification
referenceName	Reference LinkedService name.	string (required)
type	Linked service reference type.	'LinkedServiceReference' (required)

ParameterValueSpecification

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

ActivityPolicy

Name	Description	Value
retry	Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.	For Bicep, you can use the any() function.
retryIntervalInSeconds	Interval between each retry attempt (in seconds). The default is 30 sec.	int Constraints: Min value = 30 Max value = 86400
secureOutput	When set to true, Output from activity is considered as secure and will not be logged to monitoring.	bool
timeout	Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.
{customized property}		For Bicep, you can use the any() function.

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.	AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLWebServiceFile

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

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLUpdateResourceActivity

Name	Description	Value
type	Type of activity.	'AzureMLUpdateResource' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Update Resource management activity properties.	AzureMLUpdateResourceActivityTypeProperties (required)

AzureMLUpdateResourceActivityTypeProperties

Name	Description	Value
trainedModelFilePath	The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
trainedModelLinkedServiceName	Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.	LinkedServiceReference (required)
trainedModelName	Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

CopyActivity

Name	Description	Value
type	Type of activity.	'Copy' (required)
inputs	List of inputs for the activity.	DatasetReference[]
linkedServiceName	Linked service reference.	LinkedServiceReference
outputs	List of outputs for the activity.	DatasetReference[]
policy	Activity policy.	ActivityPolicy
typeProperties	Copy activity properties.	CopyActivityTypeProperties (required)

DatasetReference

Name	Description	Value
parameters	Arguments for dataset.	ParameterValueSpecification
referenceName	Reference dataset name.	string (required)
type	Dataset reference type.	'DatasetReference' (required)

CopyActivityTypeProperties

Name	Description	Value
cloudDataMovementUnits	Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.	For Bicep, you can use the any() function.
enableSkipIncompatibleRow	Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).	For Bicep, you can use the any() function.
enableStaging	Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).	For Bicep, you can use the any() function.
parallelCopies	Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.	For Bicep, you can use the any() function.
redirectIncompatibleRowSettings	Redirect incompatible row settings when EnableSkipIncompatibleRow is true.	RedirectIncompatibleRowSettings
sink	Copy activity sink.	CopySink (required)
source	Copy activity source.	CopySource (required)
stagingSettings	Specifies interim staging settings when EnableStaging is true.	StagingSettings
translator	Copy activity translator. If not specified, tabular translator is used.	For Bicep, you can use the any() function.

RedirectIncompatibleRowSettings

Name	Description	Value
linkedServiceName	Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
path	The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
{customized property}		For Bicep, you can use the any() function.

CopySink

Name	Description	Value
sinkRetryCount	Sink retry count. Type: integer (or Expression with resultType integer).	For Bicep, you can use the any() function.
sinkRetryWait	Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.
writeBatchSize	Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.	For Bicep, you can use the any() function.
writeBatchTimeout	Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.

CopySource

Name	Description	Value
sourceRetryCount	Source retry count. Type: integer (or Expression with resultType integer).	For Bicep, you can use the any() function.
sourceRetryWait	Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.

StagingSettings

Name	Description	Value
enableCompression	Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).	For Bicep, you can use the any() function.
linkedServiceName	Staging linked service reference.	LinkedServiceReference (required)
path	The path to storage for storing the interim data. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
{customized property}		For Bicep, you can use the any() function.

CustomActivity

Name	Description	Value
type	Type of activity.	'Custom' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Custom activity properties.	CustomActivityTypeProperties (required)

CustomActivityTypeProperties

Name	Description	Value
command	Command for custom activity Type: string (or Expression with resultType string).	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.	CustomActivityTypePropertiesExtendedProperties
folderPath	Folder path for resource files Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
referenceObjects	Reference objects	CustomActivityReferenceObject
resourceLinkedService	Resource linked service reference.	LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

Name	Description	Value
{customized property}		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' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath	The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

DatabricksNotebookActivityTypePropertiesBaseParamete...

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

DataLakeAnalyticsUsqlActivity

Name	Description	Value
type	Type of activity.	'DataLakeAnalyticsU-SQL' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Data Lake Analytics U-SQL activity properties.	DataLakeAnalyticsUsqlActivityTypeProperties (required)

DataLakeAnalyticsUsqlActivityTypeProperties

Name	Description	Value
compilationMode	Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
degreeOfParallelism	The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.	For Bicep, you can use the any() function.
parameters	Parameters for U-SQL job request.	DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority	Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.	For Bicep, you can use the any() function.
runtimeVersion	Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
scriptLinkedService	Script linked service reference.	LinkedServiceReference (required)
scriptPath	Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

ExecutePipelineActivity

Name	Description	Value
type	Type of activity.	'ExecutePipeline' (required)
typeProperties	Execute pipeline activity properties.	ExecutePipelineActivityTypeProperties (required)

ExecutePipelineActivityTypeProperties

Name	Description	Value
parameters	Pipeline parameters.	ParameterValueSpecification
pipeline	Pipeline reference.	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' (required)

ExecuteSsisPackageActivity

Name	Description	Value
type	Type of activity.	'ExecuteSSISPackage' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Execute SSIS package activity properties.	ExecuteSsisPackageActivityTypeProperties (required)

ExecuteSsisPackageActivityTypeProperties

Name	Description	Value
connectVia	The integration runtime reference.	IntegrationRuntimeReference (required)
environmentPath	The environment path to execute the SSIS package. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
executionCredential	The package execution credential.	SsisExecutionCredential
loggingLevel	The logging level of SSIS package execution. Type: string (or Expression with resultType string).	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.	ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation	SSIS package location.	SsisPackageLocation (required)
packageParameters	The package level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers	The project level connection managers to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters	The project level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides	The property overrides to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPropertyOver...
runtime	Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.

IntegrationRuntimeReference

Name	Description	Value
parameters	Arguments for integration runtime.	ParameterValueSpecification
referenceName	Reference integration runtime name.	string (required)
type	Type of integration runtime.	'IntegrationRuntimeReference' (required)

SsisExecutionCredential

Name	Description	Value
domain	Domain for windows authentication.	For Bicep, you can use the any() function.(required)
password	Password for windows authentication.	SecureString (required)
userName	UseName for windows authentication.	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	The SSIS package execution log path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
type	The type of SSIS log location.	'File' (required)
typeProperties	SSIS package execution log location properties.	SsisLogLocationTypeProperties (required)

SsisLogLocationTypeProperties

Name	Description	Value
accessCredential	The package execution log access credential.	SsisAccessCredential
logRefreshInterval	Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.

SsisAccessCredential

Name	Description	Value
domain	Domain for windows authentication.	For Bicep, you can use the any() function.(required)
password	Password for windows authentication.	SecretBase (required)
userName	UseName for windows authentication.	For Bicep, you can use the any() function.(required)

SecretBase

Name	Description	Value
type	Set the object type	AzureKeyVaultSecret SecureString (required)

AzureKeyVaultSecretReference

Name	Description	Value
type	Type of the secret.	'AzureKeyVaultSecret' (required)
secretName	The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
secretVersion	The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
store	The Azure Key Vault linked service reference.	LinkedServiceReference (required)

ExecuteSsisPackageActivityTypePropertiesPackageConne...

Name	Description	Value
{customized property}		SsisConnectionManager

SsisConnectionManager

Name	Description	Value
{customized property}		SsisExecutionParameter

SsisExecutionParameter

Name	Description	Value
value	SSIS package execution parameter value. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

SsisPackageLocation

Name	Description	Value
packagePath	The SSIS package path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
type	The type of SSIS package location.	'File' 'SSISDB'
typeProperties	SSIS package location properties.	SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

Name	Description	Value
accessCredential	The package access credential.	SsisAccessCredential
configurationPath	The configuration file of the package execution. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
packagePassword	Password of the package.	SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

Name	Description	Value
{customized property}		SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

Name	Description	Value
{customized property}		SsisPropertyOverride

SsisPropertyOverride

Name	Description	Value
isSensitive	Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true	bool
value	SSIS package property override value. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

FilterActivity

Name	Description	Value
type	Type of activity.	'Filter' (required)
typeProperties	Filter activity properties.	FilterActivityTypeProperties (required)

FilterActivityTypeProperties

Name	Description	Value
condition	Condition to be used for filtering the input.	Expression (required)
items	Input array on which filter should be applied.	Expression (required)

Expression

Name	Description	Value
type	Expression type.	'Expression' (required)
value	Expression value.	string (required)

ForEachActivity

Name	Description	Value
type	Type of activity.	'ForEach' (required)
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 Constraints: Max value = 50
isSequential	Should the loop be executed in sequence or in parallel (max 50)	bool
items	Collection to iterate.	Expression (required)

GetMetadataActivity

Name	Description	Value
type	Type of activity.	'GetMetadata' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	GetMetadata activity properties.	GetMetadataActivityTypeProperties (required)

GetMetadataActivityTypeProperties

Name	Description	Value
dataset	GetMetadata activity dataset reference.	DatasetReference (required)
fieldList	Fields of metadata to get from dataset.	any[]

HDInsightHiveActivity

Name	Description	Value
type	Type of activity.	'HDInsightHive' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	HDInsightHiveActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

HDInsightMapReduceActivity

Name	Description	Value
type	Type of activity.	'HDInsightMapReduce' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight MapReduce activity properties.	HDInsightMapReduceActivityTypeProperties (required)

HDInsightMapReduceActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
className	Class name. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
defines	Allows user to specify defines for the MapReduce job request.	HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
jarFilePath	Jar path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
jarLibs	Jar libs.	any[]
jarLinkedService	Jar linked service reference.	LinkedServiceReference
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

HDInsightPigActivity

Name	Description	Value
type	Type of activity.	'HDInsightPig' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight Pig activity properties.	HDInsightPigActivityTypeProperties (required)

HDInsightPigActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
defines	Allows user to specify defines for Pig job request.	HDInsightPigActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

HDInsightSparkActivity

Name	Description	Value
type	Type of activity.	'HDInsightSpark' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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	The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
proxyUser	The user to impersonate that will execute the job. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
rootPath	The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
sparkConfig	Spark configuration property.	HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService	The storage linked service for uploading the entry file and dependencies, and for receiving logs.	LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

HDInsightStreamingActivity

Name	Description	Value
type	Type of activity.	'HDInsightStreaming' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight streaming activity properties.	HDInsightStreamingActivityTypeProperties (required)

HDInsightStreamingActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
combiner	Combiner executable name. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
commandEnvironment	Command line environment values.	any[]
defines	Allows user to specify defines for streaming job request.	HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService	Linked service reference where the files are located.	LinkedServiceReference
filePaths	Paths to streaming job files. Can be directories.	any[] (required)
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
input	Input blob path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
mapper	Mapper executable name. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
output	Output blob path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
reducer	Reducer executable name. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

Name	Description	Value
{customized property}		For Bicep, you can use the any() function.

IfConditionActivity

Name	Description	Value
type	Type of activity.	'IfCondition' (required)
typeProperties	IfCondition activity properties.	IfConditionActivityTypeProperties (required)

IfConditionActivityTypeProperties

Name	Description	Value
expression	An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.	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' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Lookup activity properties.	LookupActivityTypeProperties (required)

LookupActivityTypeProperties

Name	Description	Value
dataset	Lookup activity dataset reference.	DatasetReference (required)
firstRowOnly	Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).	For Bicep, you can use the any() function.
source	Dataset-specific source properties, same as copy activity source.	CopySource (required)

SqlServerStoredProcedureActivity

Name	Description	Value
type	Type of activity.	'SqlServerStoredProcedure' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	SQL stored procedure activity properties.	SqlServerStoredProcedureActivityTypeProperties (required)

SqlServerStoredProcedureActivityTypeProperties

Name	Description	Value
storedProcedureName	Stored procedure name. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)
storedProcedureParameters	Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".	SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

Name	Description	Value
{customized property}		StoredProcedureParameter

StoredProcedureParameter

Name	Description	Value
type	Stored procedure parameter type.	'Boolean' 'Date' 'Decimal' 'Guid' 'Int' 'Int64' 'String'
value	Stored procedure parameter value. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

UntilActivity

Name	Description	Value
type	Type of activity.	'Until' (required)
typeProperties	Until activity properties.	UntilActivityTypeProperties (required)

UntilActivityTypeProperties

Name	Description	Value
activities	List of activities to execute.	Activity[] (required)
expression	An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true	Expression (required)
timeout	Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).	For Bicep, you can use the any() function.

WaitActivity

Name	Description	Value
type	Type of activity.	'Wait' (required)
typeProperties	Wait activity properties.	WaitActivityTypeProperties (required)

WaitActivityTypeProperties

Name	Description	Value
waitTimeInSeconds	Duration in seconds.	int (required)

WebActivity

Name	Description	Value
type	Type of activity.	'WebActivity' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Web activity properties.	WebActivityTypeProperties (required)

WebActivityTypeProperties

Name	Description	Value
authentication	Authentication method used for calling the endpoint.	WebActivityAuthentication
body	Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
datasets	List of datasets passed to web endpoint.	DatasetReference[]
disableCertValidation	When set to true, Certificate validation will be disabled.	bool
headers	Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.
linkedServices	List of linked services passed to web endpoint.	LinkedServiceReference[]
method	Rest API method for target endpoint.	'DELETE' 'GET' 'POST' 'PUT' (required)
url	Web activity target endpoint and path. Type: string (or Expression with resultType string).	For Bicep, you can use the any() function.(required)

WebActivityAuthentication

Name	Description	Value
password	Password for the PFX file or basic authentication.	SecureString
pfx	Base64-encoded contents of a PFX file.	SecureString
resource	Resource for which Azure Auth token will be requested when using MSI Authentication.	string
type	Web activity authentication (Basic/ClientCertificate/MSI)	string (required)
username	Web activity authentication user name for basic authentication.	string

ParameterDefinitionSpecification

Name	Description	Value
{customized property}		ParameterSpecification

ParameterSpecification

Name	Description	Value
defaultValue	Default value of parameter.	For Bicep, you can use the any() function.
type	Parameter type.	'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
More is possible with Azure Data Factory - One click to try Azure Data Factory	This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
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 (MySQL)	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 (PostGre)	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 (SQL)	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 (SQL On-prem)	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 (Spark)	This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.

ARM template resource definition

The factories/pipelines resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/pipelines resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/pipelines",
  "apiVersion": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "activities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "annotations": [ object ],
    "concurrency": "int",
    "description": "string",
    "parameters": {
      "{customized property}": {
        "defaultValue": {},
        "type": "string"
      }
    }
  }
}

Activity objects

Set the type property to specify the type of object.

For AzureMLBatchExecution, use:

  "type": "AzureMLBatchExecution",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "globalParameters": {
      "{customized property}": {}
    },
    "webServiceInputs": {
      "{customized property}": {
        "filePath": {},
        "linkedServiceName": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      }
    },
    "webServiceOutputs": {
      "{customized property}": {
        "filePath": {},
        "linkedServiceName": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      }
    }
  }

For AzureMLUpdateResource, use:

  "type": "AzureMLUpdateResource",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "trainedModelFilePath": {},
    "trainedModelLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "trainedModelName": {}
  }

For Copy, use:

  "type": "Copy",
  "inputs": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "DatasetReference"
    }
  ],
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "outputs": [
    {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "DatasetReference"
    }
  ],
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "cloudDataMovementUnits": {},
    "enableSkipIncompatibleRow": {},
    "enableStaging": {},
    "parallelCopies": {},
    "redirectIncompatibleRowSettings": {
      "linkedServiceName": {},
      "path": {},
      "{customized property}": {}
    },
    "sink": {
      "sinkRetryCount": {},
      "sinkRetryWait": {},
      "writeBatchSize": {},
      "writeBatchTimeout": {}
      // For remaining properties, see CopySink objects
    },
    "source": {
      "sourceRetryCount": {},
      "sourceRetryWait": {}
      // For remaining properties, see CopySource objects
    },
    "stagingSettings": {
      "enableCompression": {},
      "linkedServiceName": {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      },
      "path": {},
      "{customized property}": {}
    },
    "translator": {}
  }

For Custom, use:

  "type": "Custom",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "command": {},
    "extendedProperties": {
      "{customized property}": {}
    },
    "folderPath": {},
    "referenceObjects": {
      "datasets": [
        {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "DatasetReference"
        }
      ],
      "linkedServices": [
        {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      ]
    },
    "resourceLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    }
  }

For DatabricksNotebook, use:

  "type": "DatabricksNotebook",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "baseParameters": {
      "{customized property}": {}
    },
    "notebookPath": {}
  }

For DataLakeAnalyticsU-SQL, use:

  "type": "DataLakeAnalyticsU-SQL",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "compilationMode": {},
    "degreeOfParallelism": {},
    "parameters": {
      "{customized property}": {}
    },
    "priority": {},
    "runtimeVersion": {},
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {}
  }

For ExecutePipeline, use:

  "type": "ExecutePipeline",
  "typeProperties": {
    "parameters": {
      "{customized property}": {}
    },
    "pipeline": {
      "name": "string",
      "referenceName": "string",
      "type": "PipelineReference"
    },
    "waitOnCompletion": "bool"
  }

For ExecuteSSISPackage, use:

  "type": "ExecuteSSISPackage",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "connectVia": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "IntegrationRuntimeReference"
    },
    "environmentPath": {},
    "executionCredential": {
      "domain": {},
      "password": {
        "type": "string",
        "value": "string"
      },
      "userName": {}
    },
    "loggingLevel": {},
    "logLocation": {
      "logPath": {},
      "type": "File",
      "typeProperties": {
        "accessCredential": {
          "domain": {},
          "password": {
            "type": "string"
            // For remaining properties, see SecretBase objects
          },
          "userName": {}
        },
        "logRefreshInterval": {}
      }
    },
    "packageConnectionManagers": {
      "{customized property}": {
        "{customized property}": {
          "value": {}
        }
      }
    },
    "packageLocation": {
      "packagePath": {},
      "type": "string",
      "typeProperties": {
        "accessCredential": {
          "domain": {},
          "password": {
            "type": "string"
            // For remaining properties, see SecretBase objects
          },
          "userName": {}
        },
        "configurationPath": {},
        "packagePassword": {
          "type": "string"
          // For remaining properties, see SecretBase objects
        }
      }
    },
    "packageParameters": {
      "{customized property}": {
        "value": {}
      }
    },
    "projectConnectionManagers": {
      "{customized property}": {
        "{customized property}": {
          "value": {}
        }
      }
    },
    "projectParameters": {
      "{customized property}": {
        "value": {}
      }
    },
    "propertyOverrides": {
      "{customized property}": {
        "isSensitive": "bool",
        "value": {}
      }
    },
    "runtime": {}
  }

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" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "batchCount": "int",
    "isSequential": "bool",
    "items": {
      "type": "Expression",
      "value": "string"
    }
  }

For GetMetadata, use:

  "type": "GetMetadata",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "dataset": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "DatasetReference"
    },
    "fieldList": [ object ]
  }

For HDInsightHive, use:

  "type": "HDInsightHive",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

For HDInsightMapReduce, use:

  "type": "HDInsightMapReduce",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "className": {},
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "jarFilePath": {},
    "jarLibs": [ object ],
    "jarLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

For HDInsightPig, use:

  "type": "HDInsightPig",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

For HDInsightSpark, use:

  "type": "HDInsightSpark",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "className": "string",
    "entryFilePath": {},
    "getDebugInfo": "string",
    "proxyUser": {},
    "rootPath": {},
    "sparkConfig": {
      "{customized property}": {}
    },
    "sparkJobLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    }
  }

For HDInsightStreaming, use:

  "type": "HDInsightStreaming",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "combiner": {},
    "commandEnvironment": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "fileLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "filePaths": [ object ],
    "getDebugInfo": "string",
    "input": {},
    "mapper": {},
    "output": {},
    "reducer": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

For IfCondition, use:

  "type": "IfCondition",
  "typeProperties": {
    "expression": {
      "type": "Expression",
      "value": "string"
    },
    "ifFalseActivities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "ifTrueActivities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ]
  }

For Lookup, use:

  "type": "Lookup",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "dataset": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "DatasetReference"
    },
    "firstRowOnly": {},
    "source": {
      "sourceRetryCount": {},
      "sourceRetryWait": {}
      // For remaining properties, see CopySource objects
    }
  }

For SqlServerStoredProcedure, use:

  "type": "SqlServerStoredProcedure",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "storedProcedureName": {},
    "storedProcedureParameters": {
      "{customized property}": {
        "type": "string",
        "value": {}
      }
    }
  }

For Until, use:

  "type": "Until",
  "typeProperties": {
    "activities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "expression": {
      "type": "Expression",
      "value": "string"
    },
    "timeout": {}
  }

For Wait, use:

  "type": "Wait",
  "typeProperties": {
    "waitTimeInSeconds": "int"
  }

For WebActivity, use:

  "type": "WebActivity",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "authentication": {
      "password": {
        "type": "string",
        "value": "string"
      },
      "pfx": {
        "type": "string",
        "value": "string"
      },
      "resource": "string",
      "type": "string",
      "username": "string"
    },
    "body": {},
    "datasets": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "DatasetReference"
      }
    ],
    "disableCertValidation": "bool",
    "headers": {},
    "linkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ],
    "method": "string",
    "url": {}
  }

CopySink objects

Set the type property to specify the type of object.

CopySource objects

Set the type property to specify the type of object.

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  "type": "AzureKeyVaultSecret",
  "secretName": {},
  "secretVersion": {},
  "store": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  }

For SecureString, use:

  "type": "SecureString",
  "value": "string"

Property values

factories/pipelines

Name	Description	Value
type	The resource type	'Microsoft.DataFactory/factories/pipelines'
apiVersion	The resource api version	'2017-09-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required) Character limit: 1-260 Valid characters: Can't use: `<>*#.%&:\\+?/` or control characters Start with alphanumeric.
properties	Properties of the 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 Constraints: Min value = 1
description	The description of the pipeline.	string
parameters	List of parameters for pipeline.	ParameterDefinitionSpecification

Activity

Name	Description	Value
dependsOn	Activity depends on condition.	ActivityDependency[]
description	Activity description.	string
name	Activity name.	string (required)
type	Set the object type	AzureMLBatchExecution AzureMLUpdateResource Copy Custom DatabricksNotebook DataLakeAnalyticsU-SQL ExecutePipeline ExecuteSSISPackage Filter ForEach GetMetadata HDInsightHive HDInsightMapReduce HDInsightPig HDInsightSpark HDInsightStreaming IfCondition Lookup SqlServerStoredProcedure Until Wait WebActivity (required)

ActivityDependency

Name	Description	Value
activity	Activity name.	string (required)
dependencyConditions	Match-Condition for the dependency.	String array containing any of: 'Completed' 'Failed' 'Skipped' 'Succeeded' (required)
{customized property}

AzureMLBatchExecutionActivity

Name	Description	Value
type	Type of activity.	'AzureMLBatchExecution' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Batch Execution activity properties.	AzureMLBatchExecutionActivityTypeProperties (required)

LinkedServiceReference

Name	Description	Value
parameters	Arguments for LinkedService.	ParameterValueSpecification
referenceName	Reference LinkedService name.	string (required)
type	Linked service reference type.	'LinkedServiceReference' (required)

ParameterValueSpecification

Name	Description	Value
{customized property}

ActivityPolicy

Name	Description	Value
retry	Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.
retryIntervalInSeconds	Interval between each retry attempt (in seconds). The default is 30 sec.	int Constraints: Min value = 30 Max value = 86400
secureOutput	When set to true, Output from activity is considered as secure and will not be logged to monitoring.	bool
timeout	Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).
{customized property}

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.	AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

Name	Description	Value
{customized property}

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLWebServiceFile

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

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLUpdateResourceActivity

Name	Description	Value
type	Type of activity.	'AzureMLUpdateResource' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Update Resource management activity properties.	AzureMLUpdateResourceActivityTypeProperties (required)

AzureMLUpdateResourceActivityTypeProperties

Name	Description	Value
trainedModelFilePath	The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).
trainedModelLinkedServiceName	Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.	LinkedServiceReference (required)
trainedModelName	Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).

CopyActivity

Name	Description	Value
type	Type of activity.	'Copy' (required)
inputs	List of inputs for the activity.	DatasetReference[]
linkedServiceName	Linked service reference.	LinkedServiceReference
outputs	List of outputs for the activity.	DatasetReference[]
policy	Activity policy.	ActivityPolicy
typeProperties	Copy activity properties.	CopyActivityTypeProperties (required)

DatasetReference

Name	Description	Value
parameters	Arguments for dataset.	ParameterValueSpecification
referenceName	Reference dataset name.	string (required)
type	Dataset reference type.	'DatasetReference' (required)

CopyActivityTypeProperties

Name	Description	Value
cloudDataMovementUnits	Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
enableSkipIncompatibleRow	Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
enableStaging	Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
parallelCopies	Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.
redirectIncompatibleRowSettings	Redirect incompatible row settings when EnableSkipIncompatibleRow is true.	RedirectIncompatibleRowSettings
sink	Copy activity sink.	CopySink (required)
source	Copy activity source.	CopySource (required)
stagingSettings	Specifies interim staging settings when EnableStaging is true.	StagingSettings
translator	Copy activity translator. If not specified, tabular translator is used.

RedirectIncompatibleRowSettings

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

CopySink

Name	Description	Value
sinkRetryCount	Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait	Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).
writeBatchSize	Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout	Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

CopySource

Name	Description	Value
sourceRetryCount	Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait	Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

StagingSettings

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

CustomActivity

Name	Description	Value
type	Type of activity.	'Custom' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Custom activity properties.	CustomActivityTypeProperties (required)

CustomActivityTypeProperties

Name	Description	Value
command	Command for custom activity Type: string (or Expression with resultType string).
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.	CustomActivityTypePropertiesExtendedProperties
folderPath	Folder path for resource files Type: string (or Expression with resultType string).
referenceObjects	Reference objects	CustomActivityReferenceObject
resourceLinkedService	Resource linked service reference.	LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

Name	Description	Value
{customized property}

CustomActivityReferenceObject

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

DatabricksNotebookActivity

Name	Description	Value
type	Type of activity.	'DatabricksNotebook' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath	The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

DatabricksNotebookActivityTypePropertiesBaseParamete...

Name	Description	Value
{customized property}

DataLakeAnalyticsUsqlActivity

Name	Description	Value
type	Type of activity.	'DataLakeAnalyticsU-SQL' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Data Lake Analytics U-SQL activity properties.	DataLakeAnalyticsUsqlActivityTypeProperties (required)

DataLakeAnalyticsUsqlActivityTypeProperties

Name	Description	Value
compilationMode	Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).
degreeOfParallelism	The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.
parameters	Parameters for U-SQL job request.	DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority	Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.
runtimeVersion	Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).
scriptLinkedService	Script linked service reference.	LinkedServiceReference (required)
scriptPath	Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

Name	Description	Value
{customized property}

ExecutePipelineActivity

Name	Description	Value
type	Type of activity.	'ExecutePipeline' (required)
typeProperties	Execute pipeline activity properties.	ExecutePipelineActivityTypeProperties (required)

ExecutePipelineActivityTypeProperties

Name	Description	Value
parameters	Pipeline parameters.	ParameterValueSpecification
pipeline	Pipeline reference.	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' (required)

ExecuteSsisPackageActivity

Name	Description	Value
type	Type of activity.	'ExecuteSSISPackage' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Execute SSIS package activity properties.	ExecuteSsisPackageActivityTypeProperties (required)

ExecuteSsisPackageActivityTypeProperties

Name	Description	Value
connectVia	The integration runtime reference.	IntegrationRuntimeReference (required)
environmentPath	The environment path to execute the SSIS package. Type: string (or Expression with resultType string).
executionCredential	The package execution credential.	SsisExecutionCredential
loggingLevel	The logging level of SSIS package execution. Type: string (or Expression with resultType string).
logLocation	SSIS package execution log location.	SsisLogLocation
packageConnectionManagers	The package level connection managers to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation	SSIS package location.	SsisPackageLocation (required)
packageParameters	The package level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers	The project level connection managers to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters	The project level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides	The property overrides to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPropertyOver...
runtime	Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).

IntegrationRuntimeReference

Name	Description	Value
parameters	Arguments for integration runtime.	ParameterValueSpecification
referenceName	Reference integration runtime name.	string (required)
type	Type of integration runtime.	'IntegrationRuntimeReference' (required)

SsisExecutionCredential

Name	Description	Value
domain	Domain for windows authentication.
password	Password for windows authentication.	SecureString (required)
userName	UseName for windows authentication.

SecureString

Name	Description	Value
type	Type of the secret.	string (required)
value	Value of secure string.	string (required)

SsisLogLocation

Name	Description	Value
logPath	The SSIS package execution log path. Type: string (or Expression with resultType string).
type	The type of SSIS log location.	'File' (required)
typeProperties	SSIS package execution log location properties.	SsisLogLocationTypeProperties (required)

SsisLogLocationTypeProperties

Name	Description	Value
accessCredential	The package execution log access credential.	SsisAccessCredential
logRefreshInterval	Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

SsisAccessCredential

Name	Description	Value
domain	Domain for windows authentication.
password	Password for windows authentication.	SecretBase (required)
userName	UseName for windows authentication.

SecretBase

Name	Description	Value
type	Set the object type	AzureKeyVaultSecret SecureString (required)

AzureKeyVaultSecretReference

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

ExecuteSsisPackageActivityTypePropertiesPackageConne...

Name	Description	Value
{customized property}		SsisConnectionManager

SsisConnectionManager

Name	Description	Value
{customized property}		SsisExecutionParameter

SsisExecutionParameter

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

SsisPackageLocation

Name	Description	Value
packagePath	The SSIS package path. Type: string (or Expression with resultType string).
type	The type of SSIS package location.	'File' 'SSISDB'
typeProperties	SSIS package location properties.	SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

Name	Description	Value
accessCredential	The package access credential.	SsisAccessCredential
configurationPath	The configuration file of the package execution. Type: string (or Expression with resultType string).
packagePassword	Password of the package.	SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

Name	Description	Value
{customized property}		SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

Name	Description	Value
{customized property}		SsisPropertyOverride

SsisPropertyOverride

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

FilterActivity

Name	Description	Value
type	Type of activity.	'Filter' (required)
typeProperties	Filter activity properties.	FilterActivityTypeProperties (required)

FilterActivityTypeProperties

Name	Description	Value
condition	Condition to be used for filtering the input.	Expression (required)
items	Input array on which filter should be applied.	Expression (required)

Expression

Name	Description	Value
type	Expression type.	'Expression' (required)
value	Expression value.	string (required)

ForEachActivity

Name	Description	Value
type	Type of activity.	'ForEach' (required)
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 Constraints: Max value = 50
isSequential	Should the loop be executed in sequence or in parallel (max 50)	bool
items	Collection to iterate.	Expression (required)

GetMetadataActivity

Name	Description	Value
type	Type of activity.	'GetMetadata' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	GetMetadata activity properties.	GetMetadataActivityTypeProperties (required)

GetMetadataActivityTypeProperties

Name	Description	Value
dataset	GetMetadata activity dataset reference.	DatasetReference (required)
fieldList	Fields of metadata to get from dataset.	any[]

HDInsightHiveActivity

Name	Description	Value
type	Type of activity.	'HDInsightHive' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	HDInsightHiveActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightMapReduceActivity

Name	Description	Value
type	Type of activity.	'HDInsightMapReduce' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight MapReduce activity properties.	HDInsightMapReduceActivityTypeProperties (required)

HDInsightMapReduceActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
className	Class name. Type: string (or Expression with resultType string).
defines	Allows user to specify defines for the MapReduce job request.	HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
jarFilePath	Jar path. Type: string (or Expression with resultType string).
jarLibs	Jar libs.	any[]
jarLinkedService	Jar linked service reference.	LinkedServiceReference
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightPigActivity

Name	Description	Value
type	Type of activity.	'HDInsightPig' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight Pig activity properties.	HDInsightPigActivityTypeProperties (required)

HDInsightPigActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
defines	Allows user to specify defines for Pig job request.	HDInsightPigActivityTypePropertiesDefines
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightSparkActivity

Name	Description	Value
type	Type of activity.	'HDInsightSpark' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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	The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
proxyUser	The user to impersonate that will execute the job. Type: string (or Expression with resultType string).
rootPath	The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).
sparkConfig	Spark configuration property.	HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService	The storage linked service for uploading the entry file and dependencies, and for receiving logs.	LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

Name	Description	Value
{customized property}

HDInsightStreamingActivity

Name	Description	Value
type	Type of activity.	'HDInsightStreaming' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight streaming activity properties.	HDInsightStreamingActivityTypeProperties (required)

HDInsightStreamingActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
combiner	Combiner executable name. Type: string (or Expression with resultType string).
commandEnvironment	Command line environment values.	any[]
defines	Allows user to specify defines for streaming job request.	HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService	Linked service reference where the files are located.	LinkedServiceReference
filePaths	Paths to streaming job files. Can be directories.	any[] (required)
getDebugInfo	Debug info option.	'Always' 'Failure' 'None'
input	Input blob path. Type: string (or Expression with resultType string).
mapper	Mapper executable name. Type: string (or Expression with resultType string).
output	Output blob path. Type: string (or Expression with resultType string).
reducer	Reducer executable name. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

Name	Description	Value
{customized property}

IfConditionActivity

Name	Description	Value
type	Type of activity.	'IfCondition' (required)
typeProperties	IfCondition activity properties.	IfConditionActivityTypeProperties (required)

IfConditionActivityTypeProperties

Name	Description	Value
expression	An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.	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' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Lookup activity properties.	LookupActivityTypeProperties (required)

LookupActivityTypeProperties

Name	Description	Value
dataset	Lookup activity dataset reference.	DatasetReference (required)
firstRowOnly	Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).
source	Dataset-specific source properties, same as copy activity source.	CopySource (required)

SqlServerStoredProcedureActivity

Name	Description	Value
type	Type of activity.	'SqlServerStoredProcedure' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	SQL stored procedure activity properties.	SqlServerStoredProcedureActivityTypeProperties (required)

SqlServerStoredProcedureActivityTypeProperties

Name	Description	Value
storedProcedureName	Stored procedure name. Type: string (or Expression with resultType string).
storedProcedureParameters	Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".	SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

Name	Description	Value
{customized property}		StoredProcedureParameter

StoredProcedureParameter

Name	Description	Value
type	Stored procedure parameter type.	'Boolean' 'Date' 'Decimal' 'Guid' 'Int' 'Int64' 'String'
value	Stored procedure parameter value. Type: string (or Expression with resultType string).

UntilActivity

Name	Description	Value
type	Type of activity.	'Until' (required)
typeProperties	Until activity properties.	UntilActivityTypeProperties (required)

UntilActivityTypeProperties

Name	Description	Value
activities	List of activities to execute.	Activity[] (required)
expression	An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true	Expression (required)
timeout	Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

WaitActivity

Name	Description	Value
type	Type of activity.	'Wait' (required)
typeProperties	Wait activity properties.	WaitActivityTypeProperties (required)

WaitActivityTypeProperties

Name	Description	Value
waitTimeInSeconds	Duration in seconds.	int (required)

WebActivity

Name	Description	Value
type	Type of activity.	'WebActivity' (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Web activity properties.	WebActivityTypeProperties (required)

WebActivityTypeProperties

Name	Description	Value
authentication	Authentication method used for calling the endpoint.	WebActivityAuthentication
body	Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
datasets	List of datasets passed to web endpoint.	DatasetReference[]
disableCertValidation	When set to true, Certificate validation will be disabled.	bool
headers	Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
linkedServices	List of linked services passed to web endpoint.	LinkedServiceReference[]
method	Rest API method for target endpoint.	'DELETE' 'GET' 'POST' 'PUT' (required)
url	Web activity target endpoint and path. Type: string (or Expression with resultType string).

WebActivityAuthentication

Name	Description	Value
password	Password for the PFX file or basic authentication.	SecureString
pfx	Base64-encoded contents of a PFX file.	SecureString
resource	Resource for which Azure Auth token will be requested when using MSI Authentication.	string
type	Web activity authentication (Basic/ClientCertificate/MSI)	string (required)
username	Web activity authentication user name for basic authentication.	string

ParameterDefinitionSpecification

Name	Description	Value
{customized property}		ParameterSpecification

ParameterSpecification

Name	Description	Value
defaultValue	Default value of parameter.
type	Parameter type.	'Array' 'Bool' 'Float' 'Int' 'Object' 'SecureString' 'String' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
More is possible with Azure Data Factory - One click to try Azure Data Factory	This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
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 (MySQL)	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 (PostGre)	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 (SQL)	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 (SQL On-prem)	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 (Spark)	This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.

Terraform (AzAPI provider) resource definition

The factories/pipelines resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataFactory/factories/pipelines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/pipelines@2017-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      activities = [
        {
          dependsOn = [
            {
              activity = "string"
              dependencyConditions = [
                "string"
              ]
            }
          ]
          description = "string"
          name = "string"
          type = "string"
          // For remaining properties, see Activity objects
        }
      ]
      annotations = [ object ]
      concurrency = int
      description = "string"
      parameters = {
        {customized property} = {
          type = "string"
        }
      }
    }
  })
}

Activity objects

Set the type property to specify the type of object.

For AzureMLBatchExecution, use:

  type = "AzureMLBatchExecution"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    globalParameters = {}
    webServiceInputs = {
      {customized property} = {
        linkedServiceName = {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      }
    }
    webServiceOutputs = {
      {customized property} = {
        linkedServiceName = {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      }
    }
  }

For AzureMLUpdateResource, use:

  type = "AzureMLUpdateResource"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    trainedModelLinkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

For Copy, use:

  type = "Copy"
  inputs = [
    {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
  ]
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  outputs = [
    {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
  ]
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    redirectIncompatibleRowSettings = {}
    sink = {
      // For remaining properties, see CopySink objects
    }
    source = {
      // For remaining properties, see CopySource objects
    }
    stagingSettings = {
      linkedServiceName = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    }
  }

For Custom, use:

  type = "Custom"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    extendedProperties = {}
    referenceObjects = {
      datasets = [
        {
          parameters = {}
          referenceName = "string"
          type = "DatasetReference"
        }
      ]
      linkedServices = [
        {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      ]
    }
    resourceLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

For DatabricksNotebook, use:

  type = "DatabricksNotebook"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    baseParameters = {}
  }

For DataLakeAnalyticsU-SQL, use:

  type = "DataLakeAnalyticsU-SQL"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    parameters = {}
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

For ExecutePipeline, use:

  type = "ExecutePipeline"
  typeProperties = {
    parameters = {}
    pipeline = {
      name = "string"
      referenceName = "string"
      type = "PipelineReference"
    }
    waitOnCompletion = bool
  }

For ExecuteSSISPackage, use:

  type = "ExecuteSSISPackage"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    connectVia = {
      parameters = {}
      referenceName = "string"
      type = "IntegrationRuntimeReference"
    }
    executionCredential = {
      password = {
        type = "string"
        value = "string"
      }
    }
    logLocation = {
      type = "File"
      typeProperties = {
        accessCredential = {
          password = {
            type = "string"
            // For remaining properties, see SecretBase objects
          }
        }
      }
    }
    packageConnectionManagers = {
      {customized property} = {
        {customized property} = {}
      }
    }
    packageLocation = {
      type = "string"
      typeProperties = {
        accessCredential = {
          password = {
            type = "string"
            // For remaining properties, see SecretBase objects
          }
        }
        packagePassword = {
          type = "string"
          // For remaining properties, see SecretBase objects
        }
      }
    }
    packageParameters = {
      {customized property} = {}
    }
    projectConnectionManagers = {
      {customized property} = {
        {customized property} = {}
      }
    }
    projectParameters = {
      {customized property} = {}
    }
    propertyOverrides = {
      {customized property} = {
        isSensitive = bool
      }
    }
  }

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"
        type = "string"
        // For remaining properties, see Activity objects
      }
    ]
    batchCount = int
    isSequential = bool
    items = {
      type = "Expression"
      value = "string"
    }
  }

For GetMetadata, use:

  type = "GetMetadata"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    dataset = {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
    fieldList = [ object ]
  }

For HDInsightHive, use:

  type = "HDInsightHive"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

For HDInsightMapReduce, use:

  type = "HDInsightMapReduce"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    jarLibs = [ object ]
    jarLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

For HDInsightPig, use:

  type = "HDInsightPig"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

For HDInsightSpark, use:

  type = "HDInsightSpark"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    className = "string"
    getDebugInfo = "string"
    sparkConfig = {}
    sparkJobLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

For HDInsightStreaming, use:

  type = "HDInsightStreaming"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    commandEnvironment = [ object ]
    defines = {}
    fileLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    filePaths = [ object ]
    getDebugInfo = "string"
    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"
        type = "string"
        // For remaining properties, see Activity objects
      }
    ]
    ifTrueActivities = [
      {
        dependsOn = [
          {
            activity = "string"
            dependencyConditions = [
              "string"
            ]
          }
        ]
        description = "string"
        name = "string"
        type = "string"
        // For remaining properties, see Activity objects
      }
    ]
  }

For Lookup, use:

  type = "Lookup"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    dataset = {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
    source = {
      // For remaining properties, see CopySource objects
    }
  }

For SqlServerStoredProcedure, use:

  type = "SqlServerStoredProcedure"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    storedProcedureParameters = {
      {customized property} = {
        type = "string"
      }
    }
  }

For Until, use:

  type = "Until"
  typeProperties = {
    activities = [
      {
        dependsOn = [
          {
            activity = "string"
            dependencyConditions = [
              "string"
            ]
          }
        ]
        description = "string"
        name = "string"
        type = "string"
        // For remaining properties, see Activity objects
      }
    ]
    expression = {
      type = "Expression"
      value = "string"
    }
  }

For Wait, use:

  type = "Wait"
  typeProperties = {
    waitTimeInSeconds = int
  }

For WebActivity, use:

  type = "WebActivity"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    authentication = {
      password = {
        type = "string"
        value = "string"
      }
      pfx = {
        type = "string"
        value = "string"
      }
      resource = "string"
      type = "string"
      username = "string"
    }
    datasets = [
      {
        parameters = {}
        referenceName = "string"
        type = "DatasetReference"
      }
    ]
    disableCertValidation = bool
    linkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
    method = "string"
  }

CopySink objects

Set the type property to specify the type of object.

CopySource objects

Set the type property to specify the type of object.

SecretBase objects

Set the type property to specify the type of object.

For AzureKeyVaultSecret, use:

  type = "AzureKeyVaultSecret"
  store = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }

For SecureString, use:

  type = "SecureString"
  value = "string"

Property values

factories/pipelines

Name	Description	Value
type	The resource type	"Microsoft.DataFactory/factories/pipelines@2017-09-01-preview"
name	The resource name	string (required) Character limit: 1-260 Valid characters: Can't use: `<>*#.%&:\\+?/` or control characters Start with alphanumeric.
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: factories
properties	Properties of the 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 Constraints: Min value = 1
description	The description of the pipeline.	string
parameters	List of parameters for pipeline.	ParameterDefinitionSpecification

Activity

Name	Description	Value
dependsOn	Activity depends on condition.	ActivityDependency[]
description	Activity description.	string
name	Activity name.	string (required)
type	Set the object type	AzureMLBatchExecution AzureMLUpdateResource Copy Custom DatabricksNotebook DataLakeAnalyticsU-SQL ExecutePipeline ExecuteSSISPackage Filter ForEach GetMetadata HDInsightHive HDInsightMapReduce HDInsightPig HDInsightSpark HDInsightStreaming IfCondition Lookup SqlServerStoredProcedure Until Wait WebActivity (required)

ActivityDependency

Name	Description	Value
activity	Activity name.	string (required)
dependencyConditions	Match-Condition for the dependency.	String array containing any of: "Completed" "Failed" "Skipped" "Succeeded" (required)
{customized property}

AzureMLBatchExecutionActivity

Name	Description	Value
type	Type of activity.	"AzureMLBatchExecution" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Batch Execution activity properties.	AzureMLBatchExecutionActivityTypeProperties (required)

LinkedServiceReference

Name	Description	Value
parameters	Arguments for LinkedService.	ParameterValueSpecification
referenceName	Reference LinkedService name.	string (required)
type	Linked service reference type.	"LinkedServiceReference" (required)

ParameterValueSpecification

Name	Description	Value
{customized property}

ActivityPolicy

Name	Description	Value
retry	Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.
retryIntervalInSeconds	Interval between each retry attempt (in seconds). The default is 30 sec.	int Constraints: Min value = 30 Max value = 86400
secureOutput	When set to true, Output from activity is considered as secure and will not be logged to monitoring.	bool
timeout	Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).
{customized property}

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.	AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...
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.	AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

Name	Description	Value
{customized property}

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLWebServiceFile

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

AzureMLBatchExecutionActivityTypePropertiesWebServic...

Name	Description	Value
{customized property}		AzureMLWebServiceFile

AzureMLUpdateResourceActivity

Name	Description	Value
type	Type of activity.	"AzureMLUpdateResource" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Azure ML Update Resource management activity properties.	AzureMLUpdateResourceActivityTypeProperties (required)

AzureMLUpdateResourceActivityTypeProperties

Name	Description	Value
trainedModelFilePath	The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).
trainedModelLinkedServiceName	Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.	LinkedServiceReference (required)
trainedModelName	Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).

CopyActivity

Name	Description	Value
type	Type of activity.	"Copy" (required)
inputs	List of inputs for the activity.	DatasetReference[]
linkedServiceName	Linked service reference.	LinkedServiceReference
outputs	List of outputs for the activity.	DatasetReference[]
policy	Activity policy.	ActivityPolicy
typeProperties	Copy activity properties.	CopyActivityTypeProperties (required)

DatasetReference

Name	Description	Value
parameters	Arguments for dataset.	ParameterValueSpecification
referenceName	Reference dataset name.	string (required)
type	Dataset reference type.	"DatasetReference" (required)

CopyActivityTypeProperties

Name	Description	Value
cloudDataMovementUnits	Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.
enableSkipIncompatibleRow	Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).
enableStaging	Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).
parallelCopies	Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.
redirectIncompatibleRowSettings	Redirect incompatible row settings when EnableSkipIncompatibleRow is true.	RedirectIncompatibleRowSettings
sink	Copy activity sink.	CopySink (required)
source	Copy activity source.	CopySource (required)
stagingSettings	Specifies interim staging settings when EnableStaging is true.	StagingSettings
translator	Copy activity translator. If not specified, tabular translator is used.

RedirectIncompatibleRowSettings

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

CopySink

Name	Description	Value
sinkRetryCount	Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait	Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).
writeBatchSize	Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout	Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

CopySource

Name	Description	Value
sourceRetryCount	Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait	Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

StagingSettings

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

CustomActivity

Name	Description	Value
type	Type of activity.	"Custom" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Custom activity properties.	CustomActivityTypeProperties (required)

CustomActivityTypeProperties

Name	Description	Value
command	Command for custom activity Type: string (or Expression with resultType string).
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.	CustomActivityTypePropertiesExtendedProperties
folderPath	Folder path for resource files Type: string (or Expression with resultType string).
referenceObjects	Reference objects	CustomActivityReferenceObject
resourceLinkedService	Resource linked service reference.	LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

Name	Description	Value
{customized property}

CustomActivityReferenceObject

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

DatabricksNotebookActivity

Name	Description	Value
type	Type of activity.	"DatabricksNotebook" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath	The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

DatabricksNotebookActivityTypePropertiesBaseParamete...

Name	Description	Value
{customized property}

DataLakeAnalyticsUsqlActivity

Name	Description	Value
type	Type of activity.	"DataLakeAnalyticsU-SQL" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Data Lake Analytics U-SQL activity properties.	DataLakeAnalyticsUsqlActivityTypeProperties (required)

DataLakeAnalyticsUsqlActivityTypeProperties

Name	Description	Value
compilationMode	Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).
degreeOfParallelism	The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.
parameters	Parameters for U-SQL job request.	DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority	Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.
runtimeVersion	Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).
scriptLinkedService	Script linked service reference.	LinkedServiceReference (required)
scriptPath	Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

Name	Description	Value
{customized property}

ExecutePipelineActivity

Name	Description	Value
type	Type of activity.	"ExecutePipeline" (required)
typeProperties	Execute pipeline activity properties.	ExecutePipelineActivityTypeProperties (required)

ExecutePipelineActivityTypeProperties

Name	Description	Value
parameters	Pipeline parameters.	ParameterValueSpecification
pipeline	Pipeline reference.	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" (required)

ExecuteSsisPackageActivity

Name	Description	Value
type	Type of activity.	"ExecuteSSISPackage" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Execute SSIS package activity properties.	ExecuteSsisPackageActivityTypeProperties (required)

ExecuteSsisPackageActivityTypeProperties

Name	Description	Value
connectVia	The integration runtime reference.	IntegrationRuntimeReference (required)
environmentPath	The environment path to execute the SSIS package. Type: string (or Expression with resultType string).
executionCredential	The package execution credential.	SsisExecutionCredential
loggingLevel	The logging level of SSIS package execution. Type: string (or Expression with resultType string).
logLocation	SSIS package execution log location.	SsisLogLocation
packageConnectionManagers	The package level connection managers to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation	SSIS package location.	SsisPackageLocation (required)
packageParameters	The package level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers	The project level connection managers to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters	The project level parameters to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides	The property overrides to execute the SSIS package.	ExecuteSsisPackageActivityTypePropertiesPropertyOver...
runtime	Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).

IntegrationRuntimeReference

Name	Description	Value
parameters	Arguments for integration runtime.	ParameterValueSpecification
referenceName	Reference integration runtime name.	string (required)
type	Type of integration runtime.	"IntegrationRuntimeReference" (required)

SsisExecutionCredential

Name	Description	Value
domain	Domain for windows authentication.
password	Password for windows authentication.	SecureString (required)
userName	UseName for windows authentication.

SecureString

Name	Description	Value
type	Type of the secret.	string (required)
value	Value of secure string.	string (required)

SsisLogLocation

Name	Description	Value
logPath	The SSIS package execution log path. Type: string (or Expression with resultType string).
type	The type of SSIS log location.	"File" (required)
typeProperties	SSIS package execution log location properties.	SsisLogLocationTypeProperties (required)

SsisLogLocationTypeProperties

Name	Description	Value
accessCredential	The package execution log access credential.	SsisAccessCredential
logRefreshInterval	Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

SsisAccessCredential

Name	Description	Value
domain	Domain for windows authentication.
password	Password for windows authentication.	SecretBase (required)
userName	UseName for windows authentication.

SecretBase

Name	Description	Value
type	Set the object type	AzureKeyVaultSecret SecureString (required)

AzureKeyVaultSecretReference

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

ExecuteSsisPackageActivityTypePropertiesPackageConne...

Name	Description	Value
{customized property}		SsisConnectionManager

SsisConnectionManager

Name	Description	Value
{customized property}		SsisExecutionParameter

SsisExecutionParameter

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

SsisPackageLocation

Name	Description	Value
packagePath	The SSIS package path. Type: string (or Expression with resultType string).
type	The type of SSIS package location.	"File" "SSISDB"
typeProperties	SSIS package location properties.	SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

Name	Description	Value
accessCredential	The package access credential.	SsisAccessCredential
configurationPath	The configuration file of the package execution. Type: string (or Expression with resultType string).
packagePassword	Password of the package.	SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

Name	Description	Value
{customized property}		SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

Name	Description	Value
{customized property}		SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

Name	Description	Value
{customized property}		SsisPropertyOverride

SsisPropertyOverride

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

FilterActivity

Name	Description	Value
type	Type of activity.	"Filter" (required)
typeProperties	Filter activity properties.	FilterActivityTypeProperties (required)

FilterActivityTypeProperties

Name	Description	Value
condition	Condition to be used for filtering the input.	Expression (required)
items	Input array on which filter should be applied.	Expression (required)

Expression

Name	Description	Value
type	Expression type.	"Expression" (required)
value	Expression value.	string (required)

ForEachActivity

Name	Description	Value
type	Type of activity.	"ForEach" (required)
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 Constraints: Max value = 50
isSequential	Should the loop be executed in sequence or in parallel (max 50)	bool
items	Collection to iterate.	Expression (required)

GetMetadataActivity

Name	Description	Value
type	Type of activity.	"GetMetadata" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	GetMetadata activity properties.	GetMetadataActivityTypeProperties (required)

GetMetadataActivityTypeProperties

Name	Description	Value
dataset	GetMetadata activity dataset reference.	DatasetReference (required)
fieldList	Fields of metadata to get from dataset.	any[]

HDInsightHiveActivity

Name	Description	Value
type	Type of activity.	"HDInsightHive" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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.	HDInsightHiveActivityTypePropertiesDefines
getDebugInfo	Debug info option.	"Always" "Failure" "None"
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightMapReduceActivity

Name	Description	Value
type	Type of activity.	"HDInsightMapReduce" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight MapReduce activity properties.	HDInsightMapReduceActivityTypeProperties (required)

HDInsightMapReduceActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
className	Class name. Type: string (or Expression with resultType string).
defines	Allows user to specify defines for the MapReduce job request.	HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo	Debug info option.	"Always" "Failure" "None"
jarFilePath	Jar path. Type: string (or Expression with resultType string).
jarLibs	Jar libs.	any[]
jarLinkedService	Jar linked service reference.	LinkedServiceReference
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightPigActivity

Name	Description	Value
type	Type of activity.	"HDInsightPig" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight Pig activity properties.	HDInsightPigActivityTypeProperties (required)

HDInsightPigActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
defines	Allows user to specify defines for Pig job request.	HDInsightPigActivityTypePropertiesDefines
getDebugInfo	Debug info option.	"Always" "Failure" "None"
scriptLinkedService	Script linked service reference.	LinkedServiceReference
scriptPath	Script path. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

Name	Description	Value
{customized property}

HDInsightSparkActivity

Name	Description	Value
type	Type of activity.	"HDInsightSpark" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
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	The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).
getDebugInfo	Debug info option.	"Always" "Failure" "None"
proxyUser	The user to impersonate that will execute the job. Type: string (or Expression with resultType string).
rootPath	The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).
sparkConfig	Spark configuration property.	HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService	The storage linked service for uploading the entry file and dependencies, and for receiving logs.	LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

Name	Description	Value
{customized property}

HDInsightStreamingActivity

Name	Description	Value
type	Type of activity.	"HDInsightStreaming" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	HDInsight streaming activity properties.	HDInsightStreamingActivityTypeProperties (required)

HDInsightStreamingActivityTypeProperties

Name	Description	Value
arguments	User specified arguments to HDInsightActivity.	any[]
combiner	Combiner executable name. Type: string (or Expression with resultType string).
commandEnvironment	Command line environment values.	any[]
defines	Allows user to specify defines for streaming job request.	HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService	Linked service reference where the files are located.	LinkedServiceReference
filePaths	Paths to streaming job files. Can be directories.	any[] (required)
getDebugInfo	Debug info option.	"Always" "Failure" "None"
input	Input blob path. Type: string (or Expression with resultType string).
mapper	Mapper executable name. Type: string (or Expression with resultType string).
output	Output blob path. Type: string (or Expression with resultType string).
reducer	Reducer executable name. Type: string (or Expression with resultType string).
storageLinkedServices	Storage linked service references.	LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

Name	Description	Value
{customized property}

IfConditionActivity

Name	Description	Value
type	Type of activity.	"IfCondition" (required)
typeProperties	IfCondition activity properties.	IfConditionActivityTypeProperties (required)

IfConditionActivityTypeProperties

Name	Description	Value
expression	An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.	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" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Lookup activity properties.	LookupActivityTypeProperties (required)

LookupActivityTypeProperties

Name	Description	Value
dataset	Lookup activity dataset reference.	DatasetReference (required)
firstRowOnly	Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).
source	Dataset-specific source properties, same as copy activity source.	CopySource (required)

SqlServerStoredProcedureActivity

Name	Description	Value
type	Type of activity.	"SqlServerStoredProcedure" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	SQL stored procedure activity properties.	SqlServerStoredProcedureActivityTypeProperties (required)

SqlServerStoredProcedureActivityTypeProperties

Name	Description	Value
storedProcedureName	Stored procedure name. Type: string (or Expression with resultType string).
storedProcedureParameters	Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".	SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

Name	Description	Value
{customized property}		StoredProcedureParameter

StoredProcedureParameter

Name	Description	Value
type	Stored procedure parameter type.	"Boolean" "Date" "Decimal" "Guid" "Int" "Int64" "String"
value	Stored procedure parameter value. Type: string (or Expression with resultType string).

UntilActivity

Name	Description	Value
type	Type of activity.	"Until" (required)
typeProperties	Until activity properties.	UntilActivityTypeProperties (required)

UntilActivityTypeProperties

Name	Description	Value
activities	List of activities to execute.	Activity[] (required)
expression	An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true	Expression (required)
timeout	Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60,([0-5][0-9])):(60,([0-5][0-9])).

WaitActivity

Name	Description	Value
type	Type of activity.	"Wait" (required)
typeProperties	Wait activity properties.	WaitActivityTypeProperties (required)

WaitActivityTypeProperties

Name	Description	Value
waitTimeInSeconds	Duration in seconds.	int (required)

WebActivity

Name	Description	Value
type	Type of activity.	"WebActivity" (required)
linkedServiceName	Linked service reference.	LinkedServiceReference
policy	Activity policy.	ActivityPolicy
typeProperties	Web activity properties.	WebActivityTypeProperties (required)

WebActivityTypeProperties

Name	Description	Value
authentication	Authentication method used for calling the endpoint.	WebActivityAuthentication
body	Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
datasets	List of datasets passed to web endpoint.	DatasetReference[]
disableCertValidation	When set to true, Certificate validation will be disabled.	bool
headers	Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
linkedServices	List of linked services passed to web endpoint.	LinkedServiceReference[]
method	Rest API method for target endpoint.	"DELETE" "GET" "POST" "PUT" (required)
url	Web activity target endpoint and path. Type: string (or Expression with resultType string).

WebActivityAuthentication

Name	Description	Value
password	Password for the PFX file or basic authentication.	SecureString
pfx	Base64-encoded contents of a PFX file.	SecureString
resource	Resource for which Azure Auth token will be requested when using MSI Authentication.	string
type	Web activity authentication (Basic/ClientCertificate/MSI)	string (required)
username	Web activity authentication user name for basic authentication.	string

ParameterDefinitionSpecification

Name	Description	Value
{customized property}		ParameterSpecification

ParameterSpecification

Name	Description	Value
defaultValue	Default value of parameter.
type	Parameter type.	"Array" "Bool" "Float" "Int" "Object" "SecureString" "String" (required)

Share via

Microsoft.DataFactory factories/pipelines 2017-09-01-preview

Bicep resource definition

Resource format

Activity objects

CopySink objects

CopySource objects

SecretBase objects

Property values

factories/pipelines

Pipeline

Activity

ActivityDependency

AzureMLBatchExecutionActivity

LinkedServiceReference

ParameterValueSpecification

ActivityPolicy

AzureMLBatchExecutionActivityTypeProperties

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLWebServiceFile

AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLUpdateResourceActivity

AzureMLUpdateResourceActivityTypeProperties

CopyActivity

DatasetReference

CopyActivityTypeProperties

RedirectIncompatibleRowSettings

CopySink

CopySource

StagingSettings

CustomActivity

CustomActivityTypeProperties

CustomActivityTypePropertiesExtendedProperties

CustomActivityReferenceObject

DatabricksNotebookActivity

DatabricksNotebookActivityTypeProperties

DatabricksNotebookActivityTypePropertiesBaseParamete...

DataLakeAnalyticsUsqlActivity

DataLakeAnalyticsUsqlActivityTypeProperties

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

ExecutePipelineActivity

ExecutePipelineActivityTypeProperties

PipelineReference

ExecuteSsisPackageActivity

ExecuteSsisPackageActivityTypeProperties

IntegrationRuntimeReference

SsisExecutionCredential

SecureString

SsisLogLocation

SsisLogLocationTypeProperties

SsisAccessCredential

SecretBase

AzureKeyVaultSecretReference

ExecuteSsisPackageActivityTypePropertiesPackageConne...

SsisConnectionManager

SsisExecutionParameter

SsisPackageLocation

SsisPackageLocationTypeProperties

ExecuteSsisPackageActivityTypePropertiesPackageParam...

ExecuteSsisPackageActivityTypePropertiesProjectConne...

ExecuteSsisPackageActivityTypePropertiesProjectParam...

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

SsisPropertyOverride

FilterActivity

FilterActivityTypeProperties

Expression

ForEachActivity

ForEachActivityTypeProperties

GetMetadataActivity

GetMetadataActivityTypeProperties

HDInsightHiveActivity

HDInsightHiveActivityTypeProperties

HDInsightHiveActivityTypePropertiesDefines

HDInsightMapReduceActivity

HDInsightMapReduceActivityTypeProperties

HDInsightMapReduceActivityTypePropertiesDefines

HDInsightPigActivity

HDInsightPigActivityTypeProperties

HDInsightPigActivityTypePropertiesDefines