Microsoft.DataFactory Factoryies/adfcdcs 2018-06-01

  • 發行項

Bicep 資源定義

Factory/adfcdcs 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataFactory/factories/adfcdcs 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DataFactory/factories/adfcdcs@2018-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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: 'LinkedServiceReference'
          }
          linkedServiceType: 'string'
          type: 'linkedservicetype'
        }
        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: 'LinkedServiceReference'
          }
          linkedServiceType: 'string'
          type: 'linkedservicetype'
        }
        dataMapperMappings: [
          {
            attributeMappingInfo: {
              attributeMappings: [
                {
                  attributeReference: {
                    entity: 'string'
                    entityConnectionReference: {
                      connectionName: 'string'
                      type: 'linkedservicetype'
                    }
                    name: 'string'
                  }
                  attributeReferences: [
                    {
                      entity: 'string'
                      entityConnectionReference: {
                        connectionName: 'string'
                        type: 'linkedservicetype'
                      }
                      name: 'string'
                    }
                  ]
                  expression: 'string'
                  functionName: 'string'
                  name: 'string'
                  type: 'string'
                }
              ]
            }
            sourceConnectionReference: {
              connectionName: 'string'
              type: 'linkedservicetype'
            }
            sourceDenormalizeInfo: any()
            sourceEntityName: 'string'
            targetEntityName: 'string'
          }
        ]
        relationships: [
          any
        ]
        targetEntities: [
          {
            name: 'string'
            properties: {
              dslConnectorProperties: [
                {
                  name: 'string'
                  value: any()
                }
              ]
              schema: [
                {
                  dataType: 'string'
                  name: 'string'
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

屬性值

factoryies/adfcdcs

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 字串 (必要)
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： Factory
properties 異動數據擷取的屬性。 需要 ChangeDataCapture ()

ChangeDataCapture

名稱 描述 值
allowVNetOverride 布爾值，可判斷是否需要覆寫 vnet 組態。 bool
description 異動數據擷取的描述。 字串
folder 此 CDC 所在的資料夾。 如果未指定，CDC 會顯示在根層級。 ChangeDataCaptureFolder
原則 CDC 原則 MapperPolicy (必要)
sourceConnectionsInfo 可用於 CDC 中來源的來源連線清單。 MapperSourceConnectionsInfo[] (必要)
status CDC 正在執行或停止的狀態。 字串
targetConnectionsInfo 可用於 CDC 中來源的目標連線清單。 MapperTargetConnectionsInfo[] (必要)

ChangeDataCaptureFolder

名稱 描述 值
NAME 這個 CDC 所在的資料夾名稱。 字串

MapperPolicy

名稱 描述 值
mode 執行 CDC 的模式：批次與連續。 字串
週期 定義批次模式執行 CDC 的頻率和間隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名稱 描述 值
frequency 「小時」、「分鐘」或「秒」的期間頻率。 'Hour'
'Minute'
'Second'
interval 根據所選頻率的實際間隔值。 int

MapperSourceConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
sourceEntities 來源連接的來源數據表清單。 MapperTable[]

MapperConnection

名稱 描述 值
commonDslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
isInlineDataset 布爾值，指出連結服務是否為內嵌數據集類型。 目前僅支援內嵌數據集。 bool
linkedService 連結服務參考。 LinkedServiceReference
linkedServiceType 鏈接服務的類型，例如：AzureBlobFS。 字串
type 透過連結服務或數據集的連線類型。 'linkedservicetype' (必要)

MapperDslConnectorProperties

名稱 描述 值
NAME 屬性的名稱。 字串
value 屬性的值。 針對 Bicep，您可以使用 任何 () 函式。

LinkedServiceReference

名稱 描述 值
參數 LinkedService 的自變數。 ParameterValueSpecification
referenceName 參考 LinkedService 名稱。 字串 (必要)
類型 連結服務參考類型。 'LinkedServiceReference' (必要)

ParameterValueSpecification

名稱 描述 值
{自定義屬性} 針對 Bicep，您可以使用 任何 () 函式。

MapperTable

名稱 描述 值
NAME 資料表的名稱。 字串
properties 數據表屬性。 MapperTableProperties

MapperTableProperties

名稱 描述 值
dslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
結構描述 源數據表的數據列清單。 MapperTableSchema[]

MapperTableSchema

名稱 描述 值
dataType 資料行的資料類型。 字串
NAME 資料行的名稱。 字串

MapperTargetConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
dataMapperMappings 數據表對應清單。 DataMapperMapping[]
關聯性 數據表之間的關聯性資訊清單。 any[]
targetEntities 目標連線的來源數據表清單。 MapperTable[]

DataMapperMapping

名稱 描述 值
attributeMappingInfo 這會保留使用者提供的屬性對應資訊。 MapperAttributeMappings
sourceConnectionReference 來源連線的連接參考。 MapperConnectionReference
sourceDenormalizeInfo 這會保存聯結多個來源時所使用的來源反正規化資訊。 針對 Bicep，您可以使用 任何 () 函式。
sourceEntityName 源數據表的名稱 字串
targetEntityName 目標數據表的名稱 字串

MapperAttributeMappings

名稱 描述 值
attributeMappings 屬性對應的清單。 MapperAttributeMapping[]

MapperAttributeMapping

名稱 描述 值
attributeReference 對應中使用的源數據行參考。 它僅用於 『Direct』 對應類型。 MapperAttributeReference
attributeReferences 源數據行的參考清單。 它僅用於 『Derived』 和 『Aggregate』 類型對應。 MapperAttributeReference[]
expression 用於 『Aggregate』 和 'Derived' 類型對應的運算式。 字串
functionName 'Aggregate' 和 'Derived' (所使用的函式名稱，除了 'Advanced') 類型對應之外。 字串
NAME 目標數據行的名稱。 字串
type CDC 屬性對應的類型。 注意：『Advanced』 對應類型也會儲存為 『Derived』。 'Aggregate'
'Derived'
'Direct'

MapperAttributeReference

名稱 描述 值
實體 資料表的名稱。 字串
entityConnectionReference 連接的連接參考。 MapperConnectionReference
NAME 資料行的名稱。 字串

MapperConnectionReference

名稱 描述 值
connectionName 線上名稱 字串
type 透過連結服務或數據集的連線類型。 'linkedservicetype'

ARM 範本資源定義

Factory/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": "LinkedServiceReference"
          },
          "linkedServiceType": "string",
          "type": "linkedservicetype"
        },
        "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": "LinkedServiceReference"
          },
          "linkedServiceType": "string",
          "type": "linkedservicetype"
        },
        "dataMapperMappings": [
          {
            "attributeMappingInfo": {
              "attributeMappings": [
                {
                  "attributeReference": {
                    "entity": "string",
                    "entityConnectionReference": {
                      "connectionName": "string",
                      "type": "linkedservicetype"
                    },
                    "name": "string"
                  },
                  "attributeReferences": [
                    {
                      "entity": "string",
                      "entityConnectionReference": {
                        "connectionName": "string",
                        "type": "linkedservicetype"
                      },
                      "name": "string"
                    }
                  ],
                  "expression": "string",
                  "functionName": "string",
                  "name": "string",
                  "type": "string"
                }
              ]
            },
            "sourceConnectionReference": {
              "connectionName": "string",
              "type": "linkedservicetype"
            },
            "sourceDenormalizeInfo": {},
            "sourceEntityName": "string",
            "targetEntityName": "string"
          }
        ],
        "relationships": [ object ],
        "targetEntities": [
          {
            "name": "string",
            "properties": {
              "dslConnectorProperties": [
                {
                  "name": "string",
                  "value": {}
                }
              ],
              "schema": [
                {
                  "dataType": "string",
                  "name": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

屬性值

factoryies/adfcdcs

名稱 描述 值
類型 資源類型 'Microsoft.DataFactory/factories/adfcdcs'
apiVersion 資源 API 版本 '2018-06-01'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。		 需要字串 ()
properties 異動數據擷取的屬性。 需要 ChangeDataCapture ()

ChangeDataCapture

名稱 描述 值
allowVNetOverride 布爾值，可判斷是否需要覆寫 vnet 組態。 bool
description 異動數據擷取的描述。 字串
folder 這個 CDC 所在的資料夾。 如果未指定，CDC 會出現在根層級。 ChangeDataCaptureFolder
原則 CDC 原則 需要 MapperPolicy ()
sourceConnectionsInfo 可作為 CDC 來源的來源連線清單。 MapperSourceConnectionsInfo[] (必要)
status CDC 正在執行或停止的狀態。 字串
targetConnectionsInfo 可作為 CDC 來源的目標連線清單。 MapperTargetConnectionsInfo[] (必要)

ChangeDataCaptureFolder

名稱 描述 值
NAME 這個 CDC 所在的資料夾名稱。 字串

MapperPolicy

名稱 描述 值
mode 執行 CDC 的模式：批次與連續。 字串
週期 定義批次模式執行 CDC 的頻率和間隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名稱 描述 值
frequency 以 『Hour』、'Minute' 或 'Second' 為期間的頻率。 'Hour'
'Minute'
'Second'
interval 根據選擇的頻率，實際間隔值。 int

MapperSourceConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
sourceEntities 來源連接的源數據表清單。 MapperTable[]

MapperConnection

名稱 描述 值
commonDslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
isInlineDataset 布爾值，指出連結服務是否為內嵌數據集類型。 目前僅支援內嵌數據集。 bool
linkedService 連結服務參考。 LinkedServiceReference
linkedServiceType 鏈接服務的類型，例如：AzureBlobFS。 字串
type 透過連結服務或數據集的連線類型。 'linkedservicetype' (必要)

MapperDslConnectorProperties

名稱 描述 值
NAME 屬性的名稱。 字串
value 屬性的值。

LinkedServiceReference

名稱 描述 值
參數 LinkedService 的自變數。 ParameterValueSpecification
referenceName 參考 LinkedService 名稱。 需要字串 ()
類型 鏈接的服務參考類型。 'LinkedServiceReference' (必要)

ParameterValueSpecification

名稱 描述 值
{自定義屬性}

MapperTable

名稱 描述 值
NAME 資料表的名稱。 字串
properties 數據表屬性。 MapperTableProperties

MapperTableProperties

名稱 描述 值
dslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
結構描述 源數據表的數據列清單。 MapperTableSchema[]

MapperTableSchema

名稱 描述 值
dataType 資料行的資料類型。 字串
NAME 資料行的名稱。 字串

MapperTargetConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
dataMapperMappings 數據表對應清單。 DataMapperMapping[]
關聯性 數據表之間的關聯性資訊清單。 any[]
targetEntities 目標連線的來源數據表清單。 MapperTable[]

DataMapperMapping

名稱 描述 值
attributeMappingInfo 這會保留使用者提供的屬性對應資訊。 MapperAttributeMappings
sourceConnectionReference 來源連線的連接參考。 MapperConnectionReference
sourceDenormalizeInfo 這會保存聯結多個來源時所使用的來源反正規化資訊。
sourceEntityName 源數據表的名稱 字串
targetEntityName 目標數據表的名稱 字串

MapperAttributeMappings

名稱 描述 值
attributeMappings 屬性對應的清單。 MapperAttributeMapping[]

MapperAttributeMapping

名稱 描述 值
attributeReference 對應中使用的源數據行參考。 它僅用於 『Direct』 對應類型。 MapperAttributeReference
attributeReferences 源數據行的參考清單。 它僅用於 『Derived』 和 『Aggregate』 類型對應。 MapperAttributeReference[]
expression 用於 『Aggregate』 和 'Derived' 類型對應的運算式。 字串
functionName 用於 『Aggregate』 和 『Derived』 (的函式名稱，除了 『Advanced』) 類型對應以外。 字串
NAME 目標數據行的名稱。 字串
type CDC 屬性對應的類型。 注意：『Advanced』 對應類型也會儲存為 『Derived』。 'Aggregate'
'Derived'
'Direct'

MapperAttributeReference

名稱 描述 值
實體 資料表的名稱。 字串
entityConnectionReference 連接的連接參考。 MapperConnectionReference
NAME 資料行的名稱。 字串

MapperConnectionReference

名稱 描述 值
connectionName 線上名稱 字串
type 透過連結服務或數據集的連線類型。 'linkedservicetype'

Terraform (AzAPI 提供者) 資源定義

Factory/adfcdcs 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DataFactory/factories/adfcdcs 資源，請將下列 Terraform 新增至您的範本。

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

屬性值

factoryies/adfcdcs

名稱 描述 值
類型 資源類型 “Microsoft.DataFactory/factories/adfcdcs@2018-06-01”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： Factory
properties 異動數據擷取的屬性。 需要 ChangeDataCapture ()

ChangeDataCapture

名稱 描述 值
allowVNetOverride 布爾值，可判斷是否需要覆寫 vnet 組態。 bool
description 異動數據擷取的描述。 字串
folder 此 CDC 所在的資料夾。 如果未指定，CDC 會顯示在根層級。 ChangeDataCaptureFolder
原則 CDC 原則 MapperPolicy (必要)
sourceConnectionsInfo 可用於 CDC 中來源的來源連線清單。 MapperSourceConnectionsInfo[] (必要)
status CDC 正在執行或停止的狀態。 字串
targetConnectionsInfo 可用於 CDC 中來源的目標連線清單。 MapperTargetConnectionsInfo[] (必要)

ChangeDataCaptureFolder

名稱 描述 值
NAME 這個 CDC 所在的資料夾名稱。 字串

MapperPolicy

名稱 描述 值
mode 執行 CDC 的模式：批次與連續。 字串
週期 定義批次模式執行 CDC 的頻率和間隔。 MapperPolicyRecurrence

MapperPolicyRecurrence

名稱 描述 值
frequency 「小時」、「分鐘」或「秒」的期間頻率。 “Hour”
“Minute”
“Second”
interval 根據所選頻率的實際間隔值。 int

MapperSourceConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
sourceEntities 來源連接的源數據表清單。 MapperTable[]

MapperConnection

名稱 描述 值
commonDslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
isInlineDataset 布爾值，指出連結服務是否為內嵌數據集類型。 目前僅支援內嵌數據集。 bool
linkedService 連結服務參考。 LinkedServiceReference
linkedServiceType 鏈接服務的類型，例如：AzureBlobFS。 字串
type 透過連結服務或數據集的連線類型。 “linkedservicetype” (必要)

MapperDslConnectorProperties

名稱 描述 值
NAME 屬性的名稱。 字串
value 屬性的值。

LinkedServiceReference

名稱 描述 值
參數 LinkedService 的自變數。 ParameterValueSpecification
referenceName 參考 LinkedService 名稱。 需要字串 ()
類型 鏈接的服務參考類型。 “LinkedServiceReference” (必要)

ParameterValueSpecification

名稱 描述 值
{自定義屬性}

MapperTable

名稱 描述 值
NAME 資料表的名稱。 字串
properties 數據表屬性。 MapperTableProperties

MapperTableProperties

名稱 描述 值
dslConnectorProperties 連接屬性的名稱/值組清單。 MapperDslConnectorProperties[]
結構描述 源數據表的數據列清單。 MapperTableSchema[]

MapperTableSchema

名稱 描述 值
dataType 資料行的資料類型。 字串
NAME 資料行的名稱。 字串

MapperTargetConnectionsInfo

名稱 描述 值
connection 來源線上詳細數據。 MapperConnection
dataMapperMappings 數據表對應清單。 DataMapperMapping[]
關聯性 數據表之間的關聯性資訊清單。 any[]
targetEntities 目標連線的來源數據表清單。 MapperTable[]

DataMapperMapping

名稱 描述 值
attributeMappingInfo 這會保留使用者提供的屬性對應資訊。 MapperAttributeMappings
sourceConnectionReference 來源連線的連接參考。 MapperConnectionReference
sourceDenormalizeInfo 這會保存聯結多個來源時所使用的來源反正規化資訊。
sourceEntityName 源數據表的名稱 字串
targetEntityName 目標數據表的名稱 字串

MapperAttributeMappings

名稱 描述 值
attributeMappings 屬性對應的清單。 MapperAttributeMapping[]

MapperAttributeMapping

名稱 描述 值
attributeReference 對應中使用的源數據行參考。 它僅用於 『Direct』 對應類型。 MapperAttributeReference
attributeReferences 源數據行的參考清單。 它僅用於 『Derived』 和 『Aggregate』 類型對應。 MapperAttributeReference[]
expression 用於 『Aggregate』 和 'Derived' 類型對應的運算式。 字串
functionName 用於 『Aggregate』 和 『Derived』 (的函式名稱，除了 『Advanced』) 類型對應以外。 字串
NAME 目標數據行的名稱。 字串
type CDC 屬性對應的類型。 注意：『Advanced』 對應類型也會儲存為 『Derived』。 “Aggregate”
“Derived”
“Direct”

MapperAttributeReference

名稱 描述 值
實體 資料表的名稱。 字串
entityConnectionReference 連接的連接參考。 MapperConnectionReference
NAME 資料行的名稱。 字串

MapperConnectionReference

名稱 描述 值
connectionName 線上名稱 字串
type 透過連結服務或數據集的連線類型。 “linkedservicetype”