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

Microsoft.DataFactory 工厂/管道 2017-09-01-preview

2025-05-09

Bicep 资源定义

工厂/管道资源类型可以使用目标作进行部署：

资源组 - 请参阅资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2017-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    annotations: [
      any(...)
    ]
    concurrency: int
    description: 'string'
    parameters: {
      {customized property}: {
        defaultValue: any(...)
        type: 'string'
      }
    }
  }
}

CopySink 对象

设置 type 属性以指定对象的类型。

CopySource 对象

设置 type 属性以指定对象的类型。

活动对象

设置 type 属性以指定对象的类型。

对于 AzureMLBatchExecution，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'AzureMLBatchExecution'
  typeProperties: {
    globalParameters: {
      {customized property}: any(...)
    }
    webServiceInputs: {
      {customized property}: {
        filePath: any(...)
        linkedServiceName: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    }
    webServiceOutputs: {
      {customized property}: {
        filePath: any(...)
        linkedServiceName: {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      }
    }
  }
}

对于 AzureMLUpdateResource，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'AzureMLUpdateResource'
  typeProperties: {
    trainedModelFilePath: any(...)
    trainedModelLinkedServiceName: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    trainedModelName: any(...)
  }
}

对于 ExecutePipeline，请使用：

{
  type: 'ExecutePipeline'
  typeProperties: {
    parameters: {
      {customized property}: any(...)
    }
    pipeline: {
      name: 'string'
      referenceName: 'string'
      type: 'string'
    }
    waitOnCompletion: bool
  }
}

对于 筛选器，请使用：

{
  type: 'Filter'
  typeProperties: {
    condition: {
      type: 'string'
      value: 'string'
    }
    items: {
      type: 'string'
      value: 'string'
    }
  }
}

对于 ForEach，请使用：

{
  type: 'ForEach'
  typeProperties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    batchCount: int
    isSequential: bool
    items: {
      type: 'string'
      value: 'string'
    }
  }
}

对于 IfCondition，请使用：

{
  type: 'IfCondition'
  typeProperties: {
    expression: {
      type: 'string'
      value: 'string'
    }
    ifFalseActivities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    ifTrueActivities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
  }
}

对于 Until，请使用：

{
  type: 'Until'
  typeProperties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
          }
        ]
        description: 'string'
        name: 'string'
        type: 'string'
        // For remaining properties, see Activity objects
      }
    ]
    expression: {
      type: 'string'
      value: 'string'
    }
    timeout: any(...)
  }
}

对于 Wait，请使用：

{
  type: 'Wait'
  typeProperties: {
    waitTimeInSeconds: int
  }
}

对于 Copy，请使用：

{
  inputs: [
    {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
  ]
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  outputs: [
    {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
  ]
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'Copy'
  typeProperties: {
    cloudDataMovementUnits: any(...)
    enableSkipIncompatibleRow: any(...)
    enableStaging: any(...)
    parallelCopies: any(...)
    redirectIncompatibleRowSettings: {
      linkedServiceName: any(...)
      path: any(...)
    }
    sink: {
      sinkRetryCount: any(...)
      sinkRetryWait: any(...)
      writeBatchSize: any(...)
      writeBatchTimeout: any(...)
      type: 'string'
      // For remaining properties, see CopySink objects
    }
    source: {
      sourceRetryCount: any(...)
      sourceRetryWait: any(...)
      type: 'string'
      // For remaining properties, see CopySource objects
    }
    stagingSettings: {
      enableCompression: any(...)
      linkedServiceName: {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
      path: any(...)
    }
    translator: any(...)
  }
}

对于 “自定义”，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'Custom'
  typeProperties: {
    command: any(...)
    extendedProperties: {
      {customized property}: any(...)
    }
    folderPath: any(...)
    referenceObjects: {
      datasets: [
        {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      ]
      linkedServices: [
        {
          parameters: {
            {customized property}: any(...)
          }
          referenceName: 'string'
          type: 'string'
        }
      ]
    }
    resourceLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
  }
}

对于 DataLakeAnalyticsU-SQL，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'DataLakeAnalyticsU-SQL'
  typeProperties: {
    compilationMode: any(...)
    degreeOfParallelism: any(...)
    parameters: {
      {customized property}: any(...)
    }
    priority: any(...)
    runtimeVersion: any(...)
    scriptLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    scriptPath: any(...)
  }
}

对于 DatabricksNotebook，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'DatabricksNotebook'
  typeProperties: {
    baseParameters: {
      {customized property}: any(...)
    }
    notebookPath: any(...)
  }
}

对于 ExecuteSSISPackage，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'ExecuteSSISPackage'
  typeProperties: {
    connectVia: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    environmentPath: any(...)
    executionCredential: {
      domain: any(...)
      password: {
        type: 'string'
        value: 'string'
      }
      userName: any(...)
    }
    loggingLevel: any(...)
    logLocation: {
      logPath: any(...)
      type: 'string'
      typeProperties: {
        accessCredential: {
          domain: any(...)
          password: {
            type: 'string'
            // For remaining properties, see SecretBase objects
          }
          userName: any(...)
        }
        logRefreshInterval: any(...)
      }
    }
    packageConnectionManagers: {
      {customized property}: {
        {customized property}: {
          value: any(...)
        }
      }
    }
    packageLocation: {
      packagePath: any(...)
      type: 'string'
      typeProperties: {
        accessCredential: {
          domain: any(...)
          password: {
            type: 'string'
            // For remaining properties, see SecretBase objects
          }
          userName: any(...)
        }
        configurationPath: any(...)
        packagePassword: {
          type: 'string'
          // For remaining properties, see SecretBase objects
        }
      }
    }
    packageParameters: {
      {customized property}: {
        value: any(...)
      }
    }
    projectConnectionManagers: {
      {customized property}: {
        {customized property}: {
          value: any(...)
        }
      }
    }
    projectParameters: {
      {customized property}: {
        value: any(...)
      }
    }
    propertyOverrides: {
      {customized property}: {
        isSensitive: bool
        value: any(...)
      }
    }
    runtime: any(...)
  }
}

