你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.DataFactory 工厂/adfcdcs

Bicep 资源定义

工厂/adfcdcs 资源类型可以使用目标操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataFactory/factories/adfcdcs 资源,请将以下 Bicep 添加到模板。

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(Azure.Bicep.Types.Concrete.AnyType)
            }
          ]
          isInlineDataset: bool
          linkedService: {
            parameters: {
              {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
            }
            referenceName: 'string'
            type: 'string'
          }
          linkedServiceType: 'string'
          type: 'string'
        }
        sourceEntities: [
          {
            name: 'string'
            properties: {
              dslConnectorProperties: [
                {
                  name: 'string'
                  value: any(Azure.Bicep.Types.Concrete.AnyType)
                }
              ]
              schema: [
                {
                  dataType: 'string'
                  name: 'string'
                }
              ]
            }
          }
        ]
      }
    ]
    status: 'string'
    targetConnectionsInfo: [
      {
        connection: {
          commonDslConnectorProperties: [
            {
              name: 'string'
              value: any(Azure.Bicep.Types.Concrete.AnyType)
            }
          ]
          isInlineDataset: bool
          linkedService: {
            parameters: {
              {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
            }
            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(Azure.Bicep.Types.Concrete.AnyType)
            sourceEntityName: 'string'
            targetEntityName: 'string'
          }
        ]
        relationships: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        targetEntities: [
          {
            name: 'string'
            properties: {
              dslConnectorProperties: [
                {
                  name: 'string'
                  value: any(Azure.Bicep.Types.Concrete.AnyType)
                }
              ]
              schema: [
                {
                  dataType: 'string'
                  name: 'string'
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

属性值

ChangeDataCapture

名字 描述 价值
allowVNetOverride 一个布尔值,用于确定是否需要覆盖 vnet 配置。 bool
描述 变更数据捕获的说明。 字符串
文件夹 此 CDC 所在的文件夹。 如果未指定,CDC 将出现在根级别。 ChangeDataCaptureFolder
政策 CDC 策略 MapperPolicy (必需)
sourceConnectionsInfo 可在 CDC 中用作源的源连接列表。 MapperSourceConnectionsInfo[] (必需)
地位 CDC 的状态,例如它正在运行或已停止。 字符串
targetConnectionsInfo 可用作 CDC 中的源的目标连接列表。 MapperTargetConnectionsInfo[] (必需)

ChangeDataCaptureFolder

名字 描述 价值
名字 此 CDC 所在的文件夹的名称。 字符串

DataMapperMapping

名字 描述 价值
attributeMappingInfo 这会保存用户提供的属性映射信息。 MapperAttributeMappings
sourceConnectionReference 源连接的连接引用。 MapperConnectionReference
sourceDenormalizeInfo 这会保存联接多个源时使用的源非规范化信息。 任何
sourceEntityName 源表的名称 字符串
targetEntityName 目标表的名称 字符串

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

MapperAttributeMapping

名字 描述 价值
attributeReference 映射中使用的源列的引用。 它仅用于“直接”映射类型。 MapperAttributeReference
attributeReferences 源列的引用列表。 它仅用于“派生”和“聚合”类型映射。 MapperAttributeReference[]
表达 用于“聚合”和“派生”类型映射的表达式。 字符串
functionName 用于“Aggregate”和“Derived”(“高级”除外)类型映射的函数的名称。 字符串
名字 目标列的名称。 字符串
类型 CDC 属性映射的类型。 注意:“高级”映射类型也保存为“派生”。 “Aggregate”
“Derived”
“Direct”

MapperAttributeMappings

名字 描述 价值
attributeMappings 属性映射列表。 MapperAttributeMapping[]

MapperAttributeReference

名字 描述 价值
实体 表的名称。 字符串
entityConnectionReference 连接的连接引用。 MapperConnectionReference
名字 列的名称。 字符串

MapperConnection

名字 描述 价值
commonDslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
isInlineDataset 一个布尔值,指示链接服务是否为内联数据集类型。 目前仅支持内联数据集。 bool
linkedService 链接服务引用。 LinkedServiceReference
linkedServiceType 链接服务的类型,例如:AzureBlobFS。 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”(必需)

MapperConnectionReference

名字 描述 价值
connectionName 连接的名称 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”

MapperDslConnectorProperties

名字 描述 价值
名字 属性的名称。 字符串
价值 属性的值。 任何

MapperPolicy

名字 描述 价值
模式 运行 CDC 的模式:批处理与连续。 字符串
复发 定义运行用于批处理模式的 CDC 的频率和间隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名字 描述 价值
频率 “Hour”、“Minute”或“Second”的时间段频率。 “Hour”
“Minute”
“Second”
间隔 根据所选频率的实际间隔值。 int

MapperSourceConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
sourceEntities 源连接的源表列表。 MapperTable[]

MapperTable

名字 描述 价值
名字 表的名称。 字符串
性能 表属性。 MapperTableProperties

MapperTableProperties

名字 描述 价值
dslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
图式 源表的列列表。 MapperTableSchema[]

MapperTableSchema

名字 描述 价值
dataType 列的数据类型。 字符串
名字 列的名称。 字符串

MapperTargetConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
dataMapperMappings 表映射列表。 DataMapperMapping[]
关系 表之间的关系信息列表。 any[]
targetEntities 目标连接的源表列表。 MapperTable[]

Microsoft.DataFactory/factories/adfcdcs

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:工厂
性能 更改数据捕获的属性。 ChangeDataCapture(必需)

ParameterValueSpecification

名字 描述 价值

ARM 模板资源定义

工厂/adfcdcs 资源类型可以使用目标操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataFactory/factories/adfcdcs 资源,请将以下 JSON 添加到模板。

{
  "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"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

属性值

ChangeDataCapture

名字 描述 价值
allowVNetOverride 一个布尔值,用于确定是否需要覆盖 vnet 配置。 bool
描述 变更数据捕获的说明。 字符串
文件夹 此 CDC 所在的文件夹。 如果未指定,CDC 将出现在根级别。 ChangeDataCaptureFolder
政策 CDC 策略 MapperPolicy (必需)
sourceConnectionsInfo 可在 CDC 中用作源的源连接列表。 MapperSourceConnectionsInfo[] (必需)
地位 CDC 的状态,例如它正在运行或已停止。 字符串
targetConnectionsInfo 可用作 CDC 中的源的目标连接列表。 MapperTargetConnectionsInfo[] (必需)

ChangeDataCaptureFolder

名字 描述 价值
名字 此 CDC 所在的文件夹的名称。 字符串

DataMapperMapping

名字 描述 价值
attributeMappingInfo 这会保存用户提供的属性映射信息。 MapperAttributeMappings
sourceConnectionReference 源连接的连接引用。 MapperConnectionReference
sourceDenormalizeInfo 这会保存联接多个源时使用的源非规范化信息。 任何
sourceEntityName 源表的名称 字符串
targetEntityName 目标表的名称 字符串

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

MapperAttributeMapping

名字 描述 价值
attributeReference 映射中使用的源列的引用。 它仅用于“直接”映射类型。 MapperAttributeReference
attributeReferences 源列的引用列表。 它仅用于“派生”和“聚合”类型映射。 MapperAttributeReference[]
表达 用于“聚合”和“派生”类型映射的表达式。 字符串
functionName 用于“Aggregate”和“Derived”(“高级”除外)类型映射的函数的名称。 字符串
名字 目标列的名称。 字符串
类型 CDC 属性映射的类型。 注意:“高级”映射类型也保存为“派生”。 “Aggregate”
“Derived”
“Direct”

MapperAttributeMappings

名字 描述 价值
attributeMappings 属性映射列表。 MapperAttributeMapping[]

MapperAttributeReference

名字 描述 价值
实体 表的名称。 字符串
entityConnectionReference 连接的连接引用。 MapperConnectionReference
名字 列的名称。 字符串

MapperConnection

名字 描述 价值
commonDslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
isInlineDataset 一个布尔值,指示链接服务是否为内联数据集类型。 目前仅支持内联数据集。 bool
linkedService 链接服务引用。 LinkedServiceReference
linkedServiceType 链接服务的类型,例如:AzureBlobFS。 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”(必需)

MapperConnectionReference

名字 描述 价值
connectionName 连接的名称 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”

MapperDslConnectorProperties

名字 描述 价值
名字 属性的名称。 字符串
价值 属性的值。 任何

MapperPolicy

名字 描述 价值
模式 运行 CDC 的模式:批处理与连续。 字符串
复发 定义运行用于批处理模式的 CDC 的频率和间隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名字 描述 价值
频率 “Hour”、“Minute”或“Second”的时间段频率。 “Hour”
“Minute”
“Second”
间隔 根据所选频率的实际间隔值。 int

MapperSourceConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
sourceEntities 源连接的源表列表。 MapperTable[]

MapperTable

名字 描述 价值
名字 表的名称。 字符串
性能 表属性。 MapperTableProperties

MapperTableProperties

名字 描述 价值
dslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
图式 源表的列列表。 MapperTableSchema[]

MapperTableSchema

名字 描述 价值
dataType 列的数据类型。 字符串
名字 列的名称。 字符串

MapperTargetConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
dataMapperMappings 表映射列表。 DataMapperMapping[]
关系 表之间的关系信息列表。 any[]
targetEntities 目标连接的源表列表。 MapperTable[]

Microsoft.DataFactory/factories/adfcdcs

名字 描述 价值
apiVersion API 版本 '2018-06-01'
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
性能 更改数据捕获的属性。 ChangeDataCapture(必需)
类型 资源类型 “Microsoft.DataFactory/factories/adfcdcs”

ParameterValueSpecification

名字 描述 价值

Terraform (AzAPI 提供程序)资源定义

工厂/adfcdcs 资源类型可以使用目标操作进行部署:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.DataFactory/factories/adfcdcs 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/adfcdcs@2018-06-01"
  name = "string"
  body = jsonencode({
    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"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  })
}

属性值

ChangeDataCapture

名字 描述 价值
allowVNetOverride 一个布尔值,用于确定是否需要覆盖 vnet 配置。 bool
描述 变更数据捕获的说明。 字符串
文件夹 此 CDC 所在的文件夹。 如果未指定,CDC 将出现在根级别。 ChangeDataCaptureFolder
政策 CDC 策略 MapperPolicy (必需)
sourceConnectionsInfo 可在 CDC 中用作源的源连接列表。 MapperSourceConnectionsInfo[] (必需)
地位 CDC 的状态,例如它正在运行或已停止。 字符串
targetConnectionsInfo 可用作 CDC 中的源的目标连接列表。 MapperTargetConnectionsInfo[] (必需)

ChangeDataCaptureFolder

名字 描述 价值
名字 此 CDC 所在的文件夹的名称。 字符串

DataMapperMapping

名字 描述 价值
attributeMappingInfo 这会保存用户提供的属性映射信息。 MapperAttributeMappings
sourceConnectionReference 源连接的连接引用。 MapperConnectionReference
sourceDenormalizeInfo 这会保存联接多个源时使用的源非规范化信息。 任何
sourceEntityName 源表的名称 字符串
targetEntityName 目标表的名称 字符串

LinkedServiceReference

名字 描述 价值
参数 LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 string (必需)
类型 链接服务引用类型。 “LinkedServiceReference”(必需)

MapperAttributeMapping

名字 描述 价值
attributeReference 映射中使用的源列的引用。 它仅用于“直接”映射类型。 MapperAttributeReference
attributeReferences 源列的引用列表。 它仅用于“派生”和“聚合”类型映射。 MapperAttributeReference[]
表达 用于“聚合”和“派生”类型映射的表达式。 字符串
functionName 用于“Aggregate”和“Derived”(“高级”除外)类型映射的函数的名称。 字符串
名字 目标列的名称。 字符串
类型 CDC 属性映射的类型。 注意:“高级”映射类型也保存为“派生”。 “Aggregate”
“Derived”
“Direct”

MapperAttributeMappings

名字 描述 价值
attributeMappings 属性映射列表。 MapperAttributeMapping[]

MapperAttributeReference

名字 描述 价值
实体 表的名称。 字符串
entityConnectionReference 连接的连接引用。 MapperConnectionReference
名字 列的名称。 字符串

MapperConnection

名字 描述 价值
commonDslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
isInlineDataset 一个布尔值,指示链接服务是否为内联数据集类型。 目前仅支持内联数据集。 bool
linkedService 链接服务引用。 LinkedServiceReference
linkedServiceType 链接服务的类型,例如:AzureBlobFS。 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”(必需)

MapperConnectionReference

名字 描述 价值
connectionName 连接的名称 字符串
类型 通过链接服务或数据集的连接类型。 “linkedservicetype”

MapperDslConnectorProperties

名字 描述 价值
名字 属性的名称。 字符串
价值 属性的值。 任何

MapperPolicy

名字 描述 价值
模式 运行 CDC 的模式:批处理与连续。 字符串
复发 定义运行用于批处理模式的 CDC 的频率和间隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名字 描述 价值
频率 “Hour”、“Minute”或“Second”的时间段频率。 “Hour”
“Minute”
“Second”
间隔 根据所选频率的实际间隔值。 int

MapperSourceConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
sourceEntities 源连接的源表列表。 MapperTable[]

MapperTable

名字 描述 价值
名字 表的名称。 字符串
性能 表属性。 MapperTableProperties

MapperTableProperties

名字 描述 价值
dslConnectorProperties 连接属性的名称/值对列表。 MapperDslConnectorProperties[]
图式 源表的列列表。 MapperTableSchema[]

MapperTableSchema

名字 描述 价值
dataType 列的数据类型。 字符串
名字 列的名称。 字符串

MapperTargetConnectionsInfo

名字 描述 价值
连接 源连接详细信息。 MapperConnection
dataMapperMappings 表映射列表。 DataMapperMapping[]
关系 表之间的关系信息列表。 any[]
targetEntities 目标连接的源表列表。 MapperTable[]

Microsoft.DataFactory/factories/adfcdcs

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 260
模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:工厂
性能 更改数据捕获的属性。 ChangeDataCapture(必需)
类型 资源类型 “Microsoft.DataFactory/factories/adfcdcs@2018-06-01”

ParameterValueSpecification

名字 描述 价值