ARM template resource definition
The factories/dataflows resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.DataFactory/factories/dataflows resource, add the following JSON to your template.
{
"type": "Microsoft.DataFactory/factories/dataflows",
"apiVersion": "2018-06-01",
"name": "string",
"properties": {
"annotations": [ object ],
"description": "string",
"folder": {
"name": "string"
},
"type": "string"
// For remaining properties, see DataFlow objects
}
}
DataFlow objects
Set the type property to specify the type of object.
For Flowlet, use:
"type": "Flowlet",
"typeProperties": {
"script": "string",
"scriptLines": [ "string" ],
"sinks": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string",
"rejectedDataLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"schemaLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
}
}
],
"sources": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string",
"schemaLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
}
}
],
"transformations": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string"
}
]
}
For MappingDataFlow, use:
"type": "MappingDataFlow",
"typeProperties": {
"script": "string",
"scriptLines": [ "string" ],
"sinks": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string",
"rejectedDataLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"schemaLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
}
}
],
"sources": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string",
"schemaLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
}
}
],
"transformations": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string"
}
]
}
For WranglingDataFlow, use:
"type": "WranglingDataFlow",
"typeProperties": {
"documentLocale": "string",
"script": "string",
"sources": [
{
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DatasetReference"
},
"description": "string",
"flowlet": {
"datasetParameters": {},
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "DataFlowReference",
"{customized property}": {}
},
"linkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"name": "string",
"schemaLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "LinkedServiceReference"
},
"script": "string"
}
]
}
Property values
factories/dataflows
Name |
Description |
Value |
type |
The resource type |
'Microsoft.DataFactory/factories/dataflows' |
apiVersion |
The resource api version |
'2018-06-01' |
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 |
Data flow properties. |
DataFlow (required) |
DataFlow
Name |
Description |
Value |
annotations |
List of tags that can be used for describing the data flow. |
any[] |
description |
The description of the data flow. |
string |
folder |
The folder that this data flow is in. If not specified, Data flow will appear at the root level. |
DataFlowFolder |
type |
Set the object type |
Flowlet MappingDataFlow WranglingDataFlow (required) |
DataFlowFolder
Name |
Description |
Value |
name |
The name of the folder that this data flow is in. |
string |
Flowlet
Name |
Description |
Value |
type |
Type of data flow. |
'Flowlet' (required) |
typeProperties |
Flowlet type properties. |
FlowletTypeProperties |
FlowletTypeProperties
Name |
Description |
Value |
script |
Flowlet script. |
string |
scriptLines |
Flowlet script lines. |
string[] |
sinks |
List of sinks in Flowlet. |
DataFlowSink[] |
sources |
List of sources in Flowlet. |
DataFlowSource[] |
transformations |
List of transformations in Flowlet. |
Transformation[] |
DataFlowSink
DatasetReference
Name |
Description |
Value |
parameters |
Arguments for dataset. |
ParameterValueSpecification |
referenceName |
Reference dataset name. |
string (required) |
type |
Dataset reference type. |
'DatasetReference' (required) |
ParameterValueSpecification
Name |
Description |
Value |
{customized property} |
|
|
DataFlowReference
Name |
Description |
Value |
datasetParameters |
Reference data flow parameters from dataset. |
|
parameters |
Data flow parameters |
ParameterValueSpecification |
referenceName |
Reference data flow name. |
string (required) |
type |
Data flow reference type. |
'DataFlowReference' (required) |
{customized property} |
|
|
LinkedServiceReference
Name |
Description |
Value |
parameters |
Arguments for LinkedService. |
ParameterValueSpecification |
referenceName |
Reference LinkedService name. |
string (required) |
type |
Linked service reference type. |
'LinkedServiceReference' (required) |
DataFlowSource
MappingDataFlow
Name |
Description |
Value |
type |
Type of data flow. |
'MappingDataFlow' (required) |
typeProperties |
Mapping data flow type properties. |
MappingDataFlowTypeProperties |
MappingDataFlowTypeProperties
Name |
Description |
Value |
script |
DataFlow script. |
string |
scriptLines |
Data flow script lines. |
string[] |
sinks |
List of sinks in data flow. |
DataFlowSink[] |
sources |
List of sources in data flow. |
DataFlowSource[] |
transformations |
List of transformations in data flow. |
Transformation[] |
WranglingDataFlow
Name |
Description |
Value |
type |
Type of data flow. |
'WranglingDataFlow' (required) |
typeProperties |
PowerQuery data flow type properties. |
PowerQueryTypeProperties |
PowerQueryTypeProperties
Name |
Description |
Value |
documentLocale |
Locale of the Power query mashup document. |
string |
script |
Power query mashup script. |
string |
sources |
List of sources in Power Query. |
PowerQuerySource[] |
PowerQuerySource