对于 GetMetadata，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'GetMetadata'
  typeProperties: {
    dataset: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    fieldList: [
      any(...)
    ]
  }
}

对于 HDInsightHive，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'HDInsightHive'
  typeProperties: {
    arguments: [
      any(...)
    ]
    defines: {
      {customized property}: any(...)
    }
    getDebugInfo: 'string'
    scriptLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    scriptPath: any(...)
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
  }
}

对于 HDInsightMapReduce，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'HDInsightMapReduce'
  typeProperties: {
    arguments: [
      any(...)
    ]
    className: any(...)
    defines: {
      {customized property}: any(...)
    }
    getDebugInfo: 'string'
    jarFilePath: any(...)
    jarLibs: [
      any(...)
    ]
    jarLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
  }
}

对于 HDInsightPig，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'HDInsightPig'
  typeProperties: {
    arguments: [
      any(...)
    ]
    defines: {
      {customized property}: any(...)
    }
    getDebugInfo: 'string'
    scriptLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    scriptPath: any(...)
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
  }
}

对于 HDInsightSpark，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'HDInsightSpark'
  typeProperties: {
    arguments: [
      any(...)
    ]
    className: 'string'
    entryFilePath: any(...)
    getDebugInfo: 'string'
    proxyUser: any(...)
    rootPath: any(...)
    sparkConfig: {
      {customized property}: any(...)
    }
    sparkJobLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
  }
}

对于 HDInsightStreaming，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'HDInsightStreaming'
  typeProperties: {
    arguments: [
      any(...)
    ]
    combiner: any(...)
    commandEnvironment: [
      any(...)
    ]
    defines: {
      {customized property}: any(...)
    }
    fileLinkedService: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    filePaths: [
      any(...)
    ]
    getDebugInfo: 'string'
    input: any(...)
    mapper: any(...)
    output: any(...)
    reducer: any(...)
    storageLinkedServices: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
  }
}

对于查找，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'Lookup'
  typeProperties: {
    dataset: {
      parameters: {
        {customized property}: any(...)
      }
      referenceName: 'string'
      type: 'string'
    }
    firstRowOnly: any(...)
    source: {
      sourceRetryCount: any(...)
      sourceRetryWait: any(...)
      type: 'string'
      // For remaining properties, see CopySource objects
    }
  }
}

对于 SqlServerStoredProcedure，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'SqlServerStoredProcedure'
  typeProperties: {
    storedProcedureName: any(...)
    storedProcedureParameters: {
      {customized property}: {
        type: 'string'
        value: any(...)
      }
    }
  }
}

对于 WebActivity，请使用：

{
  linkedServiceName: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  policy: {
    retry: any(...)
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any(...)
  }
  type: 'WebActivity'
  typeProperties: {
    authentication: {
      password: {
        type: 'string'
        value: 'string'
      }
      pfx: {
        type: 'string'
        value: 'string'
      }
      resource: 'string'
      type: 'string'
      username: 'string'
    }
    body: any(...)
    datasets: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
    disableCertValidation: bool
    headers: any(...)
    linkedServices: [
      {
        parameters: {
          {customized property}: any(...)
        }
        referenceName: 'string'
        type: 'string'
      }
    ]
    method: 'string'
    url: any(...)
  }
}

SecretBase 对象

设置 type 属性以指定对象的类型。

对于 AzureKeyVaultSecret，请使用：

{
  secretName: any(...)
  secretVersion: any(...)
  store: {
    parameters: {
      {customized property}: any(...)
    }
    referenceName: 'string'
    type: 'string'
  }
  type: 'AzureKeyVaultSecret'
}

对于 SecureString，请使用：

{
  type: 'SecureString'
  value: 'string'
}

属性值