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

Microsoft.DataFactory factories/pipelines 2017-09-01-preview

Bicep 资源定义

工厂/管道资源类型可以通过针对以下操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2017-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    activities: [
      {
        dependsOn: [
          {
            activity: 'string'
            dependencyConditions: [
              'string'
            ]
            {customized property}: any()
          }
        ]
        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'
      }
    }
  }
}

活动对象

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

对于 AzureMLBatchExecution,请使用:

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

对于 AzureMLUpdateResource,请使用:

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

对于 “复制”,请使用:

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

对于 “自定义”,请使用:

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

对于 DatabricksNotebook,请使用:

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

对于 DataLakeAnalyticsU-SQL,请使用:

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

对于 ExecutePipeline,请使用:

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

对于 ExecuteSSISPackage,请使用:

  type: 'ExecuteSSISPackage'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  typeProperties: {
    connectVia: {
      parameters: {
        {customized property}: any()
      }
      referenceName: 'string'
      type: 'IntegrationRuntimeReference'
    }
    environmentPath: any()
    executionCredential: {
      domain: any()
      password: {
        type: 'string'
        value: 'string'
      }
      userName: any()
    }
    loggingLevel: any()
    logLocation: {
      logPath: any()
      type: 'File'
      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()
  }

对于 筛选器,请使用:

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

对于 ForEach,请使用:

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

对于 GetMetadata,请使用:

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

对于 HDInsightHive,请使用:

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

对于 HDInsightMapReduce,请使用:

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

对于 HDInsightPig,请使用:

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

对于 HDInsightSpark,请使用:

  type: 'HDInsightSpark'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  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: 'LinkedServiceReference'
    }
  }

对于 HDInsightStreaming,请使用:

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

对于 IfCondition,请使用:

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

对于 查找,请使用:

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

对于 SqlServerStoredProcedure,请使用:

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

对于 “直到”,请使用:

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

对于 “等待”,请使用:

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

对于 WebActivity,请使用:

  type: 'WebActivity'
  linkedServiceName: {
    parameters: {
      {customized property}: any()
    }
    referenceName: 'string'
    type: 'LinkedServiceReference'
  }
  policy: {
    retry: any()
    retryIntervalInSeconds: int
    secureOutput: bool
    timeout: any()
    {customized property}: any()
  }
  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: 'DatasetReference'
      }
    ]
    disableCertValidation: bool
    headers: any()
    linkedServices: [
      {
        parameters: {
          {customized property}: any()
        }
        referenceName: 'string'
        type: 'LinkedServiceReference'
      }
    ]
    method: 'string'
    url: any()
  }

CopySink 对象

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

CopySource 对象

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

SecretBase 对象

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

对于 AzureKeyVaultSecret,请使用:

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

对于 SecureString,请使用:

  type: 'SecureString'
  value: 'string'

属性值

factories/pipelines

名称 说明
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为“工厂”的资源的符号名称
properties 管道的属性。 需要管道 ()

管道

名称 说明
活动 管道中的活动列表。 Activity[]
annotations 可用于描述管道的标记列表。 any[]
concurrency 管道的最大并发运行数。 int

约束:
最小值 = 1
description 管道的说明。 字符串
parameters 管道的参数列表。 ParameterDefinitionSpecification

活动

名称 说明
dependsOn 活动取决于条件。 ActivityDependency[]
description 活动说明。 字符串
name 活动名称。 字符串 (必需)
类型 设置对象类型 AzureMLBatchExecution
AzureMLUpdateResource
复制
自定义
DatabricksNotebook
DataLakeAnalyticsU-SQL
ExecutePipeline
ExecuteSSISPackage
Filter
ForEach
GetMetadata
HDInsightHive
HDInsightMapReduce
HDInsightPig
HDInsightSpark
HDInsightStreaming
IfCondition
查找
SqlServerStoredProcedure
截止
Wait
需要 WebActivity ()

ActivityDependency

名称 说明
activity 活动名称。 字符串 (必需)
dependencyConditions 依赖项的 Match-Condition。 包含任何一项的字符串数组:
“Completed”
“Failed”
“已跳过”
“成功” (必需)
{customized property} 对于 Bicep,可以使用 任何 () 函数。

AzureMLBatchExecutionActivity

名称 说明 Value
type 活动的类型。 需要“AzureMLBatchExecution” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML Batch 执行活动属性。 AzureMLBatchExecutionActivityTypeProperties (必需)

LinkedServiceReference

名称 说明
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ParameterValueSpecification

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

ActivityPolicy

名称 说明
retry 最大普通重试尝试次数。 默认为 0。 类型:整数 (或 resultType 整数) 的表达式,最小值:0。 对于 Bicep,可以使用 任何 () 函数。
retryIntervalInSeconds 每次重试尝试 (间隔(以秒) 为单位)。 默认值为 30 秒。 int

约束:
最小值 = 30
最大值 = 86400
secureOutput 设置为 true 时,活动的输出被视为安全,不会记录到监视中。 bool
timeout 指定活动运行的超时。 默认超时为 7 天。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。
{customized property} 对于 Bicep,可以使用 任何 () 函数。

AzureMLBatchExecutionActivityTypeProperties

名称 说明
globalParameters 要传递给 Azure ML Batch 执行服务终结点的键、值对。 键必须与已发布 Azure ML Web 服务中定义的 Web 服务参数名称匹配。 值将在 Azure ML 批处理执行请求的 GlobalParameters 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
webServiceInputs 键、值对,将 Azure ML 终结点的 Web 服务输入的名称映射到指定输入 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceInputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...
webServiceOutputs 键、值对,将 Azure ML 终结点的 Web 服务输出的名称映射到指定输出 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceOutputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLWebServiceFile

名称 说明
filePath LinkedService 指定的Azure Blob 存储中的相对文件路径(包括容器名称)。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
linkedServiceName 对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件所在的位置。 LinkedServiceReference (必需)

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLUpdateResourceActivity

名称 说明 Value
type 活动的类型。 “AzureMLUpdateResource” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML 更新资源管理活动属性。 AzureMLUpdateResourceActivityTypeProperties (必需的)

AzureMLUpdateResourceActivityTypeProperties

名称 说明
trainedModelFilePath trainedModelLinkedService 中的相对文件路径,表示更新操作将上传的 .ilearner 文件。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
trainedModelLinkedServiceName 包含更新操作将上传的 .ilearner 文件的 Azure 存储链接服务的名称。 LinkedServiceReference (必需)
trainedModelName 要更新的 Web 服务试验中训练的模型模块的名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)

CopyActivity

名称 说明 Value
type 活动的类型。 “复制” (必需的)
inputs 活动的输入列表。 DatasetReference[]
linkedServiceName 链接服务引用。 LinkedServiceReference
outputs 活动的输出列表。 DatasetReference[]
policy 活动策略。 ActivityPolicy
typeProperties 复制活动属性。 CopyActivityTypeProperties (必需)

DatasetReference

名称 说明
parameters 数据集的参数。 ParameterValueSpecification
referenceName 引用数据集名称。 字符串 (必需)
类型 数据集引用类型。 “DatasetReference” (必需)

CopyActivityTypeProperties

名称 说明
cloudDataMovementUnits 可用于执行此数据移动的云数据移动单位的最大数目。 类型:整数 (或 resultType 整数) 的表达式,最小值:0。 对于 Bicep,可以使用 任何 () 函数。
enableSkipIncompatibleRow 是否跳过不兼容的行。 默认值为 false。 类型:布尔 (或 resultType 布尔) 表达式。 对于 Bicep,可以使用 任何 () 函数。
enableStaging 指定是否通过临时暂存复制数据。 默认值为 false。 类型:布尔 (或 resultType 布尔) 表达式。 对于 Bicep,可以使用 任何 () 函数。
parallelCopies 在源或接收器上打开的最大并发会话数,以避免数据存储过载。 类型:整数 (或 resultType 整数) 的表达式,最小值:0。 对于 Bicep,可以使用 任何 () 函数。
redirectIncompatibleRowSettings 当 EnableSkipIncompatibleRow 为 true 时重定向不兼容行设置。 RedirectIncompatibleRowSettings
接收器 复制活动接收器。 需要 CopySink ()
source 复制活动源。 需要 CopySource ()
stagingSettings 指定 EnableStaging 为 true 时的临时暂存设置。 StagingSettings
转换器 复制活动翻译器。 如果未指定,则使用表格翻译器。 对于 Bicep,可以使用 任何 () 函数。

RedirectIncompatibleRowSettings

名称 说明
linkedServiceName 用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定了 redirectIncompatibleRowSettings,则必须指定 。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()
path 用于存储重定向不兼容行数据的路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
{customized property} 对于 Bicep,可以使用 任何 () 函数。

CopySink

名称 说明
sinkRetryCount 接收器重试计数。 类型:integer (或 expression with resultType integer) 。 对于 Bicep,可以使用 任何 () 函数。
sinkRetryWait 接收器重试等待。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。
writeBatchSize 写入批大小。 类型:整数 (或 resultType 整数) 的表达式,最小值:0。 对于 Bicep,可以使用 任何 () 函数。
writeBatchTimeout 写入批处理超时。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。

CopySource

名称 说明
sourceRetryCount 源重试计数。 类型:integer (或 expression with resultType integer) 。 对于 Bicep,可以使用 任何 () 函数。
sourceRetryWait 源重试等待。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。

StagingSettings

名称 说明
enableCompression 指定在通过临时暂存复制数据时是否使用压缩。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。 对于 Bicep,可以使用 任何 () 函数。
linkedServiceName 暂存链接服务引用。 LinkedServiceReference (必需)
path 用于存储临时数据的存储路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
{customized property} 对于 Bicep,可以使用 任何 () 函数。

“CustomActivity”

名称 说明 Value
type 活动的类型。 “自定义” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 自定义活动属性。 CustomActivityTypeProperties (必需)

CustomActivityTypeProperties

名称 说明 Value
command 自定义活动类型的命令:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
extendedProperties 用户定义的属性包。 对可以使用的键或值没有限制。 用户指定的自定义活动完全负责使用和解释定义的内容。 CustomActivityTypePropertiesExtendedProperties
folderPath 资源文件的文件夹路径 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
referenceObjects 引用对象 CustomActivityReferenceObject
resourceLinkedService 资源链接服务参考。 LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

CustomActivityReferenceObject

名称 说明
datasets 数据集引用。 DatasetReference[]
linkedServices 链接服务引用。 LinkedServiceReference[]

DatabricksNotebookActivity

名称 说明 Value
type 活动的类型。 “DatabricksNotebook” (必需的)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Databricks Notebook 活动属性。 DatabricksNotebookActivityTypeProperties (必需)

DatabricksNotebookActivityTypeProperties

