Microsoft.DataFactory factories/dataflows

Bicep 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.

Resource format

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

resource symbolicname 'Microsoft.DataFactory/factories/dataflows@2018-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    annotations: [
      any(...)
    ]
    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}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
        rejectedDataLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        schemaLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    ]
    sources: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
        schemaLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    ]
    transformations: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
      }
    ]
  }
}

For MappingDataFlow, use:

{
  type: 'MappingDataFlow'
  typeProperties: {
    script: 'string'
    scriptLines: [
      'string'
    ]
    sinks: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
        rejectedDataLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        schemaLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    ]
    sources: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
        schemaLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    ]
    transformations: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
      }
    ]
  }
}

For WranglingDataFlow, use:

{
  type: 'WranglingDataFlow'
  typeProperties: {
    documentLocale: 'string'
    script: 'string'
    sources: [
      {
        dataset: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        description: 'string'
        flowlet: {
          datasetParameters: any(...)
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        linkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        name: 'string'
        schemaLinkedService: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
        script: 'string'
      }
    ]
  }
}

Property Values

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 to 'Flowlet' for type Flowlet. Set to 'MappingDataFlow' for type MappingDataFlow. Set to 'WranglingDataFlow' for type WranglingDataFlow. 'Flowlet'
'MappingDataFlow'
'WranglingDataFlow' (required)

DataFlowFolder

Name Description Value
name The name of the folder that this data flow is in. string

DataFlowReference

Name Description Value
datasetParameters Reference data flow parameters from dataset. any
parameters Data flow parameters ParameterValueSpecification
referenceName Reference data flow name. string (required)
type Data flow reference type. 'DataFlowReference' (required)

DataFlowSink

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
rejectedDataLinkedService Rejected data linked service reference. LinkedServiceReference
schemaLinkedService Schema linked service reference. LinkedServiceReference

DataFlowSource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference

DatasetReference

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

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[]

LinkedServiceReference

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

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[]

Microsoft.DataFactory/factories/dataflows

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 260
Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
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 Data flow properties. DataFlow (required)

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

PowerQuerySource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference
script source script. string

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[]

Transformation

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)

WranglingDataFlow

Name Description Value
type Type of data flow. 'WranglingDataFlow' (required)
typeProperties PowerQuery data flow type properties. PowerQueryTypeProperties

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.

Resource format

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": [ {} ],
    "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": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string",
        "rejectedDataLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "schemaLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        }
      }
    ],
    "sources": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string",
        "schemaLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        }
      }
    ],
    "transformations": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string"
      }
    ]
  }
}

For MappingDataFlow, use:

{
  "type": "MappingDataFlow",
  "typeProperties": {
    "script": "string",
    "scriptLines": [ "string" ],
    "sinks": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string",
        "rejectedDataLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "schemaLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        }
      }
    ],
    "sources": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string",
        "schemaLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        }
      }
    ],
    "transformations": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string"
      }
    ]
  }
}

For WranglingDataFlow, use:

{
  "type": "WranglingDataFlow",
  "typeProperties": {
    "documentLocale": "string",
    "script": "string",
    "sources": [
      {
        "dataset": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "description": "string",
        "flowlet": {
          "datasetParameters": {},
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "linkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "name": "string",
        "schemaLinkedService": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "string"
        },
        "script": "string"
      }
    ]
  }
}

Property Values

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 to 'Flowlet' for type Flowlet. Set to 'MappingDataFlow' for type MappingDataFlow. Set to 'WranglingDataFlow' for type WranglingDataFlow. 'Flowlet'
'MappingDataFlow'
'WranglingDataFlow' (required)

DataFlowFolder

Name Description Value
name The name of the folder that this data flow is in. string

DataFlowReference

Name Description Value
datasetParameters Reference data flow parameters from dataset. any
parameters Data flow parameters ParameterValueSpecification
referenceName Reference data flow name. string (required)
type Data flow reference type. 'DataFlowReference' (required)

DataFlowSink

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
rejectedDataLinkedService Rejected data linked service reference. LinkedServiceReference
schemaLinkedService Schema linked service reference. LinkedServiceReference

DataFlowSource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference

DatasetReference

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

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[]

LinkedServiceReference

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

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[]

Microsoft.DataFactory/factories/dataflows

Name Description Value
apiVersion The api version '2018-06-01'
name The resource name string

Constraints:
Min length = 1
Max length = 260
Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
properties Data flow properties. DataFlow (required)
type The resource type 'Microsoft.DataFactory/factories/dataflows'

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

PowerQuerySource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference
script source script. string

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[]

Transformation

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)

WranglingDataFlow

Name Description Value
type Type of data flow. 'WranglingDataFlow' (required)
typeProperties PowerQuery data flow type properties. PowerQueryTypeProperties

Usage Examples

Terraform (AzAPI provider) resource definition

The factories/dataflows 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/dataflows resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/dataflows@2018-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      annotations = [
        ?
      ]
      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 = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
        rejectedDataLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        schemaLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
      }
    ]
    sources = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
        schemaLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
      }
    ]
    transformations = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
      }
    ]
  }
}

For MappingDataFlow, use:

{
  type = "MappingDataFlow"
  typeProperties = {
    script = "string"
    scriptLines = [
      "string"
    ]
    sinks = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
        rejectedDataLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        schemaLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
      }
    ]
    sources = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
        schemaLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
      }
    ]
    transformations = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
      }
    ]
  }
}

For WranglingDataFlow, use:

{
  type = "WranglingDataFlow"
  typeProperties = {
    documentLocale = "string"
    script = "string"
    sources = [
      {
        dataset = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        description = "string"
        flowlet = {
          datasetParameters = ?
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        linkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        name = "string"
        schemaLinkedService = {
          parameters = {
            {customized property} = ?
          }
          referenceName = "string"
          type = "string"
        }
        script = "string"
      }
    ]
  }
}

Property Values

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 to 'Flowlet' for type Flowlet. Set to 'MappingDataFlow' for type MappingDataFlow. Set to 'WranglingDataFlow' for type WranglingDataFlow. 'Flowlet'
'MappingDataFlow'
'WranglingDataFlow' (required)

DataFlowFolder

Name Description Value
name The name of the folder that this data flow is in. string

DataFlowReference

Name Description Value
datasetParameters Reference data flow parameters from dataset. any
parameters Data flow parameters ParameterValueSpecification
referenceName Reference data flow name. string (required)
type Data flow reference type. 'DataFlowReference' (required)

DataFlowSink

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
rejectedDataLinkedService Rejected data linked service reference. LinkedServiceReference
schemaLinkedService Schema linked service reference. LinkedServiceReference

DataFlowSource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference

DatasetReference

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

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[]

LinkedServiceReference

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

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[]

Microsoft.DataFactory/factories/dataflows

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 260
Pattern = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Data flow properties. DataFlow (required)
type The resource type "Microsoft.DataFactory/factories/dataflows@2018-06-01"

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

ParameterValueSpecification

Name Description Value

PowerQuerySource

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Schema linked service reference. LinkedServiceReference
script source script. string

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[]

Transformation

Name Description Value
dataset Dataset reference. DatasetReference
description Transformation description. string
flowlet Flowlet Reference DataFlowReference
linkedService Linked service reference. LinkedServiceReference
name Transformation name. string (required)

WranglingDataFlow

Name Description Value
type Type of data flow. 'WranglingDataFlow' (required)
typeProperties PowerQuery data flow type properties. PowerQueryTypeProperties