Microsoft.DataFactory factories/adfcdcs 2018-06-01

• Latest
• 2018-06-01

Bicep resource definition

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

resource symbolicname 'Microsoft.DataFactory/factories/adfcdcs@2018-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowVNetOverride: bool
    description: 'string'
    folder: {
      name: 'string'
    }
    policy: {
      mode: 'string'
      recurrence: {
        frequency: 'string'
        interval: int
      }
    }
    sourceConnectionsInfo: [
      {
        connection: {
          commonDslConnectorProperties: [
            {
              name: 'string'
              value: any(...)
            }
          ]
          isInlineDataset: bool
          linkedService: {
            parameters: {
              {customized property}: any(...)
            }
            referenceName: 'string'
            type: 'string'
          }
          linkedServiceType: 'string'
          type: 'string'
        }
        sourceEntities: [
          {
            name: 'string'
            properties: {
              dslConnectorProperties: [
                {
                  name: 'string'
                  value: any(...)
                }
              ]
              schema: [
                {
                  dataType: 'string'
                  name: 'string'
                }
              ]
            }
          }
        ]
      }
    ]
    status: 'string'
    targetConnectionsInfo: [
      {
        connection: {
          commonDslConnectorProperties: [
            {
              name: 'string'
              value: any(...)
            }
          ]
          isInlineDataset: bool
          linkedService: {
            parameters: {
              {customized property}: any(...)
            }
            referenceName: 'string'
            type: 'string'
          }
          linkedServiceType: 'string'
          type: 'string'
        }
        dataMapperMappings: [
          {
            attributeMappingInfo: {
              attributeMappings: [
                {
                  attributeReference: {
                    entity: 'string'
                    entityConnectionReference: {
                      connectionName: 'string'
                      type: 'string'
                    }
                    name: 'string'
                  }
                  attributeReferences: [
                    {
                      entity: 'string'
                      entityConnectionReference: {
                        connectionName: 'string'
                        type: 'string'
                      }
                      name: 'string'
                    }
                  ]
                  expression: 'string'
                  functionName: 'string'
                  name: 'string'
                  type: 'string'
                }
              ]
            }
            sourceConnectionReference: {
              connectionName: 'string'
              type: 'string'
            }
            sourceDenormalizeInfo: any(...)
            sourceEntityName: 'string'
            targetEntityName: 'string'
          }
        ]
        relationships: [
          any(...)
        ]
        targetEntities: [
          {
            name: 'string'
            properties: {
              dslConnectorProperties: [
                {
                  name: 'string'
                  value: any(...)
                }
              ]
              schema: [
                {
                  dataType: 'string'
                  name: 'string'
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Property Values

Microsoft.DataFactory/factories/adfcdcs

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	Properties of the change data capture.	ChangeDataCapture (required)

ChangeDataCapture

Name	Description	Value
allowVNetOverride	A boolean to determine if the vnet configuration needs to be overwritten.	bool
description	The description of the change data capture.	string
folder	The folder that this CDC is in. If not specified, CDC will appear at the root level.	ChangeDataCaptureFolder
policy	CDC policy	MapperPolicy (required)
sourceConnectionsInfo	List of sources connections that can be used as sources in the CDC.	MapperSourceConnectionsInfo[] (required)
status	Status of the CDC as to if it is running or stopped.	string
targetConnectionsInfo	List of target connections that can be used as sources in the CDC.	MapperTargetConnectionsInfo[] (required)

ChangeDataCaptureFolder

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

DataMapperMapping

Name	Description	Value
attributeMappingInfo	This holds the user provided attribute mapping information.	MapperAttributeMappings
sourceConnectionReference	The connection reference for the source connection.	MapperConnectionReference
sourceDenormalizeInfo	This holds the source denormalization information used while joining multiple sources.	any
sourceEntityName	Name of the source table	string
targetEntityName	Name of the target table	string

LinkedServiceReference

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

MapperAttributeMapping

Name	Description	Value
attributeReference	Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.	MapperAttributeReference
attributeReferences	List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.	MapperAttributeReference[]
expression	Expression used for 'Aggregate' and 'Derived' type mapping.	string
functionName	Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.	string
name	Name of the target column.	string
type	Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.	'Aggregate' 'Derived' 'Direct'

MapperAttributeMappings

Name	Description	Value
attributeMappings	List of attribute mappings.	MapperAttributeMapping[]

MapperAttributeReference

Name	Description	Value
entity	Name of the table.	string
entityConnectionReference	The connection reference for the connection.	MapperConnectionReference
name	Name of the column.	string

MapperConnection

Name	Description	Value
commonDslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
isInlineDataset	A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.	bool
linkedService	Linked service reference.	LinkedServiceReference
linkedServiceType	Type of the linked service e.g.: AzureBlobFS.	string
type	Type of connection via linked service or dataset.	'linkedservicetype' (required)

MapperConnectionReference

Name	Description	Value
connectionName	Name of the connection	string
type	Type of connection via linked service or dataset.	'linkedservicetype'

MapperDslConnectorProperties

Name	Description	Value
name	Name of the property.	string
value	Value of the property.	any

MapperPolicy

Name	Description	Value
mode	Mode of running the CDC: batch vs continuous.	string
recurrence	Defines the frequency and interval for running the CDC for batch mode.	MapperPolicyRecurrence

MapperPolicyRecurrence

Name	Description	Value
frequency	Frequency of period in terms of 'Hour', 'Minute' or 'Second'.	'Hour' 'Minute' 'Second'
interval	Actual interval value as per chosen frequency.	int

MapperSourceConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
sourceEntities	List of source tables for a source connection.	MapperTable[]

MapperTable

Name	Description	Value
name	Name of the table.	string
properties	Table properties.	MapperTableProperties

MapperTableProperties

Name	Description	Value
dslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
schema	List of columns for the source table.	MapperTableSchema[]

MapperTableSchema

Name	Description	Value
dataType	Data type of the column.	string
name	Name of the column.	string

MapperTargetConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
dataMapperMappings	List of table mappings.	DataMapperMapping[]
relationships	List of relationship info among the tables.	any[]
targetEntities	List of source tables for a target connection.	MapperTable[]

ParameterValueSpecification

Name	Description	Value

ARM template resource definition

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

{
  "type": "Microsoft.DataFactory/factories/adfcdcs",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "allowVNetOverride": "bool",
    "description": "string",
    "folder": {
      "name": "string"
    },
    "policy": {
      "mode": "string",
      "recurrence": {
        "frequency": "string",
        "interval": "int"
      }
    },
    "sourceConnectionsInfo": [
      {
        "connection": {
          "commonDslConnectorProperties": [
            {
              "name": "string",
              "value": {}
            }
          ],
          "isInlineDataset": "bool",
          "linkedService": {
            "parameters": {
              "{customized property}": {}
            },
            "referenceName": "string",
            "type": "string"
          },
          "linkedServiceType": "string",
          "type": "string"
        },
        "sourceEntities": [
          {
            "name": "string",
            "properties": {
              "dslConnectorProperties": [
                {
                  "name": "string",
                  "value": {}
                }
              ],
              "schema": [
                {
                  "dataType": "string",
                  "name": "string"
                }
              ]
            }
          }
        ]
      }
    ],
    "status": "string",
    "targetConnectionsInfo": [
      {
        "connection": {
          "commonDslConnectorProperties": [
            {
              "name": "string",
              "value": {}
            }
          ],
          "isInlineDataset": "bool",
          "linkedService": {
            "parameters": {
              "{customized property}": {}
            },
            "referenceName": "string",
            "type": "string"
          },
          "linkedServiceType": "string",
          "type": "string"
        },
        "dataMapperMappings": [
          {
            "attributeMappingInfo": {
              "attributeMappings": [
                {
                  "attributeReference": {
                    "entity": "string",
                    "entityConnectionReference": {
                      "connectionName": "string",
                      "type": "string"
                    },
                    "name": "string"
                  },
                  "attributeReferences": [
                    {
                      "entity": "string",
                      "entityConnectionReference": {
                        "connectionName": "string",
                        "type": "string"
                      },
                      "name": "string"
                    }
                  ],
                  "expression": "string",
                  "functionName": "string",
                  "name": "string",
                  "type": "string"
                }
              ]
            },
            "sourceConnectionReference": {
              "connectionName": "string",
              "type": "string"
            },
            "sourceDenormalizeInfo": {},
            "sourceEntityName": "string",
            "targetEntityName": "string"
          }
        ],
        "relationships": [ {} ],
        "targetEntities": [
          {
            "name": "string",
            "properties": {
              "dslConnectorProperties": [
                {
                  "name": "string",
                  "value": {}
                }
              ],
              "schema": [
                {
                  "dataType": "string",
                  "name": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Property Values

Microsoft.DataFactory/factories/adfcdcs

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	Properties of the change data capture.	ChangeDataCapture (required)
type	The resource type	'Microsoft.DataFactory/factories/adfcdcs'

ChangeDataCapture

Name	Description	Value
allowVNetOverride	A boolean to determine if the vnet configuration needs to be overwritten.	bool
description	The description of the change data capture.	string
folder	The folder that this CDC is in. If not specified, CDC will appear at the root level.	ChangeDataCaptureFolder
policy	CDC policy	MapperPolicy (required)
sourceConnectionsInfo	List of sources connections that can be used as sources in the CDC.	MapperSourceConnectionsInfo[] (required)
status	Status of the CDC as to if it is running or stopped.	string
targetConnectionsInfo	List of target connections that can be used as sources in the CDC.	MapperTargetConnectionsInfo[] (required)

ChangeDataCaptureFolder

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

DataMapperMapping

Name	Description	Value
attributeMappingInfo	This holds the user provided attribute mapping information.	MapperAttributeMappings
sourceConnectionReference	The connection reference for the source connection.	MapperConnectionReference
sourceDenormalizeInfo	This holds the source denormalization information used while joining multiple sources.	any
sourceEntityName	Name of the source table	string
targetEntityName	Name of the target table	string

LinkedServiceReference

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

MapperAttributeMapping

Name	Description	Value
attributeReference	Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.	MapperAttributeReference
attributeReferences	List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.	MapperAttributeReference[]
expression	Expression used for 'Aggregate' and 'Derived' type mapping.	string
functionName	Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.	string
name	Name of the target column.	string
type	Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.	'Aggregate' 'Derived' 'Direct'

MapperAttributeMappings

Name	Description	Value
attributeMappings	List of attribute mappings.	MapperAttributeMapping[]

MapperAttributeReference

Name	Description	Value
entity	Name of the table.	string
entityConnectionReference	The connection reference for the connection.	MapperConnectionReference
name	Name of the column.	string

MapperConnection

Name	Description	Value
commonDslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
isInlineDataset	A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.	bool
linkedService	Linked service reference.	LinkedServiceReference
linkedServiceType	Type of the linked service e.g.: AzureBlobFS.	string
type	Type of connection via linked service or dataset.	'linkedservicetype' (required)

MapperConnectionReference

Name	Description	Value
connectionName	Name of the connection	string
type	Type of connection via linked service or dataset.	'linkedservicetype'

MapperDslConnectorProperties

Name	Description	Value
name	Name of the property.	string
value	Value of the property.	any

MapperPolicy

Name	Description	Value
mode	Mode of running the CDC: batch vs continuous.	string
recurrence	Defines the frequency and interval for running the CDC for batch mode.	MapperPolicyRecurrence

MapperPolicyRecurrence

Name	Description	Value
frequency	Frequency of period in terms of 'Hour', 'Minute' or 'Second'.	'Hour' 'Minute' 'Second'
interval	Actual interval value as per chosen frequency.	int

MapperSourceConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
sourceEntities	List of source tables for a source connection.	MapperTable[]

MapperTable

Name	Description	Value
name	Name of the table.	string
properties	Table properties.	MapperTableProperties

MapperTableProperties

Name	Description	Value
dslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
schema	List of columns for the source table.	MapperTableSchema[]

MapperTableSchema

Name	Description	Value
dataType	Data type of the column.	string
name	Name of the column.	string

MapperTargetConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
dataMapperMappings	List of table mappings.	DataMapperMapping[]
relationships	List of relationship info among the tables.	any[]
targetEntities	List of source tables for a target connection.	MapperTable[]

ParameterValueSpecification

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/adfcdcs@2018-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      allowVNetOverride = bool
      description = "string"
      folder = {
        name = "string"
      }
      policy = {
        mode = "string"
        recurrence = {
          frequency = "string"
          interval = int
        }
      }
      sourceConnectionsInfo = [
        {
          connection = {
            commonDslConnectorProperties = [
              {
                name = "string"
                value = ?
              }
            ]
            isInlineDataset = bool
            linkedService = {
              parameters = {
                {customized property} = ?
              }
              referenceName = "string"
              type = "string"
            }
            linkedServiceType = "string"
            type = "string"
          }
          sourceEntities = [
            {
              name = "string"
              properties = {
                dslConnectorProperties = [
                  {
                    name = "string"
                    value = ?
                  }
                ]
                schema = [
                  {
                    dataType = "string"
                    name = "string"
                  }
                ]
              }
            }
          ]
        }
      ]
      status = "string"
      targetConnectionsInfo = [
        {
          connection = {
            commonDslConnectorProperties = [
              {
                name = "string"
                value = ?
              }
            ]
            isInlineDataset = bool
            linkedService = {
              parameters = {
                {customized property} = ?
              }
              referenceName = "string"
              type = "string"
            }
            linkedServiceType = "string"
            type = "string"
          }
          dataMapperMappings = [
            {
              attributeMappingInfo = {
                attributeMappings = [
                  {
                    attributeReference = {
                      entity = "string"
                      entityConnectionReference = {
                        connectionName = "string"
                        type = "string"
                      }
                      name = "string"
                    }
                    attributeReferences = [
                      {
                        entity = "string"
                        entityConnectionReference = {
                          connectionName = "string"
                          type = "string"
                        }
                        name = "string"
                      }
                    ]
                    expression = "string"
                    functionName = "string"
                    name = "string"
                    type = "string"
                  }
                ]
              }
              sourceConnectionReference = {
                connectionName = "string"
                type = "string"
              }
              sourceDenormalizeInfo = ?
              sourceEntityName = "string"
              targetEntityName = "string"
            }
          ]
          relationships = [
            ?
          ]
          targetEntities = [
            {
              name = "string"
              properties = {
                dslConnectorProperties = [
                  {
                    name = "string"
                    value = ?
                  }
                ]
                schema = [
                  {
                    dataType = "string"
                    name = "string"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  }
}

Property Values

Microsoft.DataFactory/factories/adfcdcs

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	Properties of the change data capture.	ChangeDataCapture (required)
type	The resource type	"Microsoft.DataFactory/factories/adfcdcs@2018-06-01"

ChangeDataCapture

Name	Description	Value
allowVNetOverride	A boolean to determine if the vnet configuration needs to be overwritten.	bool
description	The description of the change data capture.	string
folder	The folder that this CDC is in. If not specified, CDC will appear at the root level.	ChangeDataCaptureFolder
policy	CDC policy	MapperPolicy (required)
sourceConnectionsInfo	List of sources connections that can be used as sources in the CDC.	MapperSourceConnectionsInfo[] (required)
status	Status of the CDC as to if it is running or stopped.	string
targetConnectionsInfo	List of target connections that can be used as sources in the CDC.	MapperTargetConnectionsInfo[] (required)

ChangeDataCaptureFolder

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

DataMapperMapping

Name	Description	Value
attributeMappingInfo	This holds the user provided attribute mapping information.	MapperAttributeMappings
sourceConnectionReference	The connection reference for the source connection.	MapperConnectionReference
sourceDenormalizeInfo	This holds the source denormalization information used while joining multiple sources.	any
sourceEntityName	Name of the source table	string
targetEntityName	Name of the target table	string

LinkedServiceReference

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

MapperAttributeMapping

Name	Description	Value
attributeReference	Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.	MapperAttributeReference
attributeReferences	List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.	MapperAttributeReference[]
expression	Expression used for 'Aggregate' and 'Derived' type mapping.	string
functionName	Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.	string
name	Name of the target column.	string
type	Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.	'Aggregate' 'Derived' 'Direct'

MapperAttributeMappings

Name	Description	Value
attributeMappings	List of attribute mappings.	MapperAttributeMapping[]

MapperAttributeReference

Name	Description	Value
entity	Name of the table.	string
entityConnectionReference	The connection reference for the connection.	MapperConnectionReference
name	Name of the column.	string

MapperConnection

Name	Description	Value
commonDslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
isInlineDataset	A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.	bool
linkedService	Linked service reference.	LinkedServiceReference
linkedServiceType	Type of the linked service e.g.: AzureBlobFS.	string
type	Type of connection via linked service or dataset.	'linkedservicetype' (required)

MapperConnectionReference

Name	Description	Value
connectionName	Name of the connection	string
type	Type of connection via linked service or dataset.	'linkedservicetype'

MapperDslConnectorProperties

Name	Description	Value
name	Name of the property.	string
value	Value of the property.	any

MapperPolicy

Name	Description	Value
mode	Mode of running the CDC: batch vs continuous.	string
recurrence	Defines the frequency and interval for running the CDC for batch mode.	MapperPolicyRecurrence

MapperPolicyRecurrence

Name	Description	Value
frequency	Frequency of period in terms of 'Hour', 'Minute' or 'Second'.	'Hour' 'Minute' 'Second'
interval	Actual interval value as per chosen frequency.	int

MapperSourceConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
sourceEntities	List of source tables for a source connection.	MapperTable[]

MapperTable

Name	Description	Value
name	Name of the table.	string
properties	Table properties.	MapperTableProperties

MapperTableProperties

Name	Description	Value
dslConnectorProperties	List of name/value pairs for connection properties.	MapperDslConnectorProperties[]
schema	List of columns for the source table.	MapperTableSchema[]

MapperTableSchema

Name	Description	Value
dataType	Data type of the column.	string
name	Name of the column.	string

MapperTargetConnectionsInfo

Name	Description	Value
connection	Source connection details.	MapperConnection
dataMapperMappings	List of table mappings.	DataMapperMapping[]
relationships	List of relationship info among the tables.	any[]
targetEntities	List of source tables for a target connection.	MapperTable[]

ParameterValueSpecification

Name	Description	Value