名称 说明
baseParameters 要用于此作业的每次运行的基本参数。如果笔记本采用未指定的参数,则将使用笔记本中的默认值。 DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath 要在 Databricks 工作区中运行的 Notebook 的绝对路径。 此路径必须以斜杠开头。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)

DatabricksNotebookActivityTypePropertiesBaseParamete...

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

DataLakeAnalyticsUsqlActivity

名称 说明 Value
type 活动的类型。 需要“DataLakeAnalyticsU-SQL” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Data Lake Analytics U-SQL 活动属性。 DataLakeAnalyticsUsqlActivityTypeProperties (必需)

DataLakeAnalyticsUsqlActivityTypeProperties

名称 说明
compilationMode U-SQL 编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
degreeOfParallelism 同时用于运行作业的最大节点数。 默认值为 1。 类型:整数 (或 resultType 整数) 表达式,最小值:1。 对于 Bicep,可以使用 任何 () 函数。
parameters U-SQL 作业请求的参数。 DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority 确定应在所有排队的作业中选择哪些作业首先运行。 编号越低,优先级越高。 默认值为 1000。 类型:整数 (或 resultType 整数) 表达式,最小值:1。 对于 Bicep,可以使用 任何 () 函数。
runtimeVersion 要使用的 U-SQL 引擎的运行时版本。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference (必需)
scriptPath 包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

ExecutePipelineActivity

名称 说明 Value
type 活动的类型。 “ExecutePipeline” (必需)
typeProperties 执行管道活动属性。 ExecutePipelineActivityTypeProperties (必需)

ExecutePipelineActivityTypeProperties

名称 说明
parameters 管道参数。 ParameterValueSpecification
管道 管道引用。 PipelineReference (必需)
waitOnCompletion 定义活动执行是否将等待依赖管道执行完成。 默认值为 false。 bool

PipelineReference

名称 说明
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需)

ExecuteSsisPackageActivity

名称 说明 Value
type 活动的类型。 “ExecuteSSISPackage” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 执行 SSIS 包活动属性。 ExecuteSsisPackageActivityTypeProperties (必需的)

ExecuteSsisPackageActivityTypeProperties

名称 说明
connectVia 集成运行时引用。 IntegrationRuntimeReference (必需)
environmentPath 用于执行 SSIS 包的环境路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
executionCredential 包执行凭据。 SsisExecutionCredential
loggingLevel SSIS 包执行的日志记录级别。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
logLocation SSIS 包执行日志位置。 SsisLogLocation
packageConnectionManagers 用于执行 SSIS 包的包级连接管理器。 ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation SSIS 包位置。 需要 SsisPackageLocation ()
packageParameters 要执行 SSIS 包的包级别参数。 ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers 用于执行 SSIS 包的项目级连接管理器。 ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters 用于执行 SSIS 包的项目级参数。 ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides 属性重写以执行 SSIS 包。 ExecuteSsisPackageActivityTypePropertiesPropertyOver...
Runtime — 运行时 指定要执行 SSIS 包的运行时。 该值应为“x86”或“x64”。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。

IntegrationRuntimeReference

名称 说明
parameters 集成运行时的参数。 ParameterValueSpecification
referenceName 引用集成运行时名称。 字符串 (必需)
类型 集成运行时的类型。 “IntegrationRuntimeReference” (必需)

SsisExecutionCredential

名称 说明
Windows 身份验证的域。 对于 Bicep,可以使用 所需的任何 () function. ()
password Windows 身份验证的密码。 需要 SecureString ()
userName UseName 用于 Windows 身份验证。 对于 Bicep,可以使用 所需的任何 () function. ()

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
value 安全字符串的值。 字符串 (必需)

SsisLogLocation

名称 说明
logPath SSIS 包执行日志路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()
类型 SSIS 日志位置的类型。 “File” (必需)
typeProperties SSIS 包执行日志位置属性。 SsisLogLocationTypeProperties (所需的)

SsisLogLocationTypeProperties

名称 说明
accessCredential 包执行日志访问凭据。 SsisAccessCredential
logRefreshInterval 指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。

SsisAccessCredential

名称 说明
Windows 身份验证的域。 对于 Bicep,可以使用 所需的任何 () function. ()
password Windows 身份验证的密码。 需要 secretBase ()
userName UseName 用于 Windows 身份验证。 对于 Bicep,可以使用 所需的任何 () function. ()

SecretBase

名称 说明 Value
type 设置对象类型 AzureKeyVaultSecret
需要 SecureString ()

AzureKeyVaultSecretReference

名称 说明 Value
type 机密的类型。 “AzureKeyVaultSecret” (必需)
secretName Azure 密钥保管库中机密的名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()
secretVersion Azure 密钥保管库 中的机密版本。 默认值为最新版本的机密。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
store Azure 密钥保管库链接服务参考。 LinkedServiceReference (必需)

ExecuteSsisPackageActivityTypePropertiesPackageConne...

名称 说明
{customized property} SsisConnectionManager

SsisConnectionManager

名称 说明
{customized property} SsisExecutionParameter

SsisExecutionParameter

名称 说明
value SSIS 包执行参数值。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()

SsisPackageLocation

名称 说明
packagePath SSIS 包路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 所需的任何 () function. ()
类型 SSIS 包位置的类型。 'File'
'SSISDB'
typeProperties SSIS 包位置属性。 SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

名称 说明
accessCredential 包访问凭据。 SsisAccessCredential
configurationPath 包执行的配置文件。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
packagePassword 包的密码。 SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

名称 说明
{customized property} SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

名称 说明
{customized property} SsisPropertyOverride

SsisPropertyOverride

名称 说明
isSensitive SSIS 包属性重写值是否为敏感数据。 如果值为 true,则会在 SSISDB 中加密值 bool
value SSIS 包属性重写值。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)

FilterActivity

名称 说明 Value
type 活动的类型。 “Filter” (必需)
typeProperties 筛选活动属性。 FilterActivityTypeProperties (必需)

FilterActivityTypeProperties

名称 说明
condition 要用于筛选输入的条件。 表达式 (必需)
items 应该应用筛选器的输入数组。 表达式 (必需)

Expression

名称 说明 Value
type 表达式类型。 “Expression” (必需)
value 表达式值。 字符串 (必需)

ForEach 活动

名称 说明 Value
type 活动的类型。 “ForEach” (必需)
typeProperties ForEach 活动属性。 ForEachActivityTypeProperties (必需)

ForEachActivityTypeProperties

名称 说明
活动 要执行 的活动列表。 活动[] (必需的)
batchCount 要用于控制并行执行数的批计数(当 isSequential 设为 false 时)。 int

约束:
最大值 = 50
isSequential 循环应按顺序或并行执行 (最大 50) bool
items 要循环访问的集合。 需要表达式 ()

GetMetadataActivity

名称 说明 Value
type 活动的类型。 “GetMetadata” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties GetMetadata 活动属性。 GetMetadataActivityTypeProperties (必需)

GetMetadataActivityTypeProperties

名称 说明
dataset GetMetadata 活动数据集参考。 DatasetReference (必需)
fieldList 要从数据集获取的元数据的字段。 any[]

HDInsightHiveActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightHive” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Hive 活动属性。 HDInsightHiveActivityTypeProperties (必需)

HDInsightHiveActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Hive 作业请求指定定义。 HDInsightHiveActivityTypePropertiesDefines
getDebugInfo 调试信息选项。 “Always”
“失败”
“None”
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。 对于 Bicep,可以使用 任何 () 函数。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

HDInsightMapReduceActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightMapReduce” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight MapReduce 活动属性。 HDInsightMapReduceActivityTypeProperties (必需)

HDInsightMapReduceActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
className 类名。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
定义 允许用户为 MapReduce 作业请求指定定义。 HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
jarFilePath Jar 路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
jarLibs Jar libs。 any[]
jarLinkedService Jar 链接服务参考。 LinkedServiceReference
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

HDInsightPigActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightPig” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Pig 活动属性。 需要 HDInsightPigActivityTypeProperties ()

HDInsightPigActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Pig 作业请求指定定义。 HDInsightPigActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

HDInsightSparkActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightSpark” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight spark 活动属性。 HDInsightSparkActivityTypeProperties (必需)

HDInsightSparkActivityTypeProperties

名称 说明
参数 HDInsightSparkActivity 的用户指定参数。 any[]
className 应用程序的 Java/Spark main 类。 字符串
entryFilePath 要执行的代码/包的根文件夹的相对路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
proxyUser 要模拟将执行作业的用户。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
rootPath “sparkJobLinkedService”中所有作业文件的根路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
sparkConfig Spark 配置属性。 HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService 用于上传入口文件和依赖项以及用于接收日志的存储链接服务。 LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

HDInsightStreamingActivity

名称 说明 Value
type 活动的类型。 “HDInsightStreaming” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight 流式处理活动属性。 HDInsightStreamingActivityTypeProperties (必需)

HDInsightStreamingActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
combiner 组合器可执行文件名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
commandEnvironment 命令行环境值。 any[]
定义 允许用户指定流式处理作业请求的定义。 HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService 文件所在的链接服务引用。 LinkedServiceReference
filePaths 流式处理作业文件的路径。 可以是目录。 any[] (必需)
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
input 输入 Blob 路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
mapper 映射器可执行文件名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
输出 输出 Blob 路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
reducer 化简器可执行文件名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

名称 说明
{customized property} 对于 Bicep,可以使用 任何 () 函数。

IfConditionActivity

名称 说明 Value
type 活动的类型。 “IfCondition” (必需)
typeProperties IfCondition 活动属性。 IfConditionActivityTypeProperties (必需)

IfConditionActivityTypeProperties

名称 说明
表达式 计算结果为布尔值的表达式。 这用于确定将执行的 ifTrueActivities 或 ifFalseActivities) (活动块。 表达式 (必需)
ifFalseActivities 表达式计算结果为 false 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]
ifTrueActivities 表达式计算结果为 true 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]

LookupActivity

名称 说明 Value
type 活动的类型。 “Lookup” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 查找活动属性。 LookupActivityTypeProperties (必需)

LookupActivityTypeProperties

名称 说明
dataset 查找活动数据集引用。 DatasetReference (必需)
firstRowOnly 是返回第一行还是所有行。 默认值为 true。 类型:boolean (或 expression with resultType boolean) 。 对于 Bicep,可以使用 任何 () 函数。
source 特定于数据集的源属性,与复制活动源相同。 CopySource (必需)

SqlServerStoredProcedureActivity

名称 说明 Value
type 活动的类型。 “SqlServerStoredProcedure” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties SQL 存储过程活动属性。 SqlServerStoredProcedureActivityTypeProperties (必需)

