Microsoft.DataFactory factories/dataflows

The factories/dataflows resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.DataFactory/factories/dataflows@2018-06-01' = {
  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 MappingDataFlow, use:

  type: 'MappingDataFlow'
  typeProperties: {
    script: 'string'
    sinks: [
      {
        dataset: {
          parameters: {}
          referenceName: 'string'
          type: 'DatasetReference'
        }
        description: 'string'
        linkedService: {
          parameters: {}
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
        name: 'string'
        schemaLinkedService: {
          parameters: {}
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
      }
    ]
    sources: [
      {
        dataset: {
          parameters: {}
          referenceName: 'string'
          type: 'DatasetReference'
        }
        description: 'string'
        linkedService: {
          parameters: {}
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
        name: 'string'
        schemaLinkedService: {
          parameters: {}
          referenceName: 'string'
          type: 'LinkedServiceReference'
        }
      }
    ]
    transformations: [
      {
        description: 'string'
        name: 'string'
      }
    ]
  }

Property values

factories/dataflows

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataFactory/factories/dataflows'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-06-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Azure Data Factory nested object which contains a flow with data movements and transformations. 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 MappingDataFlow

DataFlowFolder

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

MappingDataFlow

Name Description Value
type Type of data flow. 'MappingDataFlow'
typeProperties Mapping data flow type properties. MappingDataFlowTypeProperties

MappingDataFlowTypeProperties

Name Description Value
script DataFlow script. 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[]

DataFlowSink

Name Description Value
dataset Dataset reference type. DatasetReference
description Transformation description. string
linkedService Linked service reference type. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Linked service reference type. LinkedServiceReference

DatasetReference

Name Description Value
parameters An object mapping parameter names to argument values. object
referenceName Reference dataset name. string (required)
type Dataset reference type. 'DatasetReference'

LinkedServiceReference

Name Description Value
parameters An object mapping parameter names to argument values. object
referenceName Reference LinkedService name. string (required)
type Linked service reference type. 'LinkedServiceReference'

DataFlowSource

Name Description Value
dataset Dataset reference type. DatasetReference
description Transformation description. string
linkedService Linked service reference type. LinkedServiceReference
name Transformation name. string (required)
schemaLinkedService Linked service reference type. LinkedServiceReference

Transformation

Name Description Value
description Transformation description. string
name Transformation name. string (required)