SqlServerStoredProcedureActivityTypeProperties

名称 说明
storedProcedureName 存储过程名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)
storedProcedureParameters 存储过程参数的值和类型设置。 示例:“{Parameter1: {value: ”1“, type: ”int“}}”。 SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

名称 说明
{customized property} StoredProcedureParameter

StoredProcedureParameter

名称 说明 Value
type 存储过程参数类型。 “Boolean”
“Date”
“Decimal”
“Guid”
“Int”
“Int64”
“String”
value 存储过程参数值。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)

UntilActivity

名称 说明 Value
type 活动的类型。 “Until” (必需)
typeProperties 直到活动属性。 UntilActivityTypeProperties (必需)

UntilActivityTypeProperties

名称 说明
活动 要执行的活动的列表。 活动[] (必需的)
表达式 计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true 表达式 (必需)
timeout 指定活动运行的超时。 如果未指定值,则采用 TimeSpan.FromDays (7) 默认值为 1 周。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 对于 Bicep,可以使用 任何 () 函数。

WaitActivity

名称 说明 Value
type 活动的类型。 “等待” (必需)
typeProperties 等待活动属性。 WaitActivityTypeProperties (必需)

WaitActivityTypeProperties

名称 说明
waitTimeInSeconds 持续时间(以秒为单位)。 int (必需)

Web 活动

名称 说明 Value
type 活动的类型。 “WebActivity” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Web 活动属性。 WebActivityTypeProperties (必需)

WebActivityTypeProperties

名称 说明
authentication 用于调用该终结点的身份验证方法。 WebActivityAuthentication
body 表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,GET 方法类型不允许:字符串 (或表达式与 resultType 字符串) 。 对于 Bicep,可以使用 任何 () 函数。
datasets 传递给 Web 终结点的数据集列表。 DatasetReference[]
disableCertValidation 设置为 true 时,将禁用证书验证。 bool
headers 表示将发送到请求的标头。 例如,若要在请求中设置语言和类型:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () 函数。
linkedServices 传递给 Web 终结点的链接服务列表。 LinkedServiceReference[]
method 目标终结点的 Rest API 方法。 “DELETE”
“GET”
“POST”
“PUT” (必需)
url Web 活动目标终结点和路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。 对于 Bicep,可以使用 任何 () function. (所需的)

WebActivityAuthentication

名称 说明
password PFX 文件或基本身份验证的密码。 SecureString
pfx PFX 文件的 Base64 编码内容。 SecureString
resource 使用 MSI 身份验证时将为其请求 Azure 身份验证令牌的资源。 字符串
type Web 活动身份验证 (Basic/ClientCertificate/MSI) 字符串 (必需)
username 用于基本身份验证的 Web 活动身份验证用户名。 字符串

ParameterDefinitionSpecification

名称 说明
{customized property} ParameterSpecification

ParameterSpecification

名称 说明
defaultValue 参数的默认值。 对于 Bicep,可以使用 任何 () 函数。
类型 参数类型。 “Array”
“Bool”
“Float”
“Int”
“Object”
“SecureString”
“String” (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
Azure 数据工厂可以执行更多操作 - 单击一次尝试Azure 数据工厂

部署到 Azure
此模板为复制活动从 Azure Blob 到另一个 Azure Blob 创建数据工厂管道
创建数据工厂,从 Salesforce 复制到 Blob

部署到 Azure
此模板使用 Azure 数据工厂 执行从 Salesforce 到 Azure Blob 的数据移动
使用 Azure 数据工厂 进行大容量复制

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据批量复制到Azure SQL数据库Azure SQL数据仓库。
创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。
(MySQL) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for MySQL中的表中。
(PostGre) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for PostgreSQL中的表中。
(SQL) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure SQL数据库中的表中。
(SQL 本地) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从本地SQL Server复制到 Azure Blob 存储
(Spark) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。

ARM 模板资源定义

工厂/管道资源类型可以通过针对以下操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.DataFactory/factories/pipelines",
  "apiVersion": "2017-09-01-preview",
  "name": "string",
  "properties": {
    "activities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "annotations": [ object ],
    "concurrency": "int",
    "description": "string",
    "parameters": {
      "{customized property}": {
        "defaultValue": {},
        "type": "string"
      }
    }
  }
}

活动对象

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

对于 AzureMLBatchExecution,请使用:

  "type": "AzureMLBatchExecution",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "globalParameters": {
      "{customized property}": {}
    },
    "webServiceInputs": {
      "{customized property}": {
        "filePath": {},
        "linkedServiceName": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      }
    },
    "webServiceOutputs": {
      "{customized property}": {
        "filePath": {},
        "linkedServiceName": {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      }
    }
  }

对于 AzureMLUpdateResource,请使用:

  "type": "AzureMLUpdateResource",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "trainedModelFilePath": {},
    "trainedModelLinkedServiceName": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "trainedModelName": {}
  }

对于 “复制”,请使用:

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

对于 “自定义”,请使用:

  "type": "Custom",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "command": {},
    "extendedProperties": {
      "{customized property}": {}
    },
    "folderPath": {},
    "referenceObjects": {
      "datasets": [
        {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "DatasetReference"
        }
      ],
      "linkedServices": [
        {
          "parameters": {
            "{customized property}": {}
          },
          "referenceName": "string",
          "type": "LinkedServiceReference"
        }
      ]
    },
    "resourceLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    }
  }

对于 DatabricksNotebook,请使用:

  "type": "DatabricksNotebook",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "baseParameters": {
      "{customized property}": {}
    },
    "notebookPath": {}
  }

对于 DataLakeAnalyticsU-SQL,请使用:

  "type": "DataLakeAnalyticsU-SQL",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "compilationMode": {},
    "degreeOfParallelism": {},
    "parameters": {
      "{customized property}": {}
    },
    "priority": {},
    "runtimeVersion": {},
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {}
  }

对于 ExecutePipeline,请使用:

  "type": "ExecutePipeline",
  "typeProperties": {
    "parameters": {
      "{customized property}": {}
    },
    "pipeline": {
      "name": "string",
      "referenceName": "string",
      "type": "PipelineReference"
    },
    "waitOnCompletion": "bool"
  }

对于 ExecuteSSISPackage,请使用:

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

对于 筛选器,请使用:

  "type": "Filter",
  "typeProperties": {
    "condition": {
      "type": "Expression",
      "value": "string"
    },
    "items": {
      "type": "Expression",
      "value": "string"
    }
  }

对于 ForEach,请使用:

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

对于 GetMetadata,请使用:

  "type": "GetMetadata",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "dataset": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "DatasetReference"
    },
    "fieldList": [ object ]
  }

对于 HDInsightHive,请使用:

  "type": "HDInsightHive",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightMapReduce,请使用:

  "type": "HDInsightMapReduce",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "className": {},
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "jarFilePath": {},
    "jarLibs": [ object ],
    "jarLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightPig,请使用:

  "type": "HDInsightPig",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "getDebugInfo": "string",
    "scriptLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "scriptPath": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightSpark,请使用:

  "type": "HDInsightSpark",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "className": "string",
    "entryFilePath": {},
    "getDebugInfo": "string",
    "proxyUser": {},
    "rootPath": {},
    "sparkConfig": {
      "{customized property}": {}
    },
    "sparkJobLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    }
  }

对于 HDInsightStreaming,请使用:

  "type": "HDInsightStreaming",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "arguments": [ object ],
    "combiner": {},
    "commandEnvironment": [ object ],
    "defines": {
      "{customized property}": {}
    },
    "fileLinkedService": {
      "parameters": {
        "{customized property}": {}
      },
      "referenceName": "string",
      "type": "LinkedServiceReference"
    },
    "filePaths": [ object ],
    "getDebugInfo": "string",
    "input": {},
    "mapper": {},
    "output": {},
    "reducer": {},
    "storageLinkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ]
  }

对于 IfCondition,请使用:

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

对于 查找,请使用:

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

对于 SqlServerStoredProcedure,请使用:

  "type": "SqlServerStoredProcedure",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "storedProcedureName": {},
    "storedProcedureParameters": {
      "{customized property}": {
        "type": "string",
        "value": {}
      }
    }
  }

对于 “直到”,请使用:

  "type": "Until",
  "typeProperties": {
    "activities": [
      {
        "dependsOn": [
          {
            "activity": "string",
            "dependencyConditions": [ "string" ],
            "{customized property}": {}
          }
        ],
        "description": "string",
        "name": "string",
        "type": "string"
        // For remaining properties, see Activity objects
      }
    ],
    "expression": {
      "type": "Expression",
      "value": "string"
    },
    "timeout": {}
  }

对于 “等待”,请使用:

  "type": "Wait",
  "typeProperties": {
    "waitTimeInSeconds": "int"
  }

对于 WebActivity,请使用:

  "type": "WebActivity",
  "linkedServiceName": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  },
  "policy": {
    "retry": {},
    "retryIntervalInSeconds": "int",
    "secureOutput": "bool",
    "timeout": {},
    "{customized property}": {}
  },
  "typeProperties": {
    "authentication": {
      "password": {
        "type": "string",
        "value": "string"
      },
      "pfx": {
        "type": "string",
        "value": "string"
      },
      "resource": "string",
      "type": "string",
      "username": "string"
    },
    "body": {},
    "datasets": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "DatasetReference"
      }
    ],
    "disableCertValidation": "bool",
    "headers": {},
    "linkedServices": [
      {
        "parameters": {
          "{customized property}": {}
        },
        "referenceName": "string",
        "type": "LinkedServiceReference"
      }
    ],
    "method": "string",
    "url": {}
  }

CopySink 对象

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

CopySource 对象

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

SecretBase 对象

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

对于 AzureKeyVaultSecret,请使用:

  "type": "AzureKeyVaultSecret",
  "secretName": {},
  "secretVersion": {},
  "store": {
    "parameters": {
      "{customized property}": {}
    },
    "referenceName": "string",
    "type": "LinkedServiceReference"
  }

对于 SecureString,请使用:

  "type": "SecureString",
  "value": "string"

属性值

factories/pipelines

名称 说明 Value
type 资源类型 “Microsoft.DataFactory/factories/pipelines”
apiVersion 资源 API 版本 “2017-09-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
properties 管道的属性。 需要管道 ()

管道

名称 说明
活动 管道中的活动列表。 Activity[]
annotations 可用于描述管道的标记列表。 any[]
concurrency 管道的最大并发运行数。 int

约束:
最小值 = 1
description 管道的说明。 字符串
parameters 管道的参数列表。 ParameterDefinitionSpecification

活动

名称 说明
dependsOn 活动取决于条件。 ActivityDependency[]
description 活动说明。 字符串
name 活动名称。 字符串 (必需)
类型 设置对象类型 AzureMLBatchExecution
AzureMLUpdateResource
复制
自定义
DatabricksNotebook
DataLakeAnalyticsU-SQL
ExecutePipeline
ExecuteSSISPackage
Filter
ForEach
GetMetadata
HDInsightHive
HDInsightMapReduce
HDInsightPig
HDInsightSpark
HDInsightStreaming
IfCondition
查找
SqlServerStoredProcedure
截止
Wait
所需的 WebActivity ()

ActivityDependency

名称 说明
activity 活动名称。 字符串 (必需)
dependencyConditions 依赖项的 Match-Condition。 包含任意项的字符串数组:
“Completed”
“失败”
“已跳过”
“成功” (必需)
{customized property}

AzureMLBatchExecutionActivity

名称 说明 Value
type 活动的类型。 “AzureMLBatchExecution” (必需的)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML Batch 执行活动属性。 AzureMLBatchExecutionActivityTypeProperties (必需的)

LinkedServiceReference

名称 说明
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ParameterValueSpecification

名称 说明
{customized property}

ActivityPolicy

名称 说明
retry 最大普通重试尝试次数。 默认为 0。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
retryIntervalInSeconds 每次重试尝试 (间隔(以秒) 为单位)。 默认值为 30 秒。 int

约束:
最小值 = 30
最大值 = 86400
secureOutput 设置为 true 时,活动输出被视为安全输出,不会记录到监视。 bool
timeout 指定活动运行的超时。 默认超时为 7 天。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。
{customized property}

AzureMLBatchExecutionActivityTypeProperties

名称 说明
globalParameters 要传递给 Azure ML Batch 执行服务终结点的键、值对。 键必须与已发布 Azure ML Web 服务中定义的 Web 服务参数名称匹配。 值将在 Azure ML 批处理执行请求的 GlobalParameters 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
webServiceInputs 键、值对,将 Azure ML 终结点的 Web 服务输入的名称映射到指定输入 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceInputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...
webServiceOutputs 键、值对,将 Azure ML 终结点的 Web 服务输出的名称映射到指定输出 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceOutputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

名称 说明
{customized property}

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLWebServiceFile

名称 说明
filePath LinkedService 指定的Azure Blob 存储中的相对文件路径(包括容器名称)。 类型:包含 resultType 字符串) 的字符串 (或表达式。
linkedServiceName 对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件所在的位置。 LinkedServiceReference (必需)

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLUpdateResourceActivity

名称 说明 Value
type 活动的类型。 “AzureMLUpdateResource” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML 更新资源管理活动属性。 AzureMLUpdateResourceActivityTypeProperties (必需的)

AzureMLUpdateResourceActivityTypeProperties

名称 说明
trainedModelFilePath trainedModelLinkedService 中的相对文件路径,表示更新操作将上传的 .ilearner 文件。 类型:包含 resultType 字符串) 的字符串 (或表达式。
trainedModelLinkedServiceName 包含更新操作将上传的 .ilearner 文件的 Azure 存储链接服务的名称。 LinkedServiceReference (必需)
trainedModelName 要更新的 Web 服务试验中训练的模型模块的名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。

CopyActivity

名称 说明 Value
type 活动的类型。 “复制” (必需的)
inputs 活动的输入列表。 DatasetReference[]
linkedServiceName 链接服务引用。 LinkedServiceReference
outputs 活动的输出列表。 DatasetReference[]
policy 活动策略。 ActivityPolicy
typeProperties 复制活动属性。 CopyActivityTypeProperties (必需)

DatasetReference

名称 说明
parameters 数据集的参数。 ParameterValueSpecification
referenceName 引用数据集名称。 字符串 (必需)
类型 数据集引用类型。 “DatasetReference” (必需)

CopyActivityTypeProperties

名称 说明
cloudDataMovementUnits 可用于执行此数据移动的云数据移动单位的最大数量。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
enableSkipIncompatibleRow 是否跳过不兼容的行。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。
enableStaging 指定是否通过临时暂存复制数据。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。
parallelCopies 在源或接收器上打开的最大并发会话数,以避免数据存储过载。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
redirectIncompatibleRowSettings 当 EnableSkipIncompatibleRow 为 true 时,重定向不兼容行设置。 RedirectIncompatibleRowSettings
接收器 复制活动接收器。 需要 copySink ()
source 复制活动源。 需要 CopySource ()
stagingSettings 指定 EnableStaging 为 true 时的临时暂存设置。 StagingSettings
转换器 复制活动翻译器。 如果未指定,则使用表格翻译器。

RedirectIncompatibleRowSettings

名称 说明
linkedServiceName 用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定了 redirectIncompatibleRowSettings,则必须指定 。 类型:字符串 (或带有 resultType 字符串) 的表达式。
path 用于存储重定向不兼容行数据的路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
{customized property}

CopySink

名称 说明
sinkRetryCount 接收器重试计数。 类型:integer (或 expression with resultType integer) 。
sinkRetryWait 接收器重试等待。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。
writeBatchSize 写入批大小。 类型:整数 (或 resultType 整数) 的表达式,最小值:0。
writeBatchTimeout 写入批处理超时。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

CopySource

名称 说明
sourceRetryCount 源重试计数。 类型:integer (或 expression with resultType integer) 。
sourceRetryWait 源重试等待。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

StagingSettings

名称 说明
enableCompression 指定在通过临时暂存复制数据时是否使用压缩。 默认值为 false。 类型:布尔 (或 resultType 布尔) 表达式。
linkedServiceName 暂存链接服务引用。 LinkedServiceReference (必需)
path 用于存储临时数据的存储路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
{customized property}

“CustomActivity”

名称 说明 Value
type 活动的类型。 需要“自定义” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 自定义活动属性。 CustomActivityTypeProperties (必需)

CustomActivityTypeProperties

名称 说明 Value
command 自定义活动的命令 类型:string (或 expression with resultType string) 。
extendedProperties 用户定义的属性包。 可以使用的键或值没有限制。 用户指定的自定义活动完全负责使用和解释定义的内容。 CustomActivityTypePropertiesExtendedProperties
folderPath 资源文件的文件夹路径 类型:string (或 expression with resultType string) 。
referenceObjects 引用对象 CustomActivityReferenceObject
resourceLinkedService 资源链接服务引用。 LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

名称 说明
{customized property}

CustomActivityReferenceObject

名称 说明
datasets 数据集引用。 DatasetReference[]
linkedServices 链接服务引用。 LinkedServiceReference[]

DatabricksNotebookActivity

名称 说明 Value
type 活动的类型。 “DatabricksNotebook” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Databricks Notebook 活动属性。 DatabricksNotebookActivityTypeProperties (必需)

DatabricksNotebookActivityTypeProperties

名称 说明
baseParameters 要用于此作业的每次运行的基本参数。如果笔记本采用未指定的参数,将使用笔记本中的默认值。 DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath 要在 Databricks 工作区中运行的 Notebook 的绝对路径。 此路径必须以斜杠开头。 类型:字符串 (或带有 resultType 字符串) 的表达式。

DatabricksNotebookActivityTypePropertiesBaseParamete...

名称 说明
{customized property}

DataLakeAnalyticsUsqlActivity

名称 说明 Value
type 活动的类型。 需要“DataLakeAnalyticsU-SQL” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Data Lake Analytics U-SQL 活动属性。 DataLakeAnalyticsUsqlActivityTypeProperties (必需)

DataLakeAnalyticsUsqlActivityTypeProperties

名称 说明
compilationMode U-SQL 编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:字符串 (或带有 resultType 字符串) 的表达式。
degreeOfParallelism 同时用于运行作业的最大节点数。 默认值为 1。 类型:整数 (或 resultType 整数) 表达式,最小值:1。
parameters U-SQL 作业请求的参数。 DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority 确定应在所有排队的作业中选择哪些作业首先运行。 编号越低,优先级越高。 默认值为 1000。 类型:整数 (或 resultType 整数) 表达式,最小值:1。
runtimeVersion 要使用的 U-SQL 引擎的运行时版本。 类型:字符串 (或带有 resultType 字符串) 的表达式。
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference (必需)
scriptPath 包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

名称 说明
{customized property}

ExecutePipelineActivity

名称 说明 Value
type 活动的类型。 “ExecutePipeline” (必需)
typeProperties 执行管道活动属性。 ExecutePipelineActivityTypeProperties (必需)

ExecutePipelineActivityTypeProperties

名称 说明
parameters 管道参数。 ParameterValueSpecification
管道 管道引用。 PipelineReference (必需)
waitOnCompletion 定义活动执行是否将等待依赖管道执行完成。 默认值为 false。 bool

PipelineReference

名称 说明
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需的)

ExecuteSsisPackageActivity

名称 说明 Value
type 活动的类型。 “ExecuteSSISPackage” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 执行 SSIS 包活动属性。 ExecuteSsisPackageActivityTypeProperties (必需的)

ExecuteSsisPackageActivityTypeProperties

名称 说明
connectVia 集成运行时引用。 IntegrationRuntimeReference (必需)
environmentPath 用于执行 SSIS 包的环境路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
executionCredential 包执行凭据。 SsisExecutionCredential
loggingLevel SSIS 包执行的日志记录级别。 类型:包含 resultType 字符串) 的字符串 (或表达式。
logLocation SSIS 包执行日志位置。 SsisLogLocation
packageConnectionManagers 用于执行 SSIS 包的包级别连接管理器。 ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation SSIS 包位置。 需要 SsisPackageLocation ()
packageParameters 用于执行 SSIS 包的包级别参数。 ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers 用于执行 SSIS 包的项目级连接管理器。 ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters 用于执行 SSIS 包的项目级参数。 ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides 属性重写以执行 SSIS 包。 ExecuteSsisPackageActivityTypePropertiesPropertyOver...
Runtime — 运行时 指定要执行 SSIS 包的运行时。 该值应为“x86”或“x64”。 类型:包含 resultType 字符串) 的字符串 (或表达式。

IntegrationRuntimeReference

名称 说明
parameters 集成运行时的参数。 ParameterValueSpecification
referenceName 引用集成运行时名称。 字符串 (必需)
类型 集成运行时的类型。 “IntegrationRuntimeReference” (必需)

SsisExecutionCredential

名称 说明
Windows 身份验证的域。
password Windows 身份验证的密码。 需要 SecureString ()
userName 用于 Windows 身份验证的 UseName。

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
value 安全字符串的值。 字符串 (必需)

SsisLogLocation

名称 说明
logPath SSIS 包执行日志路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
类型 SSIS 日志位置的类型。 “File” (必需)
typeProperties SSIS 包执行日志位置属性。 SsisLogLocationTypeProperties (必需)

SsisLogLocationTypeProperties

名称 说明
accessCredential 包执行日志访问凭据。 SsisAccessCredential
logRefreshInterval 指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

SsisAccessCredential

名称 说明
Windows 身份验证的域。
password Windows 身份验证的密码。 需要 secretBase ()
userName 用于 Windows 身份验证的 UseName。

SecretBase

名称 说明 Value
type 设置对象类型 AzureKeyVaultSecret
需要 SecureString ()

AzureKeyVaultSecretReference

名称 说明 Value
type 机密的类型。 “AzureKeyVaultSecret” (必需)
secretName Azure 密钥保管库中机密的名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。
secretVersion Azure 中机密的版本密钥保管库。 默认值为最新版本的机密。 类型:包含 resultType 字符串) 的字符串 (或表达式。
store Azure 密钥保管库链接服务参考。 LinkedServiceReference (必需)

ExecuteSsisPackageActivityTypePropertiesPackageConne...

名称 说明
{customized property} SsisConnectionManager

SsisConnectionManager

名称 说明
{customized property} SsisExecutionParameter

SsisExecutionParameter

名称 说明
value SSIS 包执行参数值。 类型:包含 resultType 字符串) 的字符串 (或表达式。

SsisPackageLocation

名称 说明
packagePath SSIS 包路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
类型 SSIS 包位置的类型。 “文件”
'SSISDB'
typeProperties SSIS 包位置属性。 SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

名称 说明
accessCredential 包访问凭据。 SsisAccessCredential
configurationPath 包执行的配置文件。 类型:包含 resultType 字符串) 的字符串 (或表达式。
packagePassword 包的密码。 SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

名称 说明
{customized property} SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

名称 说明
{customized property} SsisPropertyOverride

SsisPropertyOverride

名称 说明
isSensitive SSIS 包属性重写值是否为敏感数据。 如果值为 true,则会在 SSISDB 中加密值 bool
value SSIS 包属性重写值。 类型:包含 resultType 字符串) 的字符串 (或表达式。

FilterActivity

名称 说明 Value
type 活动的类型。 “Filter” (必需)
typeProperties 筛选活动属性。 FilterActivityTypeProperties (必需)

FilterActivityTypeProperties

名称 说明
condition 要用于筛选输入的条件。 表达式 (必需)
items 应该应用筛选器的输入数组。 表达式 (必需)

Expression

名称 说明 Value
type 表达式类型。 “Expression” (必需)
value 表达式值。 字符串 (必需)

ForEach 活动

名称 说明 Value
type 活动的类型。 “ForEach” (必需)
typeProperties ForEach 活动属性。 ForEachActivityTypeProperties (必需)

ForEachActivityTypeProperties

名称 说明
活动 要执行 的活动列表。 活动[] (必需的)
batchCount 要用于控制并行执行数的批计数(当 isSequential 设为 false 时)。 int

约束:
最大值 = 50
isSequential 循环应按顺序或并行执行 (最大 50) bool
items 要循环访问的集合。 表达式 (必需)

GetMetadataActivity

名称 说明 Value
type 活动的类型。 “GetMetadata” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties GetMetadata 活动属性。 GetMetadataActivityTypeProperties (必需)

GetMetadataActivityTypeProperties

名称 说明
dataset GetMetadata 活动数据集参考。 DatasetReference (必需)
fieldList 要从数据集获取的元数据字段。 any[]

HDInsightHiveActivity

名称 说明 Value
type 活动的类型。 “HDInsightHive” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Hive 活动属性。 HDInsightHiveActivityTypeProperties (必需)

HDInsightHiveActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Hive 作业请求指定定义。 HDInsightHiveActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightMapReduceActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightMapReduce” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight MapReduce 活动属性。 HDInsightMapReduceActivityTypeProperties (必需)

HDInsightMapReduceActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
className 类名。 类型:包含 resultType 字符串) 的字符串 (或表达式。
定义 允许用户为 MapReduce 作业请求指定定义。 HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
jarFilePath Jar 路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
jarLibs Jar libs。 any[]
jarLinkedService Jar 链接服务参考。 LinkedServiceReference
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightPigActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightPig” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Pig 活动属性。 需要 HDInsightPigActivityTypeProperties ()

HDInsightPigActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Pig 作业请求指定定义。 HDInsightPigActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
“None”
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightSparkActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightSpark” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight spark 活动属性。 HDInsightSparkActivityTypeProperties (必需)

HDInsightSparkActivityTypeProperties

名称 说明
参数 HDInsightSparkActivity 的用户指定参数。 any[]
className 应用程序的 Java/Spark main 类。 字符串
entryFilePath 要执行的代码/包的根文件夹的相对路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
getDebugInfo 调试信息选项。 “Always”
“失败”
“None”
proxyUser 要模拟将执行作业的用户。 类型:字符串 (或带有 resultType 字符串) 的表达式。
rootPath “sparkJobLinkedService”中所有作业文件的根路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
sparkConfig Spark 配置属性。 HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService 用于上传入口文件和依赖项以及用于接收日志的存储链接服务。 LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

名称 说明
{customized property}

HDInsightStreamingActivity

名称 说明 Value
type 活动的类型。 “HDInsightStreaming” (所需的)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight 流式处理活动属性。 HDInsightStreamingActivityTypeProperties (必需)

HDInsightStreamingActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
combiner 组合器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
commandEnvironment 命令行环境值。 any[]
定义 允许用户为流式处理作业请求指定定义。 HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService 文件所在的链接服务引用。 LinkedServiceReference
filePaths 流式处理作业文件的路径。 可以是目录。 any[] (必需)
getDebugInfo 调试信息选项。 “Always”
“失败”
“None”
input 输入 Blob 路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
mapper 映射器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
output 输出 Blob 路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
reducer 化简器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

名称 说明
{customized property}

IfConditionActivity

名称 说明 Value
type 活动的类型。 “IfCondition” (必需)
typeProperties IfCondition 活动属性。 IfConditionActivityTypeProperties (必需)

IfConditionActivityTypeProperties

名称 说明
表达式 计算结果为布尔值的表达式。 这用于确定将执行的 ifTrueActivities 或 ifFalseActivities) (活动块。 需要表达式 ()
ifFalseActivities 表达式计算结果为 false 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]
ifTrueActivities 表达式计算结果为 true 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]

LookupActivity

名称 说明 Value
type 活动的类型。 “Lookup” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 查找活动属性。 LookupActivityTypeProperties (必需)

LookupActivityTypeProperties

名称 说明
dataset 查找活动数据集引用。 DatasetReference (必需)
firstRowOnly 是返回第一行还是返回所有行。 默认值为 true。 类型:布尔 (或 resultType 布尔) 表达式。
source 特定于数据集的源属性,与复制活动源相同。 需要 CopySource ()

SqlServerStoredProcedureActivity

名称 说明 Value
type 活动的类型。 “SqlServerStoredProcedure” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties SQL 存储过程活动属性。 SqlServerStoredProcedureActivityTypeProperties (必需)

SqlServerStoredProcedureActivityTypeProperties

名称 说明
storedProcedureName 存储过程名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
storedProcedureParameters 存储过程参数的值和类型设置。 示例:“{Parameter1: {value: ”1“,类型:”int“}}”。 SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

名称 说明
{customized property} StoredProcedureParameter

StoredProcedureParameter

名称 说明 Value
type 存储过程参数类型。 “布尔值”
'Date'
“Decimal”
“Guid”
“Int”
“Int64”
'String'
value 存储过程参数值。 类型:字符串 (或带有 resultType 字符串) 的表达式。

UntilActivity

名称 说明 Value
type 活动的类型。 “Until” (必需)
typeProperties 直到活动属性。 UntilActivityTypeProperties (必需)

UntilActivityTypeProperties

名称 说明
活动 要执行的活动的列表。 活动[] (必需)
表达式 计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true 需要表达式 ()
timeout 指定活动运行的超时。 如果未指定值,则采用 TimeSpan.FromDays (7) 默认值为 1 周的值。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

WaitActivity

名称 说明 Value
type 活动的类型。 需要“等待” ()
typeProperties 等待活动属性。 WaitActivityTypeProperties (必需)

WaitActivityTypeProperties

名称 说明
waitTimeInSeconds 持续时间(以秒为单位)。 int (必需)

Web 活动

名称 说明 Value
type 活动的类型。 “WebActivity” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Web 活动属性。 WebActivityTypeProperties (必需)

WebActivityTypeProperties

名称 说明
authentication 用于调用该终结点的身份验证方法。 WebActivityAuthentication
body 表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,GET 方法类型不允许:字符串 (或带有 resultType 字符串的表达式) 。
datasets 传递给 Web 终结点的数据集列表。 DatasetReference[]
disableCertValidation 设置为 true 时,将禁用证书验证。 bool
headers 表示将发送到请求的标头。 例如,若要在请求中设置语言和类型:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 类型:字符串 (或带有 resultType 字符串) 的表达式。
linkedServices 传递给 Web 终结点的链接服务的列表。 LinkedServiceReference[]
method 目标终结点的 Rest API 方法。 'DELETE'
'GET'
“POST”
“PUT” ()
url Web 活动目标终结点和路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。

WebActivityAuthentication

名称 说明
password PFX 文件或基本身份验证的密码。 SecureString
pfx PFX 文件的 Base64 编码内容。 SecureString
resource 使用 MSI 身份验证时将为其请求 Azure 身份验证令牌的资源。 字符串
type Web 活动身份验证 (Basic/ClientCertificate/MSI) 字符串 (必需)
username 用于基本身份验证的 Web 活动身份验证用户名。 字符串

ParameterDefinitionSpecification

名称 说明
{customized property} ParameterSpecification

ParameterSpecification

名称 说明
defaultValue 参数的默认值。
类型 参数类型。 “Array”
“Bool”
“Float”
“Int”
“Object”
“SecureString”
“String” (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
Azure 数据工厂可以执行更多操作 - 单击一次尝试Azure 数据工厂

部署到 Azure
此模板为复制活动从 Azure Blob 到另一个 Azure Blob 创建数据工厂管道
创建数据工厂,从 Salesforce 复制到 Blob

部署到 Azure
此模板使用 Azure 数据工厂 执行从 Salesforce 到 Azure Blob 的数据移动
使用 Azure 数据工厂 进行大容量复制

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据批量复制到Azure SQL数据库Azure SQL数据仓库。
创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。
(MySQL) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for MySQL中的表中。
(PostGre) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for PostgreSQL中的表中。
(SQL) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到Azure SQL数据库中的表中。
(SQL 本地) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从本地SQL Server复制到 Azure Blob 存储
(Spark) 创建 V2 数据工厂

部署到 Azure
此模板创建一个 V2 数据工厂,用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。

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

工厂/管道资源类型可以通过针对以下操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/pipelines@2017-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      activities = [
        {
          dependsOn = [
            {
              activity = "string"
              dependencyConditions = [
                "string"
              ]
            }
          ]
          description = "string"
          name = "string"
          type = "string"
          // For remaining properties, see Activity objects
        }
      ]
      annotations = [ object ]
      concurrency = int
      description = "string"
      parameters = {
        {customized property} = {
          type = "string"
        }
      }
    }
  })
}

活动对象

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

对于 AzureMLBatchExecution,请使用:

  type = "AzureMLBatchExecution"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    globalParameters = {}
    webServiceInputs = {
      {customized property} = {
        linkedServiceName = {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      }
    }
    webServiceOutputs = {
      {customized property} = {
        linkedServiceName = {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      }
    }
  }

对于 AzureMLUpdateResource,请使用:

  type = "AzureMLUpdateResource"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    trainedModelLinkedServiceName = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

对于 “复制”,请使用:

  type = "Copy"
  inputs = [
    {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
  ]
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  outputs = [
    {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
  ]
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    redirectIncompatibleRowSettings = {}
    sink = {
      // For remaining properties, see CopySink objects
    }
    source = {
      // For remaining properties, see CopySource objects
    }
    stagingSettings = {
      linkedServiceName = {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    }
  }

对于 “自定义”,请使用:

  type = "Custom"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    extendedProperties = {}
    referenceObjects = {
      datasets = [
        {
          parameters = {}
          referenceName = "string"
          type = "DatasetReference"
        }
      ]
      linkedServices = [
        {
          parameters = {}
          referenceName = "string"
          type = "LinkedServiceReference"
        }
      ]
    }
    resourceLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

对于 DatabricksNotebook,请使用:

  type = "DatabricksNotebook"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    baseParameters = {}
  }

对于 DataLakeAnalyticsU-SQL,请使用:

  type = "DataLakeAnalyticsU-SQL"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    parameters = {}
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

对于 ExecutePipeline,请使用:

  type = "ExecutePipeline"
  typeProperties = {
    parameters = {}
    pipeline = {
      name = "string"
      referenceName = "string"
      type = "PipelineReference"
    }
    waitOnCompletion = bool
  }

对于 ExecuteSSISPackage,请使用:

  type = "ExecuteSSISPackage"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    connectVia = {
      parameters = {}
      referenceName = "string"
      type = "IntegrationRuntimeReference"
    }
    executionCredential = {
      password = {
        type = "string"
        value = "string"
      }
    }
    logLocation = {
      type = "File"
      typeProperties = {
        accessCredential = {
          password = {
            type = "string"
            // For remaining properties, see SecretBase objects
          }
        }
      }
    }
    packageConnectionManagers = {
      {customized property} = {
        {customized property} = {}
      }
    }
    packageLocation = {
      type = "string"
      typeProperties = {
        accessCredential = {
          password = {
            type = "string"
            // For remaining properties, see SecretBase objects
          }
        }
        packagePassword = {
          type = "string"
          // For remaining properties, see SecretBase objects
        }
      }
    }
    packageParameters = {
      {customized property} = {}
    }
    projectConnectionManagers = {
      {customized property} = {
        {customized property} = {}
      }
    }
    projectParameters = {
      {customized property} = {}
    }
    propertyOverrides = {
      {customized property} = {
        isSensitive = bool
      }
    }
  }

对于 筛选器,请使用:

  type = "Filter"
  typeProperties = {
    condition = {
      type = "Expression"
      value = "string"
    }
    items = {
      type = "Expression"
      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 = "Expression"
      value = "string"
    }
  }

对于 GetMetadata,请使用:

  type = "GetMetadata"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    dataset = {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
    fieldList = [ object ]
  }

对于 HDInsightHive,请使用:

  type = "HDInsightHive"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightMapReduce,请使用:

  type = "HDInsightMapReduce"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    jarLibs = [ object ]
    jarLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightPig,请使用:

  type = "HDInsightPig"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    defines = {}
    getDebugInfo = "string"
    scriptLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

对于 HDInsightSpark,请使用:

  type = "HDInsightSpark"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    className = "string"
    getDebugInfo = "string"
    sparkConfig = {}
    sparkJobLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
  }

对于 HDInsightStreaming,请使用:

  type = "HDInsightStreaming"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    arguments = [ object ]
    commandEnvironment = [ object ]
    defines = {}
    fileLinkedService = {
      parameters = {}
      referenceName = "string"
      type = "LinkedServiceReference"
    }
    filePaths = [ object ]
    getDebugInfo = "string"
    storageLinkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
  }

对于 IfCondition,请使用:

  type = "IfCondition"
  typeProperties = {
    expression = {
      type = "Expression"
      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
      }
    ]
  }

对于 查找,请使用:

  type = "Lookup"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    dataset = {
      parameters = {}
      referenceName = "string"
      type = "DatasetReference"
    }
    source = {
      // For remaining properties, see CopySource objects
    }
  }

对于 SqlServerStoredProcedure,请使用:

  type = "SqlServerStoredProcedure"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    storedProcedureParameters = {
      {customized property} = {
        type = "string"
      }
    }
  }

对于 “直到”,请使用:

  type = "Until"
  typeProperties = {
    activities = [
      {
        dependsOn = [
          {
            activity = "string"
            dependencyConditions = [
              "string"
            ]
          }
        ]
        description = "string"
        name = "string"
        type = "string"
        // For remaining properties, see Activity objects
      }
    ]
    expression = {
      type = "Expression"
      value = "string"
    }
  }

对于 “等待”,请使用:

  type = "Wait"
  typeProperties = {
    waitTimeInSeconds = int
  }

对于 WebActivity,请使用:

  type = "WebActivity"
  linkedServiceName = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }
  policy = {
    retryIntervalInSeconds = int
    secureOutput = bool
  }
  typeProperties = {
    authentication = {
      password = {
        type = "string"
        value = "string"
      }
      pfx = {
        type = "string"
        value = "string"
      }
      resource = "string"
      type = "string"
      username = "string"
    }
    datasets = [
      {
        parameters = {}
        referenceName = "string"
        type = "DatasetReference"
      }
    ]
    disableCertValidation = bool
    linkedServices = [
      {
        parameters = {}
        referenceName = "string"
        type = "LinkedServiceReference"
      }
    ]
    method = "string"
  }

CopySink 对象

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

CopySource 对象

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

SecretBase 对象

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

对于 AzureKeyVaultSecret,请使用:

  type = "AzureKeyVaultSecret"
  store = {
    parameters = {}
    referenceName = "string"
    type = "LinkedServiceReference"
  }

对于 SecureString,请使用:

  type = "SecureString"
  value = "string"

属性值

factories/pipelines

名称 说明 Value
type 资源类型 “Microsoft.DataFactory/factories/pipelines@2017-09-01-preview”
name 资源名称 字符串 (必需)

字符限制:1-260

有效字符:
不得使用:
<>*#.%&:\\+?/ 或控制字符

以字母数字开头。
parent_id 此资源的父资源 ID。 类型为“工厂”的资源的 ID
properties 管道的属性。 需要管道 ()

管道

名称 说明
活动 管道中的活动列表。 Activity[]
annotations 可用于描述管道的标记列表。 any[]
concurrency 管道的最大并发运行数。 int

约束:
最小值 = 1
description 管道的说明。 字符串
parameters 管道的参数列表。 ParameterDefinitionSpecification

活动

名称 说明
dependsOn 活动取决于条件。 ActivityDependency[]
description 活动说明。 字符串
name 活动名称。 字符串 (必需)
类型 设置对象类型 AzureMLBatchExecution
AzureMLUpdateResource
复制
自定义
DatabricksNotebook
DataLakeAnalyticsU-SQL
ExecutePipeline
ExecuteSSISPackage
Filter
ForEach
GetMetadata
HDInsightHive
HDInsightMapReduce
HDInsightPig
HDInsightSpark
HDInsightStreaming
IfCondition
查找
SqlServerStoredProcedure
截止
Wait
所需的 WebActivity ()

ActivityDependency

名称 说明
activity 活动名称。 字符串 (必需)
dependencyConditions 依赖项的 Match-Condition。 包含任意项的字符串数组:
“Completed”
“失败”
“已跳过”
“成功” (必需)
{customized property}

AzureMLBatchExecutionActivity

名称 说明 Value
type 活动的类型。 “AzureMLBatchExecution” (必需的)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML Batch 执行活动属性。 AzureMLBatchExecutionActivityTypeProperties (必需的)

LinkedServiceReference

名称 说明
parameters LinkedService 的参数。 ParameterValueSpecification
referenceName 引用 LinkedService 名称。 字符串 (必需)
类型 链接服务引用类型。 “LinkedServiceReference” (必需)

ParameterValueSpecification

名称 说明
{customized property}

ActivityPolicy

名称 说明
retry 最大普通重试尝试次数。 默认为 0。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
retryIntervalInSeconds 每次重试尝试 (间隔(以秒) 为单位)。 默认值为 30 秒。 int

约束:
最小值 = 30
最大值 = 86400
secureOutput 设置为 true 时,活动输出被视为安全输出,不会记录到监视。 bool
timeout 指定活动运行的超时。 默认超时为 7 天。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。
{customized property}

AzureMLBatchExecutionActivityTypeProperties

名称 说明
globalParameters 要传递给 Azure ML Batch 执行服务终结点的键、值对。 键必须与已发布 Azure ML Web 服务中定义的 Web 服务参数名称匹配。 值将在 Azure ML 批处理执行请求的 GlobalParameters 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesGlobalPar...
webServiceInputs 键、值对,将 Azure ML 终结点的 Web 服务输入的名称映射到指定输入 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceInputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...
webServiceOutputs 键、值对,将 Azure ML 终结点的 Web 服务输出的名称映射到指定输出 Blob 位置的 AzureMLWebServiceFile 对象。 此信息将在 Azure ML 批处理执行请求的 WebServiceOutputs 属性中传递。 AzureMLBatchExecutionActivityTypePropertiesWebServic...

AzureMLBatchExecutionActivityTypePropertiesGlobalPar...

名称 说明
{customized property}

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLWebServiceFile

名称 说明
filePath LinkedService 指定的Azure Blob 存储中的相对文件路径(包括容器名称)。 类型:包含 resultType 字符串) 的字符串 (或表达式。
linkedServiceName 对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件所在的位置。 LinkedServiceReference (必需)

AzureMLBatchExecutionActivityTypePropertiesWebServic...

名称 说明
{customized property} AzureMLWebServiceFile

AzureMLUpdateResourceActivity

名称 说明 Value
type 活动的类型。 “AzureMLUpdateResource” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Azure ML 更新资源管理活动属性。 AzureMLUpdateResourceActivityTypeProperties (必需的)

AzureMLUpdateResourceActivityTypeProperties

名称 说明
trainedModelFilePath trainedModelLinkedService 中的相对文件路径,表示更新操作将上传的 .ilearner 文件。 类型:包含 resultType 字符串) 的字符串 (或表达式。
trainedModelLinkedServiceName 包含更新操作将上传的 .ilearner 文件的 Azure 存储链接服务的名称。 LinkedServiceReference (必需)
trainedModelName 要更新的 Web 服务试验中训练的模型模块的名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。

CopyActivity

名称 说明 Value
type 活动的类型。 “复制” (必需)
inputs 活动的输入列表。 DatasetReference[]
linkedServiceName 链接服务引用。 LinkedServiceReference
outputs 活动的输出列表。 DatasetReference[]
policy 活动策略。 ActivityPolicy
typeProperties 复制活动属性。 CopyActivityTypeProperties (必需)

DatasetReference

名称 说明
parameters 数据集的参数。 ParameterValueSpecification
referenceName 引用数据集名称。 字符串 (必需)
类型 数据集引用类型。 “DatasetReference” (必需)

CopyActivityTypeProperties

名称 说明
cloudDataMovementUnits 可用于执行此数据移动的云数据移动单位的最大数量。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
enableSkipIncompatibleRow 是否跳过不兼容的行。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。
enableStaging 指定是否通过临时暂存复制数据。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。
parallelCopies 在源或接收器上打开的最大并发会话数,以避免数据存储过载。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
redirectIncompatibleRowSettings 当 EnableSkipIncompatibleRow 为 true 时,重定向不兼容行设置。 RedirectIncompatibleRowSettings
接收器 复制活动接收器。 需要 copySink ()
source 复制活动源。 CopySource (必需)
stagingSettings 指定 EnableStaging 为 true 时的临时暂存设置。 StagingSettings
转换器 复制活动翻译器。 如果未指定,则使用表格翻译器。

RedirectIncompatibleRowSettings

名称 说明
linkedServiceName 用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定了 redirectIncompatibleRowSettings,则必须指定 。 类型:包含 resultType 字符串) 的字符串 (或表达式。
path 用于存储重定向不兼容行数据的路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
{customized property}

CopySink

名称 说明
sinkRetryCount 接收器重试计数。 类型:具有 resultType 整数) 的整数 (或 Expression。
sinkRetryWait 接收器重试等待。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。
writeBatchSize 写入批大小。 类型:具有 resultType 整数) 的整数 (或 Expression,最小值:0。
writeBatchTimeout 写入批处理超时。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

CopySource

名称 说明
sourceRetryCount 源重试计数。 类型:具有 resultType 整数) 的整数 (或 Expression。
sourceRetryWait 源重试等待。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

StagingSettings

名称 说明
enableCompression 指定在通过临时暂存复制数据时是否使用压缩。 默认值为 false。 类型:boolean (或 expression with resultType boolean) 。
linkedServiceName 暂存链接服务引用。 LinkedServiceReference (必需)
path 用于存储临时数据的存储路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
{customized property}

“CustomActivity”

名称 说明 Value
type 活动的类型。 “自定义” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 自定义活动属性。 CustomActivityTypeProperties (必需)

CustomActivityTypeProperties

名称 说明 Value
command 自定义活动类型的命令:包含 resultType 字符串) 的字符串 (或表达式。
extendedProperties 用户定义的属性包。 对可以使用的键或值没有限制。 用户指定的自定义活动完全负责使用和解释定义的内容。 CustomActivityTypePropertiesExtendedProperties
folderPath 资源文件的文件夹路径 类型:包含 resultType 字符串) 的字符串 (或表达式。
referenceObjects 引用对象 CustomActivityReferenceObject
resourceLinkedService 资源链接服务参考。 LinkedServiceReference

CustomActivityTypePropertiesExtendedProperties

名称 说明
{customized property}

CustomActivityReferenceObject

名称 说明
datasets 数据集引用。 DatasetReference[]
linkedServices 链接服务引用。 LinkedServiceReference[]

DatabricksNotebookActivity

名称 说明 Value
type 活动的类型。 “DatabricksNotebook” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Databricks Notebook 活动属性。 DatabricksNotebookActivityTypeProperties (必需)

DatabricksNotebookActivityTypeProperties

名称 说明
baseParameters 要用于此作业的每次运行的基本参数。如果笔记本采用未指定的参数,则将使用笔记本中的默认值。 DatabricksNotebookActivityTypePropertiesBaseParamete...
notebookPath 要在 Databricks 工作区中运行的 Notebook 的绝对路径。 此路径必须以斜杠开头。 类型:包含 resultType 字符串) 的字符串 (或表达式。

DatabricksNotebookActivityTypePropertiesBaseParamete...

名称 说明
{customized property}

DataLakeAnalyticsUsqlActivity

名称 说明 Value
type 活动的类型。 “DataLakeAnalyticsU-SQL” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Data Lake Analytics U-SQL 活动属性。 DataLakeAnalyticsUsqlActivityTypeProperties (必需)

DataLakeAnalyticsUsqlActivityTypeProperties

名称 说明
compilationMode U-SQL 编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:包含 resultType 字符串) 的字符串 (或表达式。
degreeOfParallelism 同时用于运行作业的最大节点数。 默认值为 1。 类型:integer (或 expression with resultType integer) ,minimum: 1。
parameters U-SQL 作业请求的参数。 DataLakeAnalyticsUsqlActivityTypePropertiesParameter...
priority 确定应在所有排队的作业中选择哪些作业首先运行。 编号越低,优先级越高。 默认值为 1000。 类型:integer (或 expression with resultType integer) ,minimum: 1。
runtimeVersion 要使用的 U-SQL 引擎的运行时版本。 类型:包含 resultType 字符串) 的字符串 (或表达式。
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference (必需)
scriptPath 包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。

DataLakeAnalyticsUsqlActivityTypePropertiesParameter...

名称 说明
{customized property}

ExecutePipelineActivity

名称 说明 Value
type 活动的类型。 “ExecutePipeline” (必需)
typeProperties 执行管道活动属性。 ExecutePipelineActivityTypeProperties (必需)

ExecutePipelineActivityTypeProperties

名称 说明
parameters 管道参数。 ParameterValueSpecification
管道 管道引用。 PipelineReference (必需)
waitOnCompletion 定义活动执行是否将等待依赖管道执行完成。 默认值为 false。 bool

PipelineReference

名称 说明
name 引用名称。 字符串
referenceName 引用管道名称。 字符串 (必需)
类型 管道引用类型。 “PipelineReference” (必需)

ExecuteSsisPackageActivity

名称 说明 Value
type 活动的类型。 “ExecuteSSISPackage” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 执行 SSIS 包活动属性。 ExecuteSsisPackageActivityTypeProperties (必需的)

ExecuteSsisPackageActivityTypeProperties

名称 说明
connectVia 集成运行时引用。 IntegrationRuntimeReference (必需)
environmentPath 用于执行 SSIS 包的环境路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
executionCredential 包执行凭据。 SsisExecutionCredential
loggingLevel SSIS 包执行的日志记录级别。 类型:包含 resultType 字符串) 的字符串 (或表达式。
logLocation SSIS 包执行日志位置。 SsisLogLocation
packageConnectionManagers 用于执行 SSIS 包的包级别连接管理器。 ExecuteSsisPackageActivityTypePropertiesPackageConne...
packageLocation SSIS 包位置。 需要 SsisPackageLocation ()
packageParameters 用于执行 SSIS 包的包级别参数。 ExecuteSsisPackageActivityTypePropertiesPackageParam...
projectConnectionManagers 用于执行 SSIS 包的项目级连接管理器。 ExecuteSsisPackageActivityTypePropertiesProjectConne...
projectParameters 用于执行 SSIS 包的项目级参数。 ExecuteSsisPackageActivityTypePropertiesProjectParam...
propertyOverrides 属性重写以执行 SSIS 包。 ExecuteSsisPackageActivityTypePropertiesPropertyOver...
Runtime — 运行时 指定要执行 SSIS 包的运行时。 该值应为“x86”或“x64”。 类型:包含 resultType 字符串) 的字符串 (或表达式。

IntegrationRuntimeReference

名称 说明
parameters 集成运行时的参数。 ParameterValueSpecification
referenceName 引用集成运行时名称。 字符串 (必需)
类型 集成运行时的类型。 “IntegrationRuntimeReference” (必需的)

SsisExecutionCredential

名称 说明
Windows 身份验证的域。
password Windows 身份验证的密码。 需要 SecureString ()
userName 用于 Windows 身份验证的 UseName。

SecureString

名称 说明 Value
type 机密的类型。 字符串 (必需)
value 安全字符串的值。 字符串 (必需)

SsisLogLocation

名称 说明
logPath SSIS 包执行日志路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
类型 SSIS 日志位置的类型。 “文件” (必需)
typeProperties SSIS 包执行日志位置属性。 SsisLogLocationTypeProperties (必需)

SsisLogLocationTypeProperties

名称 说明
accessCredential 包执行日志访问凭据。 SsisAccessCredential
logRefreshInterval 指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:包含 resultType 字符串) 的字符串 (或表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

SsisAccessCredential

名称 说明
Windows 身份验证的域。
password Windows 身份验证的密码。 需要 secretBase ()
userName 用于 Windows 身份验证的 UseName。

SecretBase

名称 说明 Value
type 设置对象类型 AzureKeyVaultSecret
需要 SecureString ()

AzureKeyVaultSecretReference

名称 说明 Value
type 机密的类型。 “AzureKeyVaultSecret” (必需)
secretName Azure 密钥保管库中机密的名称。 类型:包含 resultType 字符串) 的字符串 (或表达式。
secretVersion Azure 中机密的版本密钥保管库。 默认值为最新版本的机密。 类型:包含 resultType 字符串) 的字符串 (或表达式。
store Azure 密钥保管库链接服务参考。 LinkedServiceReference (必需)

ExecuteSsisPackageActivityTypePropertiesPackageConne...

名称 说明
{customized property} SsisConnectionManager

SsisConnectionManager

名称 说明
{customized property} SsisExecutionParameter

SsisExecutionParameter

名称 说明
value SSIS 包执行参数值。 类型:包含 resultType 字符串) 的字符串 (或表达式。

SsisPackageLocation

名称 说明
packagePath SSIS 包路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
类型 SSIS 包位置的类型。 “文件”
“SSISDB”
typeProperties SSIS 包位置属性。 SsisPackageLocationTypeProperties

SsisPackageLocationTypeProperties

名称 说明
accessCredential 包访问凭据。 SsisAccessCredential
configurationPath 包执行的配置文件。 类型:字符串 (或带有 resultType 字符串) 的表达式。
packagePassword 包的密码。 SecretBase

ExecuteSsisPackageActivityTypePropertiesPackageParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesProjectConne...

名称 说明
{customized property} SsisConnectionManager

ExecuteSsisPackageActivityTypePropertiesProjectParam...

名称 说明
{customized property} SsisExecutionParameter

ExecuteSsisPackageActivityTypePropertiesPropertyOver...

名称 说明
{customized property} SsisPropertyOverride

SsisPropertyOverride

名称 说明
isSensitive SSIS 包属性重写值是否为敏感数据。 如果值为 true,则将在 SSISDB 中加密值 bool
value SSIS 包属性重写值。 类型:字符串 (或带有 resultType 字符串) 的表达式。

FilterActivity

名称 说明 Value
type 活动的类型。 “Filter” (必需)
typeProperties 筛选活动属性。 FilterActivityTypeProperties (必需)

FilterActivityTypeProperties

名称 说明
condition 要用于筛选输入的条件。 需要表达式 ()
items 应该应用筛选器的输入数组。 需要表达式 ()

Expression

名称 说明 Value
type 表达式类型。 “表达式” (必需)
value 表达式值。 字符串 (必需)

ForEach 活动

名称 说明 Value
type 活动的类型。 需要“ForEach” ()
typeProperties ForEach 活动属性。 ForEachActivityTypeProperties (所需的)

ForEachActivityTypeProperties

名称 说明
活动 要执行 的活动列表。 活动[] (必需的)
batchCount 要用于控制并行执行数的批计数(当 isSequential 设为 false 时)。 int

约束:
最大值 = 50
isSequential 循环应按顺序或并行执行 (最大 50) bool
items 要循环访问的集合。 表达式 (必需)

GetMetadataActivity

名称 说明 Value
type 活动的类型。 “GetMetadata” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties GetMetadata 活动属性。 GetMetadataActivityTypeProperties (必需)

GetMetadataActivityTypeProperties

名称 说明
dataset GetMetadata 活动数据集参考。 DatasetReference (必需)
fieldList 要从数据集获取的元数据字段。 any[]

HDInsightHiveActivity

名称 说明 Value
type 活动的类型。 需要“HDInsightHive” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Hive 活动属性。 HDInsightHiveActivityTypeProperties (必需)

HDInsightHiveActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Hive 作业请求指定定义。 HDInsightHiveActivityTypePropertiesDefines
getDebugInfo “调试信息”选项。 “Always”
“失败”
"None"
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:包含 resultType 字符串) 的字符串 (或表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightHiveActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightMapReduceActivity

名称 说明 Value
type 活动的类型。 “HDInsightMapReduce” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight MapReduce 活动属性。 HDInsightMapReduceActivityTypeProperties (必需)

HDInsightMapReduceActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
className 类名。 类型:字符串 (或带有 resultType 字符串) 的表达式。
定义 允许用户为 MapReduce 作业请求指定定义。 HDInsightMapReduceActivityTypePropertiesDefines
getDebugInfo 调试信息选项。 “Always”
“失败”
"None"
jarFilePath Jar 路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
jarLibs Jar 库。 any[]
jarLinkedService Jar 链接服务引用。 LinkedServiceReference
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightMapReduceActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightPigActivity

名称 说明 Value
type 活动的类型。 “HDInsightPig” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight Pig 活动属性。 HDInsightPigActivityTypeProperties (所需的)

HDInsightPigActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
定义 允许用户为 Pig 作业请求指定定义。 HDInsightPigActivityTypePropertiesDefines
getDebugInfo 调试信息选项。 “Always”
“失败”
"None"
scriptLinkedService 脚本链接服务引用。 LinkedServiceReference
scriptPath 脚本路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightPigActivityTypePropertiesDefines

名称 说明
{customized property}

HDInsightSparkActivity

名称 说明 Value
type 活动的类型。 “HDInsightSpark” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight spark 活动属性。 HDInsightSparkActivityTypeProperties (必需)

HDInsightSparkActivityTypeProperties

名称 说明
参数 HDInsightSparkActivity 的用户指定参数。 any[]
className 应用程序的 Java/Spark main 类。 字符串
entryFilePath 要执行的代码/包的根文件夹的相对路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
getDebugInfo 调试信息选项。 “Always”
“失败”
"None"
proxyUser 要模拟将执行作业的用户。 类型:字符串 (或带有 resultType 字符串) 的表达式。
rootPath “sparkJobLinkedService”中所有作业文件的根路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
sparkConfig Spark 配置属性。 HDInsightSparkActivityTypePropertiesSparkConfig
sparkJobLinkedService 用于上传入口文件和依赖项以及用于接收日志的存储链接服务。 LinkedServiceReference

HDInsightSparkActivityTypePropertiesSparkConfig

名称 说明
{customized property}

HDInsightStreamingActivity

名称 说明 Value
type 活动的类型。 “HDInsightStreaming” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties HDInsight 流式处理活动属性。 HDInsightStreamingActivityTypeProperties (必需)

HDInsightStreamingActivityTypeProperties

名称 说明
参数 用户为 HDInsightActivity 指定参数。 any[]
combiner 组合器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
commandEnvironment 命令行环境值。 any[]
定义 允许用户为流式处理作业请求指定定义。 HDInsightStreamingActivityTypePropertiesDefines
fileLinkedService 文件所在的链接服务引用。 LinkedServiceReference
filePaths 流式处理作业文件的路径。 可以是目录。 any[] (必需)
getDebugInfo 调试信息选项。 “Always”
“失败”
"None"
input 输入 Blob 路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
mapper 映射器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
输出 输出 Blob 路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。
reducer 化简器可执行文件名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
storageLinkedServices 存储链接服务引用。 LinkedServiceReference[]

HDInsightStreamingActivityTypePropertiesDefines

名称 说明
{customized property}

IfConditionActivity

名称 说明 Value
type 活动的类型。 “IfCondition” (必需)
typeProperties IfCondition 活动属性。 IfConditionActivityTypeProperties (必需)

IfConditionActivityTypeProperties

名称 说明
表达式 计算结果为布尔值的表达式。 这用于确定将执行的 ifTrueActivities 或 ifFalseActivities) (活动块。 需要表达式 ()
ifFalseActivities 表达式计算结果为 false 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]
ifTrueActivities 表达式计算结果为 true 时要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出,而无需执行任何操作。 Activity[]

LookupActivity

名称 说明 Value
type 活动的类型。 “Lookup” (必需)
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties 查找活动属性。 LookupActivityTypeProperties (必需)

LookupActivityTypeProperties

名称 说明
dataset 查找活动数据集引用。 DatasetReference (必需)
firstRowOnly 是返回第一行还是返回所有行。 默认值为 true。 类型:布尔 (或 resultType 布尔) 表达式。
source 特定于数据集的源属性,与复制活动源相同。 需要 CopySource ()

SqlServerStoredProcedureActivity

名称 说明 Value
type 活动的类型。 需要“SqlServerStoredProcedure” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties SQL 存储过程活动属性。 SqlServerStoredProcedureActivityTypeProperties (必需)

SqlServerStoredProcedureActivityTypeProperties

名称 说明
storedProcedureName 存储过程名称。 类型:字符串 (或带有 resultType 字符串) 的表达式。
storedProcedureParameters 存储过程参数的值和类型设置。 示例:“{Parameter1: {value: ”1“,类型:”int“}}”。 SqlServerStoredProcedureActivityTypePropertiesStored...

SqlServerStoredProcedureActivityTypePropertiesStored...

名称 说明
{customized property} StoredProcedureParameter

StoredProcedureParameter

名称 说明 Value
type 存储过程参数类型。 “Boolean”
“Date”
“Decimal”
“Guid”
“Int”
“Int64”
“String”
value 存储过程参数值。 类型:字符串 (或带有 resultType 字符串) 的表达式。

UntilActivity

名称 说明 Value
type 活动的类型。 需要“Until” ()
typeProperties 直到活动属性。 UntilActivityTypeProperties (必需)

UntilActivityTypeProperties

名称 说明
活动 要执行的活动的列表。 活动[] (必需)
表达式 计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true 需要表达式 ()
timeout 指定活动运行的超时。 如果未指定值,则采用 TimeSpan.FromDays (7) 默认值为 1 周的值。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。 类型:字符串 (或带有 resultType 字符串) 的表达式, pattern: ( (\d+) .) ? (\d\d) : (60, ([0-5][0-9]) ) : (60, ([0-5][0-9]) ) 。

WaitActivity

名称 说明 Value
type 活动的类型。 需要“等待” ()
typeProperties 等待活动属性。 WaitActivityTypeProperties (必需)

WaitActivityTypeProperties

名称 说明
waitTimeInSeconds 持续时间(以秒为单位)。 int (必需)

Web 活动

名称 说明 Value
type 活动的类型。 需要“WebActivity” ()
linkedServiceName 链接服务引用。 LinkedServiceReference
policy 活动策略。 ActivityPolicy
typeProperties Web 活动属性。 WebActivityTypeProperties (必需)

WebActivityTypeProperties

名称 说明
authentication 用于调用该终结点的身份验证方法。 WebActivityAuthentication
body 表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,GET 方法类型不允许:字符串 (或带有 resultType 字符串的表达式) 。
datasets 传递给 Web 终结点的数据集列表。 DatasetReference[]
disableCertValidation 设置为 true 时,将禁用证书验证。 bool
headers 表示将发送到请求的标头。 例如,若要在请求中设置语言和类型:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 类型:字符串 (或带有 resultType 字符串) 的表达式。
linkedServices 传递给 Web 终结点的链接服务的列表。 LinkedServiceReference[]
method 目标终结点的 Rest API 方法。 "DELETE"
"GET"
“POST”
“PUT” (必需)
url Web 活动目标终结点和路径。 类型:字符串 (或带有 resultType 字符串) 的表达式。

WebActivityAuthentication

名称 说明
password PFX 文件或基本身份验证的密码。 SecureString
pfx PFX 文件的 Base64 编码内容。 SecureString
resource 使用 MSI 身份验证时,将为其请求 Azure 身份验证令牌的资源。 字符串
type Web 活动身份验证 (Basic/ClientCertificate/MSI) 字符串 (必需)
username 用于基本身份验证的 Web 活动身份验证用户名。 字符串

ParameterDefinitionSpecification

名称 说明
{customized property} ParameterSpecification

ParameterSpecification

名称 说明
defaultValue 参数的默认值。
类型 参数类型。 “Array”
“Bool”
“Float”
“Int”
“Object”
“SecureString”
“字符串” (必需)