Bicep 资源定义
工厂/管道资源类型可以使用目标操作进行部署:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.DataFactory/factories/pipelines 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2017-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
annotations: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
concurrency: int
description: 'string'
parameters: {
{customized property}: {
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
}
}
SecretBase 对象
设置 类型 属性以指定对象的类型。
对于 AzureKeyVaultSecret,请使用:
{
secretName: any(Azure.Bicep.Types.Concrete.AnyType)
secretVersion: any(Azure.Bicep.Types.Concrete.AnyType)
store: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
type: 'AzureKeyVaultSecret'
}
对于 SecureString,请使用:
{
type: 'SecureString'
value: 'string'
}
活动对象
设置 类型 属性以指定对象的类型。
对于 AzureMLBatchExecution,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'AzureMLBatchExecution'
typeProperties: {
globalParameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
webServiceInputs: {
{customized property}: {
filePath: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
}
}
webServiceOutputs: {
{customized property}: {
filePath: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
}
}
}
}
对于 AzureMLUpdateResource,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'AzureMLUpdateResource'
typeProperties: {
trainedModelFilePath: any(Azure.Bicep.Types.Concrete.AnyType)
trainedModelLinkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
trainedModelName: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 ExecutePipeline,请使用:
{
type: 'ExecutePipeline'
typeProperties: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
pipeline: {
name: 'string'
referenceName: 'string'
type: 'string'
}
waitOnCompletion: bool
}
}
对于 筛选器,请使用:
{
type: 'Filter'
typeProperties: {
condition: {
type: 'string'
value: 'string'
}
items: {
type: 'string'
value: 'string'
}
}
}
对于 forEach,请使用:
{
type: 'ForEach'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
batchCount: int
isSequential: bool
items: {
type: 'string'
value: 'string'
}
}
}
对于 IfCondition,请使用:
{
type: 'IfCondition'
typeProperties: {
expression: {
type: 'string'
value: 'string'
}
ifFalseActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
ifTrueActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
}
}
对于 直到,请使用:
{
type: 'Until'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
expression: {
type: 'string'
value: 'string'
}
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 等待,请使用:
{
type: 'Wait'
typeProperties: {
waitTimeInSeconds: int
}
}
对于 复制,请使用:
{
inputs: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
outputs: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'Copy'
typeProperties: {
cloudDataMovementUnits: any(Azure.Bicep.Types.Concrete.AnyType)
enableSkipIncompatibleRow: any(Azure.Bicep.Types.Concrete.AnyType)
enableStaging: any(Azure.Bicep.Types.Concrete.AnyType)
parallelCopies: any(Azure.Bicep.Types.Concrete.AnyType)
redirectIncompatibleRowSettings: {
linkedServiceName: any(Azure.Bicep.Types.Concrete.AnyType)
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
sink: {
sinkRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
sinkRetryWait: any(Azure.Bicep.Types.Concrete.AnyType)
writeBatchSize: any(Azure.Bicep.Types.Concrete.AnyType)
writeBatchTimeout: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see CopySink objects
}
source: {
sourceRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
sourceRetryWait: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see CopySource objects
}
stagingSettings: {
enableCompression: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
path: any(Azure.Bicep.Types.Concrete.AnyType)
}
translator: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 自定义,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'Custom'
typeProperties: {
command: any(Azure.Bicep.Types.Concrete.AnyType)
extendedProperties: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
folderPath: any(Azure.Bicep.Types.Concrete.AnyType)
referenceObjects: {
datasets: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
linkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
}
resourceLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
}
}
对于 DataLakeAnalyticsU-SQL,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'DataLakeAnalyticsU-SQL'
typeProperties: {
compilationMode: any(Azure.Bicep.Types.Concrete.AnyType)
degreeOfParallelism: any(Azure.Bicep.Types.Concrete.AnyType)
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
priority: any(Azure.Bicep.Types.Concrete.AnyType)
runtimeVersion: any(Azure.Bicep.Types.Concrete.AnyType)
scriptLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 DatabricksNotebook,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'DatabricksNotebook'
typeProperties: {
baseParameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
notebookPath: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 ExecuteSSISPackage,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'ExecuteSSISPackage'
typeProperties: {
connectVia: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
environmentPath: any(Azure.Bicep.Types.Concrete.AnyType)
executionCredential: {
domain: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
value: 'string'
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
loggingLevel: any(Azure.Bicep.Types.Concrete.AnyType)
logLocation: {
logPath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
typeProperties: {
accessCredential: {
domain: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
logRefreshInterval: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
packageConnectionManagers: {
{customized property}: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
}
packageLocation: {
packagePath: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
typeProperties: {
accessCredential: {
domain: any(Azure.Bicep.Types.Concrete.AnyType)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(Azure.Bicep.Types.Concrete.AnyType)
}
configurationPath: any(Azure.Bicep.Types.Concrete.AnyType)
packagePassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
packageParameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
projectConnectionManagers: {
{customized property}: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
}
projectParameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
propertyOverrides: {
{customized property}: {
isSensitive: bool
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
runtime: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
对于 GetMetadata,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'GetMetadata'
typeProperties: {
dataset: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
fieldList: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
}
}
对于 HDInsightHive,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'HDInsightHive'
typeProperties: {
arguments: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defines: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
getDebugInfo: 'string'
scriptLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(Azure.Bicep.Types.Concrete.AnyType)
storageLinkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
}
}
对于 HDInsightMapReduce,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'HDInsightMapReduce'
typeProperties: {
arguments: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
className: any(Azure.Bicep.Types.Concrete.AnyType)
defines: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
getDebugInfo: 'string'
jarFilePath: any(Azure.Bicep.Types.Concrete.AnyType)
jarLibs: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
jarLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
storageLinkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
}
}
对于 HDInsightPig,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'HDInsightPig'
typeProperties: {
arguments: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defines: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
getDebugInfo: 'string'
scriptLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(Azure.Bicep.Types.Concrete.AnyType)
storageLinkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
}
}
对于 HDInsightSpark,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'HDInsightSpark'
typeProperties: {
arguments: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
className: 'string'
entryFilePath: any(Azure.Bicep.Types.Concrete.AnyType)
getDebugInfo: 'string'
proxyUser: any(Azure.Bicep.Types.Concrete.AnyType)
rootPath: any(Azure.Bicep.Types.Concrete.AnyType)
sparkConfig: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
sparkJobLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
}
}
对于 HDInsightStreaming,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'HDInsightStreaming'
typeProperties: {
arguments: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
combiner: any(Azure.Bicep.Types.Concrete.AnyType)
commandEnvironment: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defines: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
fileLinkedService: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
filePaths: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
getDebugInfo: 'string'
input: any(Azure.Bicep.Types.Concrete.AnyType)
mapper: any(Azure.Bicep.Types.Concrete.AnyType)
output: any(Azure.Bicep.Types.Concrete.AnyType)
reducer: any(Azure.Bicep.Types.Concrete.AnyType)
storageLinkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
}
}
对于 查找,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'Lookup'
typeProperties: {
dataset: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
firstRowOnly: any(Azure.Bicep.Types.Concrete.AnyType)
source: {
sourceRetryCount: any(Azure.Bicep.Types.Concrete.AnyType)
sourceRetryWait: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
// For remaining properties, see CopySource objects
}
}
}
对于 SqlServerStoredProcedure,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'SqlServerStoredProcedure'
typeProperties: {
storedProcedureName: any(Azure.Bicep.Types.Concrete.AnyType)
storedProcedureParameters: {
{customized property}: {
type: 'string'
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
}
}
对于 WebActivity,请使用:
{
linkedServiceName: {
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(Azure.Bicep.Types.Concrete.AnyType)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(Azure.Bicep.Types.Concrete.AnyType)
}
type: 'WebActivity'
typeProperties: {
authentication: {
password: {
type: 'string'
value: 'string'
}
pfx: {
type: 'string'
value: 'string'
}
resource: 'string'
type: 'string'
username: 'string'
}
body: any(Azure.Bicep.Types.Concrete.AnyType)
datasets: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
disableCertValidation: bool
headers: any(Azure.Bicep.Types.Concrete.AnyType)
linkedServices: [
{
parameters: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
referenceName: 'string'
type: 'string'
}
]
method: 'string'
url: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
CopySource 对象
设置 类型 属性以指定对象的类型。
CopySink 对象
设置 类型 属性以指定对象的类型。
属性值
活动
ActivityDependency
名字 |
描述 |
价值 |
活动 |
活动名称。 |
string (必需) |
dependencyConditions |
Match-Condition 依赖项。 |
包含任一项的字符串数组: “Completed” “Failed” “跳过” “Succeeded”(必需) |
ActivityPolicy
名字 |
描述 |
价值 |
|
|
重试 |
最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
retryIntervalInSeconds |
每次重试尝试(以秒为单位)之间的间隔。 默认值为 30 秒。 |
int
约束: 最小值 = 30 最大值 = 86400 |
|
|
secureOutput |
设置为 true 时,活动输出被视为安全,不会记录到监视中。 |
bool |
|
|
超时 |
指定要运行的活动的超时值。 默认超时为 7 天。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
AzureKeyVaultSecretReference
名字 |
描述 |
价值 |
secretName |
Azure Key Vault 中机密的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
secretVersion |
Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
商店 |
Azure Key Vault 链接服务参考。 |
LinkedServiceReference(必需) |
类型 |
机密的类型。 |
“AzureKeyVaultSecret”(必需) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeProperties
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties
名字 |
描述 |
价值 |
trainedModelFilePath |
trainedModelLinkedService 中的相对文件路径,表示将由更新操作上传的 .ilearner 文件。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
trainedModelLinkedServiceName |
保存由更新操作上传的 .ilearner 文件的 Azure 存储链接服务的名称。 |
LinkedServiceReference(必需) |
trainedModelName |
要更新的 Web 服务试验中训练的模型模块的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
AzureMLWebServiceFile
名字 |
描述 |
价值 |
filePath |
LinkedService 指定的 Azure Blob 存储中的相对文件路径,包括容器名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
linkedServiceName |
对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件位于其中。 |
LinkedServiceReference(必需) |
CopyActivity
CopyActivityTypeProperties
名字 |
描述 |
价值 |
cloudDataMovementUnits |
可用于执行此数据移动的云数据移动单元的最大数量。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
enableSkipIncompatibleRow |
是否跳过不兼容行。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
enableStaging |
指定是否通过临时暂存复制数据。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
parallelCopies |
在源或接收器上打开的最大并发会话数,以避免重载数据存储。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
redirectIncompatibleRowSettings |
当 EnableSkipIncompatibleRow 为 true 时重定向不兼容行设置。 |
RedirectIncompatibleRowSettings |
沉 |
复制活动接收器。 |
CopySink (必需) |
源 |
复制活动源。 |
CopySource (必需) |
stagingSettings |
指定 EnableStaging 为 true 时的临时暂存设置。 |
StagingSettings |
在线翻译 |
复制活动翻译器。 如果未指定,则使用表格翻译器。 |
任何 |
CopySink
名字 |
描述 |
价值 |
|
|
sinkRetryCount |
接收器重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sinkRetryWait |
接收器重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
writeBatchSize |
写入批大小。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
writeBatchTimeout |
写入批处理超时。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
CopySource
名字 |
描述 |
价值 |
|
|
sourceRetryCount |
源重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sourceRetryWait |
源重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
CustomActivity
CustomActivityReferenceObject
CustomActivityTypeProperties
CustomActivityTypePropertiesExtendedProperties
DatabricksNotebookActivity
DatabricksNotebookActivityTypeProperties
DatabricksNotebookActivityTypePropertiesBaseParameters
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties
名字 |
描述 |
价值 |
compilationMode |
U-SQL 的编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
degreeOfParallelism |
用于运行作业的最大节点数。 默认值为 1。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
参数 |
U-SQL 作业请求的参数。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
优先权 |
确定应选择已排队的所有作业中的哪些作业以先运行。 数字越低,优先级越高。 默认值为 1000。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
runtimeVersion |
要使用的 U-SQL 引擎的运行时版本。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
scriptLinkedService |
编写链接服务引用脚本。 |
LinkedServiceReference(必需) |
scriptPath |
包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
DatasetReference
ExecutePipelineActivity
ExecutePipelineActivityTypeProperties
ExecuteSsisPackageActivity
ExecuteSsisPackageActivityTypeProperties
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers
ExecuteSsisPackageActivityTypePropertiesProjectParameters
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表达
名字 |
描述 |
价值 |
类型 |
表达式类型。 |
“表达式”(必需) |
价值 |
表达式值。 |
string (必需) |
FilterActivity
FilterActivityTypeProperties
名字 |
描述 |
价值 |
条件 |
用于筛选输入的条件。 |
表达式(必需) |
项目 |
应对其应用筛选器的输入数组。 |
表达式(必需) |
ForEachActivity
ForEachActivityTypeProperties
名字 |
描述 |
价值 |
活动 |
要执行的活动列表。 |
活动[] (必需) |
batchCount |
用于控制并行执行的批计数(isSequential 设置为 false 时)。 |
int
约束: 最大值 = 50 |
isSequential |
循环应按顺序或并行执行(最大 50) |
bool |
项目 |
要循环访问的集合。 |
表达式(必需) |
名字 |
描述 |
价值 |
数据 |
GetMetadata 活动数据集参考。 |
DatasetReference (必需) |
fieldList |
要从数据集中获取的元数据字段。 |
any[] |
HDInsightHiveActivity
HDInsightHiveActivityTypeProperties
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties
HDInsightPigActivityTypePropertiesDefines
HDInsightSparkActivity
HDInsightSparkActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
HDInsightSparkActivity 的用户指定参数。 |
any[] |
className |
应用程序的 Java/Spark 主类。 |
字符串 |
entryFilePath |
要执行的代码/包的根文件夹的相对路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
proxyUser |
要模拟该作业的用户。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
rootPath |
所有作业文件的“sparkJobLinkedService”中的根路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
sparkConfig |
Spark 配置属性。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
用于上传条目文件和依赖项以及接收日志的存储链接服务。 |
LinkedServiceReference |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightStreamingActivity
HDInsightStreamingActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
用户指定的 HDInsightActivity 参数。 |
any[] |
combiner |
合并器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
commandEnvironment |
命令行环境值。 |
any[] |
定义 |
允许用户指定流式处理作业请求的定义。 |
HDInsightStreamingActivityTypePropertiesDefines |
fileLinkedService |
文件所在的链接服务引用。 |
LinkedServiceReference |
filePaths |
流式处理作业文件的路径。 可以是目录。 |
any[] (必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
输入 |
输入 Blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
映射 |
映射程序可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
输出 |
输出 blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
还原剂 |
化简器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
storageLinkedServices |
存储链接服务引用。 |
LinkedServiceReference[] |
HDInsightStreamingActivityTypePropertiesDefines
IfConditionActivity
IfConditionActivityTypeProperties
名字 |
描述 |
价值 |
表达 |
计算结果为布尔值的表达式。 这用于确定将执行的活动块(ifTrueActivities 或 ifFalseActivities)。 |
表达式(必需) |
ifFalseActivities |
如果表达式的计算结果为 false,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
ifTrueActivities |
如果表达式的计算结果为 true,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
IntegrationRuntimeReference
LinkedServiceReference
名字 |
描述 |
价值 |
参数 |
LinkedService 的参数。 |
ParameterValueSpecification |
referenceName |
引用 LinkedService 名称。 |
string (必需) |
类型 |
链接服务引用类型。 |
“LinkedServiceReference”(必需) |
LookupActivity
LookupActivityTypeProperties
名字 |
描述 |
价值 |
数据 |
查找活动数据集引用。 |
DatasetReference (必需) |
firstRowOnly |
是返回第一行还是所有行。 默认值为 true。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
源 |
特定于数据集的源属性,与复制活动源相同。 |
CopySource (必需) |
Microsoft.DataFactory/factories/pipelines
名字 |
描述 |
价值 |
名字 |
资源名称 |
字符串
约束: 最小长度 = 1 最大长度 = 260 模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需) |
父母 |
在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。
有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:工厂 |
性能 |
管道的属性。 |
管道(必需) |
ParameterDefinitionSpecification
ParameterSpecification
名字 |
描述 |
价值 |
defaultValue |
参数的默认值。 |
任何 |
类型 |
参数类型。 |
“Array” “Bool” “Float” “Int” “Object” “SecureString” “String”(必需) |
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
管道
PipelineReference
名字 |
描述 |
价值 |
名字 |
引用名称。 |
字符串 |
referenceName |
引用管道名称。 |
string (必需) |
类型 |
管道引用类型。 |
“PipelineReference”(必需) |
RedirectIncompatibleRowSettings
名字 |
描述 |
价值 |
linkedServiceName |
用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定 redirectIncompatibleRowSettings,则必须指定。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
路径 |
用于存储重定向不兼容行数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
SecretBase
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
string (必需) |
价值 |
安全字符串的值。 |
string (必需) |
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
“SecureString”(必需) |
价值 |
安全字符串的值。 |
string (必需) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecretBase(必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisConnectionManager
SsisConnectionManager
SsisExecutionCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecureString (必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisExecutionParameter
名字 |
描述 |
价值 |
价值 |
SSIS 包执行参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
SsisLogLocation
名字 |
描述 |
价值 |
logPath |
SSIS 包执行日志路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
类型 |
SSIS 日志位置的类型。 |
“File”(必需) |
typeProperties |
SSIS 包执行日志位置属性。 |
SsisLogLocationTypeProperties (必需) |
SsisLogLocationTypeProperties
名字 |
描述 |
价值 |
|
|
accessCredential |
包执行日志访问凭据。 |
SsisAccessCredential |
|
|
logRefreshInterval |
指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
SsisPackageLocation
SsisPackageLocationTypeProperties
SsisPropertyOverride
名字 |
描述 |
价值 |
isSensitive |
SSIS 包属性重写值是否为敏感数据。 如果值为 true,则会在 SSISDB 中加密值 |
bool |
价值 |
SSIS 包属性重写值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
StagingSettings
名字 |
描述 |
价值 |
enableCompression |
指定是否通过临时暂存复制数据时使用压缩。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
linkedServiceName |
暂存链接服务引用。 |
LinkedServiceReference(必需) |
路径 |
用于存储临时数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
StoredProcedureParameter
名字 |
描述 |
价值 |
类型 |
存储过程参数类型。 |
“Boolean” “Date” “Decimal” “Guid” “Int” “Int64” “String” |
价值 |
存储过程参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
UntilActivity
UntilActivityTypeProperties
名字 |
描述 |
价值 |
|
|
|
|
活动 |
要执行的活动列表。 |
活动[] (必需) |
|
|
|
|
表达 |
计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true |
表达式(必需) |
|
|
|
|
超时 |
指定要运行的活动的超时值。 如果未指定任何值,则采用 TimeSpan.FromDays(7)的值(默认值为 1 周)。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
WaitActivity
WaitActivityTypeProperties
名字 |
描述 |
价值 |
waitTimeInSeconds |
持续时间(以秒为单位)。 |
int (必需) |
WebActivity
WebActivityAuthentication
名字 |
描述 |
价值 |
密码 |
PFX 文件或基本身份验证的密码。 |
SecureString |
pfx |
PFX 文件的 Base64 编码内容。 |
SecureString |
资源 |
使用 MSI 身份验证时,将为其请求 Azure 身份验证令牌的资源。 |
字符串 |
类型 |
Web 活动身份验证 (Basic/ClientCertificate/MSI) |
string (必需) |
username |
用于基本身份验证的 Web 活动身份验证用户名。 |
字符串 |
WebActivityTypeProperties
名字 |
描述 |
价值 |
认证 |
用于调用终结点的身份验证方法。 |
WebActivityAuthentication |
身体 |
表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,不允许 GET 方法类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
数据 |
传递给 Web 终结点的数据集列表。 |
DatasetReference[] |
disableCertValidation |
设置为 true 时,将禁用证书验证。 |
bool |
头 |
表示将发送到请求的标头。 例如,若要在请求上设置语言和类型:“headers”: { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
linkedServices |
传递给 Web 终结点的链接服务列表。 |
LinkedServiceReference[] |
方法 |
目标终结点的 Rest API 方法。 |
“DELETE” “GET” “POST” “PUT”(必需) |
url |
Web 活动目标终结点和路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
快速入门示例
以下快速入门示例部署此资源类型。
Bicep 文件 |
描述 |
创建 V2 数据工厂 |
此模板创建一个 V2 数据工厂,用于将数据从 Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。 |
可以使用 Azure 数据工厂 更多 - 单击一次尝试 Azure 数据工厂 |
此模板为从 Azure Blob 复制到另一个 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" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"annotations": [ {} ],
"concurrency": "int",
"description": "string",
"parameters": {
"{customized property}": {
"defaultValue": {},
"type": "string"
}
}
}
}
SecretBase 对象
设置 类型 属性以指定对象的类型。
对于 AzureKeyVaultSecret,请使用:
{
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "AzureKeyVaultSecret"
}
对于 SecureString,请使用:
{
"type": "SecureString",
"value": "string"
}
活动对象
设置 类型 属性以指定对象的类型。
对于 AzureMLBatchExecution,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "AzureMLBatchExecution",
"typeProperties": {
"globalParameters": {
"{customized property}": {}
},
"webServiceInputs": {
"{customized property}": {
"filePath": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
},
"webServiceOutputs": {
"{customized property}": {
"filePath": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
}
}
对于 AzureMLUpdateResource,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "AzureMLUpdateResource",
"typeProperties": {
"trainedModelFilePath": {},
"trainedModelLinkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"trainedModelName": {}
}
}
对于 ExecutePipeline,请使用:
{
"type": "ExecutePipeline",
"typeProperties": {
"parameters": {
"{customized property}": {}
},
"pipeline": {
"name": "string",
"referenceName": "string",
"type": "string"
},
"waitOnCompletion": "bool"
}
}
对于 筛选器,请使用:
{
"type": "Filter",
"typeProperties": {
"condition": {
"type": "string",
"value": "string"
},
"items": {
"type": "string",
"value": "string"
}
}
}
对于 forEach,请使用:
{
"type": "ForEach",
"typeProperties": {
"activities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"batchCount": "int",
"isSequential": "bool",
"items": {
"type": "string",
"value": "string"
}
}
}
对于 IfCondition,请使用:
{
"type": "IfCondition",
"typeProperties": {
"expression": {
"type": "string",
"value": "string"
},
"ifFalseActivities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"ifTrueActivities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ]
}
}
对于 直到,请使用:
{
"type": "Until",
"typeProperties": {
"activities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"expression": {
"type": "string",
"value": "string"
},
"timeout": {}
}
}
对于 等待,请使用:
{
"type": "Wait",
"typeProperties": {
"waitTimeInSeconds": "int"
}
}
对于 复制,请使用:
{
"inputs": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"outputs": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Copy",
"typeProperties": {
"cloudDataMovementUnits": {},
"enableSkipIncompatibleRow": {},
"enableStaging": {},
"parallelCopies": {},
"redirectIncompatibleRowSettings": {
"linkedServiceName": {},
"path": {}
},
"sink": {
"sinkRetryCount": {},
"sinkRetryWait": {},
"writeBatchSize": {},
"writeBatchTimeout": {},
"type": "string"
// For remaining properties, see CopySink objects
},
"source": {
"sourceRetryCount": {},
"sourceRetryWait": {},
"type": "string"
// For remaining properties, see CopySource objects
},
"stagingSettings": {
"enableCompression": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"path": {}
},
"translator": {}
}
}
对于 自定义,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Custom",
"typeProperties": {
"command": {},
"extendedProperties": {
"{customized property}": {}
},
"folderPath": {},
"referenceObjects": {
"datasets": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"linkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
},
"resourceLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
对于 DataLakeAnalyticsU-SQL,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "DataLakeAnalyticsU-SQL",
"typeProperties": {
"compilationMode": {},
"degreeOfParallelism": {},
"parameters": {
"{customized property}": {}
},
"priority": {},
"runtimeVersion": {},
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {}
}
}
对于 DatabricksNotebook,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "DatabricksNotebook",
"typeProperties": {
"baseParameters": {
"{customized property}": {}
},
"notebookPath": {}
}
}
对于 ExecuteSSISPackage,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "ExecuteSSISPackage",
"typeProperties": {
"connectVia": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"environmentPath": {},
"executionCredential": {
"domain": {},
"password": {
"type": "string",
"value": "string"
},
"userName": {}
},
"loggingLevel": {},
"logLocation": {
"logPath": {},
"type": "string",
"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": {}
}
}
对于 GetMetadata,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "GetMetadata",
"typeProperties": {
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"fieldList": [ {} ]
}
}
对于 HDInsightHive,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightHive",
"typeProperties": {
"arguments": [ {} ],
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
对于 HDInsightMapReduce,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightMapReduce",
"typeProperties": {
"arguments": [ {} ],
"className": {},
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"jarFilePath": {},
"jarLibs": [ {} ],
"jarLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
对于 HDInsightPig,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightPig",
"typeProperties": {
"arguments": [ {} ],
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
对于 HDInsightSpark,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightSpark",
"typeProperties": {
"arguments": [ {} ],
"className": "string",
"entryFilePath": {},
"getDebugInfo": "string",
"proxyUser": {},
"rootPath": {},
"sparkConfig": {
"{customized property}": {}
},
"sparkJobLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
对于 HDInsightStreaming,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightStreaming",
"typeProperties": {
"arguments": [ {} ],
"combiner": {},
"commandEnvironment": [ {} ],
"defines": {
"{customized property}": {}
},
"fileLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"filePaths": [ {} ],
"getDebugInfo": "string",
"input": {},
"mapper": {},
"output": {},
"reducer": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
对于 查找,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Lookup",
"typeProperties": {
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"firstRowOnly": {},
"source": {
"sourceRetryCount": {},
"sourceRetryWait": {},
"type": "string"
// For remaining properties, see CopySource objects
}
}
}
对于 SqlServerStoredProcedure,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "SqlServerStoredProcedure",
"typeProperties": {
"storedProcedureName": {},
"storedProcedureParameters": {
"{customized property}": {
"type": "string",
"value": {}
}
}
}
}
对于 WebActivity,请使用:
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "WebActivity",
"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": "string"
}
],
"disableCertValidation": "bool",
"headers": {},
"linkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"method": "string",
"url": {}
}
}
CopySource 对象
设置 类型 属性以指定对象的类型。
CopySink 对象
设置 类型 属性以指定对象的类型。
属性值
活动
ActivityDependency
名字 |
描述 |
价值 |
活动 |
活动名称。 |
string (必需) |
dependencyConditions |
Match-Condition 依赖项。 |
包含任一项的字符串数组: “Completed” “Failed” “跳过” “Succeeded”(必需) |
ActivityPolicy
名字 |
描述 |
价值 |
|
|
重试 |
最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
retryIntervalInSeconds |
每次重试尝试(以秒为单位)之间的间隔。 默认值为 30 秒。 |
int
约束: 最小值 = 30 最大值 = 86400 |
|
|
secureOutput |
设置为 true 时,活动输出被视为安全,不会记录到监视中。 |
bool |
|
|
超时 |
指定要运行的活动的超时值。 默认超时为 7 天。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
AzureKeyVaultSecretReference
名字 |
描述 |
价值 |
secretName |
Azure Key Vault 中机密的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
secretVersion |
Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
商店 |
Azure Key Vault 链接服务参考。 |
LinkedServiceReference(必需) |
类型 |
机密的类型。 |
“AzureKeyVaultSecret”(必需) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeProperties
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties
名字 |
描述 |
价值 |
trainedModelFilePath |
trainedModelLinkedService 中的相对文件路径,表示将由更新操作上传的 .ilearner 文件。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
trainedModelLinkedServiceName |
保存由更新操作上传的 .ilearner 文件的 Azure 存储链接服务的名称。 |
LinkedServiceReference(必需) |
trainedModelName |
要更新的 Web 服务试验中训练的模型模块的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
AzureMLWebServiceFile
名字 |
描述 |
价值 |
filePath |
LinkedService 指定的 Azure Blob 存储中的相对文件路径,包括容器名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
linkedServiceName |
对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件位于其中。 |
LinkedServiceReference(必需) |
CopyActivity
CopyActivityTypeProperties
名字 |
描述 |
价值 |
cloudDataMovementUnits |
可用于执行此数据移动的云数据移动单元的最大数量。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
enableSkipIncompatibleRow |
是否跳过不兼容行。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
enableStaging |
指定是否通过临时暂存复制数据。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
parallelCopies |
在源或接收器上打开的最大并发会话数,以避免重载数据存储。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
redirectIncompatibleRowSettings |
当 EnableSkipIncompatibleRow 为 true 时重定向不兼容行设置。 |
RedirectIncompatibleRowSettings |
沉 |
复制活动接收器。 |
CopySink (必需) |
源 |
复制活动源。 |
CopySource (必需) |
stagingSettings |
指定 EnableStaging 为 true 时的临时暂存设置。 |
StagingSettings |
在线翻译 |
复制活动翻译器。 如果未指定,则使用表格翻译器。 |
任何 |
CopySink
名字 |
描述 |
价值 |
|
|
sinkRetryCount |
接收器重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sinkRetryWait |
接收器重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
writeBatchSize |
写入批大小。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
writeBatchTimeout |
写入批处理超时。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
CopySource
名字 |
描述 |
价值 |
|
|
sourceRetryCount |
源重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sourceRetryWait |
源重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
CustomActivity
CustomActivityReferenceObject
CustomActivityTypeProperties
CustomActivityTypePropertiesExtendedProperties
DatabricksNotebookActivity
DatabricksNotebookActivityTypeProperties
DatabricksNotebookActivityTypePropertiesBaseParameters
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties
名字 |
描述 |
价值 |
compilationMode |
U-SQL 的编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
degreeOfParallelism |
用于运行作业的最大节点数。 默认值为 1。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
参数 |
U-SQL 作业请求的参数。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
优先权 |
确定应选择已排队的所有作业中的哪些作业以先运行。 数字越低,优先级越高。 默认值为 1000。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
runtimeVersion |
要使用的 U-SQL 引擎的运行时版本。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
scriptLinkedService |
编写链接服务引用脚本。 |
LinkedServiceReference(必需) |
scriptPath |
包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
DatasetReference
ExecutePipelineActivity
ExecutePipelineActivityTypeProperties
ExecuteSsisPackageActivity
ExecuteSsisPackageActivityTypeProperties
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers
ExecuteSsisPackageActivityTypePropertiesProjectParameters
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表达
名字 |
描述 |
价值 |
类型 |
表达式类型。 |
“表达式”(必需) |
价值 |
表达式值。 |
string (必需) |
FilterActivity
FilterActivityTypeProperties
名字 |
描述 |
价值 |
条件 |
用于筛选输入的条件。 |
表达式(必需) |
项目 |
应对其应用筛选器的输入数组。 |
表达式(必需) |
ForEachActivity
ForEachActivityTypeProperties
名字 |
描述 |
价值 |
活动 |
要执行的活动列表。 |
活动[] (必需) |
batchCount |
用于控制并行执行的批计数(isSequential 设置为 false 时)。 |
int
约束: 最大值 = 50 |
isSequential |
循环应按顺序或并行执行(最大 50) |
bool |
项目 |
要循环访问的集合。 |
表达式(必需) |
名字 |
描述 |
价值 |
数据 |
GetMetadata 活动数据集参考。 |
DatasetReference (必需) |
fieldList |
要从数据集中获取的元数据字段。 |
any[] |
HDInsightHiveActivity
HDInsightHiveActivityTypeProperties
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties
HDInsightPigActivityTypePropertiesDefines
HDInsightSparkActivity
HDInsightSparkActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
HDInsightSparkActivity 的用户指定参数。 |
any[] |
className |
应用程序的 Java/Spark 主类。 |
字符串 |
entryFilePath |
要执行的代码/包的根文件夹的相对路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
proxyUser |
要模拟该作业的用户。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
rootPath |
所有作业文件的“sparkJobLinkedService”中的根路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
sparkConfig |
Spark 配置属性。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
用于上传条目文件和依赖项以及接收日志的存储链接服务。 |
LinkedServiceReference |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightStreamingActivity
HDInsightStreamingActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
用户指定的 HDInsightActivity 参数。 |
any[] |
combiner |
合并器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
commandEnvironment |
命令行环境值。 |
any[] |
定义 |
允许用户指定流式处理作业请求的定义。 |
HDInsightStreamingActivityTypePropertiesDefines |
fileLinkedService |
文件所在的链接服务引用。 |
LinkedServiceReference |
filePaths |
流式处理作业文件的路径。 可以是目录。 |
any[] (必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
输入 |
输入 Blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
映射 |
映射程序可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
输出 |
输出 blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
还原剂 |
化简器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
storageLinkedServices |
存储链接服务引用。 |
LinkedServiceReference[] |
HDInsightStreamingActivityTypePropertiesDefines
IfConditionActivity
IfConditionActivityTypeProperties
名字 |
描述 |
价值 |
表达 |
计算结果为布尔值的表达式。 这用于确定将执行的活动块(ifTrueActivities 或 ifFalseActivities)。 |
表达式(必需) |
ifFalseActivities |
如果表达式的计算结果为 false,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
ifTrueActivities |
如果表达式的计算结果为 true,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
IntegrationRuntimeReference
LinkedServiceReference
名字 |
描述 |
价值 |
参数 |
LinkedService 的参数。 |
ParameterValueSpecification |
referenceName |
引用 LinkedService 名称。 |
string (必需) |
类型 |
链接服务引用类型。 |
“LinkedServiceReference”(必需) |
LookupActivity
LookupActivityTypeProperties
名字 |
描述 |
价值 |
数据 |
查找活动数据集引用。 |
DatasetReference (必需) |
firstRowOnly |
是返回第一行还是所有行。 默认值为 true。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
源 |
特定于数据集的源属性,与复制活动源相同。 |
CopySource (必需) |
Microsoft.DataFactory/factories/pipelines
名字 |
描述 |
价值 |
apiVersion |
API 版本 |
'2017-09-01-preview' |
名字 |
资源名称 |
字符串
约束: 最小长度 = 1 最大长度 = 260 模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需) |
性能 |
管道的属性。 |
管道(必需) |
类型 |
资源类型 |
“Microsoft.DataFactory/factories/pipelines” |
ParameterDefinitionSpecification
ParameterSpecification
名字 |
描述 |
价值 |
defaultValue |
参数的默认值。 |
任何 |
类型 |
参数类型。 |
“Array” “Bool” “Float” “Int” “Object” “SecureString” “String”(必需) |
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
管道
PipelineReference
名字 |
描述 |
价值 |
名字 |
引用名称。 |
字符串 |
referenceName |
引用管道名称。 |
string (必需) |
类型 |
管道引用类型。 |
“PipelineReference”(必需) |
RedirectIncompatibleRowSettings
名字 |
描述 |
价值 |
linkedServiceName |
用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定 redirectIncompatibleRowSettings,则必须指定。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
路径 |
用于存储重定向不兼容行数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
SecretBase
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
string (必需) |
价值 |
安全字符串的值。 |
string (必需) |
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
“SecureString”(必需) |
价值 |
安全字符串的值。 |
string (必需) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecretBase(必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisConnectionManager
SsisConnectionManager
SsisExecutionCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecureString (必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisExecutionParameter
名字 |
描述 |
价值 |
价值 |
SSIS 包执行参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
SsisLogLocation
名字 |
描述 |
价值 |
logPath |
SSIS 包执行日志路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
类型 |
SSIS 日志位置的类型。 |
“File”(必需) |
typeProperties |
SSIS 包执行日志位置属性。 |
SsisLogLocationTypeProperties (必需) |
SsisLogLocationTypeProperties
名字 |
描述 |
价值 |
|
|
accessCredential |
包执行日志访问凭据。 |
SsisAccessCredential |
|
|
logRefreshInterval |
指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
SsisPackageLocation
SsisPackageLocationTypeProperties
SsisPropertyOverride
名字 |
描述 |
价值 |
isSensitive |
SSIS 包属性重写值是否为敏感数据。 如果值为 true,则会在 SSISDB 中加密值 |
bool |
价值 |
SSIS 包属性重写值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
StagingSettings
名字 |
描述 |
价值 |
enableCompression |
指定是否通过临时暂存复制数据时使用压缩。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
linkedServiceName |
暂存链接服务引用。 |
LinkedServiceReference(必需) |
路径 |
用于存储临时数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
StoredProcedureParameter
名字 |
描述 |
价值 |
类型 |
存储过程参数类型。 |
“Boolean” “Date” “Decimal” “Guid” “Int” “Int64” “String” |
价值 |
存储过程参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
UntilActivity
UntilActivityTypeProperties
名字 |
描述 |
价值 |
|
|
|
|
活动 |
要执行的活动列表。 |
活动[] (必需) |
|
|
|
|
表达 |
计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true |
表达式(必需) |
|
|
|
|
超时 |
指定要运行的活动的超时值。 如果未指定任何值,则采用 TimeSpan.FromDays(7)的值(默认值为 1 周)。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
WaitActivity
WaitActivityTypeProperties
名字 |
描述 |
价值 |
waitTimeInSeconds |
持续时间(以秒为单位)。 |
int (必需) |
WebActivity
WebActivityAuthentication
名字 |
描述 |
价值 |
密码 |
PFX 文件或基本身份验证的密码。 |
SecureString |
pfx |
PFX 文件的 Base64 编码内容。 |
SecureString |
资源 |
使用 MSI 身份验证时,将为其请求 Azure 身份验证令牌的资源。 |
字符串 |
类型 |
Web 活动身份验证 (Basic/ClientCertificate/MSI) |
string (必需) |
username |
用于基本身份验证的 Web 活动身份验证用户名。 |
字符串 |
WebActivityTypeProperties
名字 |
描述 |
价值 |
认证 |
用于调用终结点的身份验证方法。 |
WebActivityAuthentication |
身体 |
表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,不允许 GET 方法类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
数据 |
传递给 Web 终结点的数据集列表。 |
DatasetReference[] |
disableCertValidation |
设置为 true 时,将禁用证书验证。 |
bool |
头 |
表示将发送到请求的标头。 例如,若要在请求上设置语言和类型:“headers”: { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
linkedServices |
传递给 Web 终结点的链接服务列表。 |
LinkedServiceReference[] |
方法 |
目标终结点的 Rest API 方法。 |
“DELETE” “GET” “POST” “PUT”(必需) |
url |
Web 活动目标终结点和路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
快速入门模板
以下快速入门模板部署此资源类型。
模板 |
描述 |
创建 V2 数据工厂
|
此模板创建一个 V2 数据工厂,用于将数据从 Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。 |
可以使用 Azure 数据工厂 更多 - 单击一次尝试 Azure 数据工厂
|
此模板为从 Azure Blob 复制到另一个 Azure Blob 中的复制活动创建数据工厂管道 |
工厂/管道资源类型可以使用目标操作进行部署:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.DataFactory/factories/pipelines 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataFactory/factories/pipelines@2017-09-01-preview"
name = "string"
body = jsonencode({
properties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
annotations = [
?
]
concurrency = int
description = "string"
parameters = {
{customized property} = {
defaultValue = ?
type = "string"
}
}
}
})
}
SecretBase 对象
设置 类型 属性以指定对象的类型。
对于 AzureKeyVaultSecret,请使用:
{
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "AzureKeyVaultSecret"
}
对于 SecureString,请使用:
{
type = "SecureString"
value = "string"
}
活动对象
设置 类型 属性以指定对象的类型。
对于 AzureMLBatchExecution,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "AzureMLBatchExecution"
typeProperties = {
globalParameters = {
{customized property} = ?
}
webServiceInputs = {
{customized property} = {
filePath = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
webServiceOutputs = {
{customized property} = {
filePath = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
}
}
对于 AzureMLUpdateResource,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "AzureMLUpdateResource"
typeProperties = {
trainedModelFilePath = ?
trainedModelLinkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
trainedModelName = ?
}
}
对于 ExecutePipeline,请使用:
{
type = "ExecutePipeline"
typeProperties = {
parameters = {
{customized property} = ?
}
pipeline = {
name = "string"
referenceName = "string"
type = "string"
}
waitOnCompletion = bool
}
}
对于 筛选器,请使用:
{
type = "Filter"
typeProperties = {
condition = {
type = "string"
value = "string"
}
items = {
type = "string"
value = "string"
}
}
}
对于 forEach,请使用:
{
type = "ForEach"
typeProperties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
batchCount = int
isSequential = bool
items = {
type = "string"
value = "string"
}
}
}
对于 IfCondition,请使用:
{
type = "IfCondition"
typeProperties = {
expression = {
type = "string"
value = "string"
}
ifFalseActivities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
ifTrueActivities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
}
}
对于 直到,请使用:
{
type = "Until"
typeProperties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
expression = {
type = "string"
value = "string"
}
timeout = ?
}
}
对于 等待,请使用:
{
type = "Wait"
typeProperties = {
waitTimeInSeconds = int
}
}
对于 复制,请使用:
{
inputs = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
outputs = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Copy"
typeProperties = {
cloudDataMovementUnits = ?
enableSkipIncompatibleRow = ?
enableStaging = ?
parallelCopies = ?
redirectIncompatibleRowSettings = {
linkedServiceName = ?
path = ?
}
sink = {
sinkRetryCount = ?
sinkRetryWait = ?
writeBatchSize = ?
writeBatchTimeout = ?
type = "string"
// For remaining properties, see CopySink objects
}
source = {
sourceRetryCount = ?
sourceRetryWait = ?
type = "string"
// For remaining properties, see CopySource objects
}
stagingSettings = {
enableCompression = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
path = ?
}
translator = ?
}
}
对于 自定义,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Custom"
typeProperties = {
command = ?
extendedProperties = {
{customized property} = ?
}
folderPath = ?
referenceObjects = {
datasets = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
linkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
resourceLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
对于 DataLakeAnalyticsU-SQL,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "DataLakeAnalyticsU-SQL"
typeProperties = {
compilationMode = ?
degreeOfParallelism = ?
parameters = {
{customized property} = ?
}
priority = ?
runtimeVersion = ?
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
}
}
对于 DatabricksNotebook,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "DatabricksNotebook"
typeProperties = {
baseParameters = {
{customized property} = ?
}
notebookPath = ?
}
}
对于 ExecuteSSISPackage,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "ExecuteSSISPackage"
typeProperties = {
connectVia = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
environmentPath = ?
executionCredential = {
domain = ?
password = {
type = "string"
value = "string"
}
userName = ?
}
loggingLevel = ?
logLocation = {
logPath = ?
type = "string"
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 = ?
}
}
对于 GetMetadata,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "GetMetadata"
typeProperties = {
dataset = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
fieldList = [
?
]
}
}
对于 HDInsightHive,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightHive"
typeProperties = {
arguments = [
?
]
defines = {
{customized property} = ?
}
getDebugInfo = "string"
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
对于 HDInsightMapReduce,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightMapReduce"
typeProperties = {
arguments = [
?
]
className = ?
defines = {
{customized property} = ?
}
getDebugInfo = "string"
jarFilePath = ?
jarLibs = [
?
]
jarLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
对于 HDInsightPig,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightPig"
typeProperties = {
arguments = [
?
]
defines = {
{customized property} = ?
}
getDebugInfo = "string"
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
对于 HDInsightSpark,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightSpark"
typeProperties = {
arguments = [
?
]
className = "string"
entryFilePath = ?
getDebugInfo = "string"
proxyUser = ?
rootPath = ?
sparkConfig = {
{customized property} = ?
}
sparkJobLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
对于 HDInsightStreaming,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightStreaming"
typeProperties = {
arguments = [
?
]
combiner = ?
commandEnvironment = [
?
]
defines = {
{customized property} = ?
}
fileLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
filePaths = [
?
]
getDebugInfo = "string"
input = ?
mapper = ?
output = ?
reducer = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
对于 查找,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Lookup"
typeProperties = {
dataset = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
firstRowOnly = ?
source = {
sourceRetryCount = ?
sourceRetryWait = ?
type = "string"
// For remaining properties, see CopySource objects
}
}
}
对于 SqlServerStoredProcedure,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "SqlServerStoredProcedure"
typeProperties = {
storedProcedureName = ?
storedProcedureParameters = {
{customized property} = {
type = "string"
value = ?
}
}
}
}
对于 WebActivity,请使用:
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "WebActivity"
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 = "string"
}
]
disableCertValidation = bool
headers = ?
linkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
method = "string"
url = ?
}
}
CopySource 对象
设置 类型 属性以指定对象的类型。
CopySink 对象
设置 类型 属性以指定对象的类型。
属性值
活动
ActivityDependency
名字 |
描述 |
价值 |
活动 |
活动名称。 |
string (必需) |
dependencyConditions |
Match-Condition 依赖项。 |
包含任一项的字符串数组: “Completed” “Failed” “跳过” “Succeeded”(必需) |
ActivityPolicy
名字 |
描述 |
价值 |
|
|
重试 |
最大普通重试尝试次数。 默认值为 0。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
retryIntervalInSeconds |
每次重试尝试(以秒为单位)之间的间隔。 默认值为 30 秒。 |
int
约束: 最小值 = 30 最大值 = 86400 |
|
|
secureOutput |
设置为 true 时,活动输出被视为安全,不会记录到监视中。 |
bool |
|
|
超时 |
指定要运行的活动的超时值。 默认超时为 7 天。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
AzureKeyVaultSecretReference
名字 |
描述 |
价值 |
secretName |
Azure Key Vault 中机密的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
secretVersion |
Azure Key Vault 中的机密版本。 默认值为最新版本的机密。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
商店 |
Azure Key Vault 链接服务参考。 |
LinkedServiceReference(必需) |
类型 |
机密的类型。 |
“AzureKeyVaultSecret”(必需) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeProperties
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties
名字 |
描述 |
价值 |
trainedModelFilePath |
trainedModelLinkedService 中的相对文件路径,表示将由更新操作上传的 .ilearner 文件。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
trainedModelLinkedServiceName |
保存由更新操作上传的 .ilearner 文件的 Azure 存储链接服务的名称。 |
LinkedServiceReference(必需) |
trainedModelName |
要更新的 Web 服务试验中训练的模型模块的名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
AzureMLWebServiceFile
名字 |
描述 |
价值 |
filePath |
LinkedService 指定的 Azure Blob 存储中的相对文件路径,包括容器名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
linkedServiceName |
对 Azure 存储 LinkedService 的引用,其中 Azure ML WebService 输入/输出文件位于其中。 |
LinkedServiceReference(必需) |
CopyActivity
CopyActivityTypeProperties
名字 |
描述 |
价值 |
cloudDataMovementUnits |
可用于执行此数据移动的云数据移动单元的最大数量。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
enableSkipIncompatibleRow |
是否跳过不兼容行。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
enableStaging |
指定是否通过临时暂存复制数据。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
parallelCopies |
在源或接收器上打开的最大并发会话数,以避免重载数据存储。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
redirectIncompatibleRowSettings |
当 EnableSkipIncompatibleRow 为 true 时重定向不兼容行设置。 |
RedirectIncompatibleRowSettings |
沉 |
复制活动接收器。 |
CopySink (必需) |
源 |
复制活动源。 |
CopySource (必需) |
stagingSettings |
指定 EnableStaging 为 true 时的临时暂存设置。 |
StagingSettings |
在线翻译 |
复制活动翻译器。 如果未指定,则使用表格翻译器。 |
任何 |
CopySink
名字 |
描述 |
价值 |
|
|
sinkRetryCount |
接收器重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sinkRetryWait |
接收器重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
writeBatchSize |
写入批大小。 类型:整数(或包含 resultType 整数的表达式),最小值:0。 |
任何 |
|
|
writeBatchTimeout |
写入批处理超时。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
CopySource
名字 |
描述 |
价值 |
|
|
sourceRetryCount |
源重试计数。 类型:整数(或包含 resultType 整数的表达式)。 |
任何 |
|
|
sourceRetryWait |
源重试等待。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
类型 |
|
(必需) |
|
|
CustomActivity
CustomActivityReferenceObject
CustomActivityTypeProperties
CustomActivityTypePropertiesExtendedProperties
DatabricksNotebookActivity
DatabricksNotebookActivityTypeProperties
DatabricksNotebookActivityTypePropertiesBaseParameters
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties
名字 |
描述 |
价值 |
compilationMode |
U-SQL 的编译模式。 必须是以下值之一:Semantic、Full 和 SingleBox。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
degreeOfParallelism |
用于运行作业的最大节点数。 默认值为 1。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
参数 |
U-SQL 作业请求的参数。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
优先权 |
确定应选择已排队的所有作业中的哪些作业以先运行。 数字越低,优先级越高。 默认值为 1000。 类型:integer(或 Expression with resultType integer),最小值:1。 |
任何 |
runtimeVersion |
要使用的 U-SQL 引擎的运行时版本。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
scriptLinkedService |
编写链接服务引用脚本。 |
LinkedServiceReference(必需) |
scriptPath |
包含 U-SQL 脚本的文件夹的区分大小写的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
DatasetReference
ExecutePipelineActivity
ExecutePipelineActivityTypeProperties
ExecuteSsisPackageActivity
ExecuteSsisPackageActivityTypeProperties
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers
ExecuteSsisPackageActivityTypePropertiesProjectParameters
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表达
名字 |
描述 |
价值 |
类型 |
表达式类型。 |
“表达式”(必需) |
价值 |
表达式值。 |
string (必需) |
FilterActivity
FilterActivityTypeProperties
名字 |
描述 |
价值 |
条件 |
用于筛选输入的条件。 |
表达式(必需) |
项目 |
应对其应用筛选器的输入数组。 |
表达式(必需) |
ForEachActivity
ForEachActivityTypeProperties
名字 |
描述 |
价值 |
活动 |
要执行的活动列表。 |
活动[] (必需) |
batchCount |
用于控制并行执行的批计数(isSequential 设置为 false 时)。 |
int
约束: 最大值 = 50 |
isSequential |
循环应按顺序或并行执行(最大 50) |
bool |
项目 |
要循环访问的集合。 |
表达式(必需) |
名字 |
描述 |
价值 |
数据 |
GetMetadata 活动数据集参考。 |
DatasetReference (必需) |
fieldList |
要从数据集中获取的元数据字段。 |
any[] |
HDInsightHiveActivity
HDInsightHiveActivityTypeProperties
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties
HDInsightPigActivityTypePropertiesDefines
HDInsightSparkActivity
HDInsightSparkActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
HDInsightSparkActivity 的用户指定参数。 |
any[] |
className |
应用程序的 Java/Spark 主类。 |
字符串 |
entryFilePath |
要执行的代码/包的根文件夹的相对路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
proxyUser |
要模拟该作业的用户。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
rootPath |
所有作业文件的“sparkJobLinkedService”中的根路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
sparkConfig |
Spark 配置属性。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
用于上传条目文件和依赖项以及接收日志的存储链接服务。 |
LinkedServiceReference |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightStreamingActivity
HDInsightStreamingActivityTypeProperties
名字 |
描述 |
价值 |
参数 |
用户指定的 HDInsightActivity 参数。 |
any[] |
combiner |
合并器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
commandEnvironment |
命令行环境值。 |
any[] |
定义 |
允许用户指定流式处理作业请求的定义。 |
HDInsightStreamingActivityTypePropertiesDefines |
fileLinkedService |
文件所在的链接服务引用。 |
LinkedServiceReference |
filePaths |
流式处理作业文件的路径。 可以是目录。 |
any[] (必需) |
getDebugInfo |
调试信息选项。 |
“Always” “Failure” “None” |
输入 |
输入 Blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
映射 |
映射程序可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
输出 |
输出 blob 路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
还原剂 |
化简器可执行文件名称。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
storageLinkedServices |
存储链接服务引用。 |
LinkedServiceReference[] |
HDInsightStreamingActivityTypePropertiesDefines
IfConditionActivity
IfConditionActivityTypeProperties
名字 |
描述 |
价值 |
表达 |
计算结果为布尔值的表达式。 这用于确定将执行的活动块(ifTrueActivities 或 ifFalseActivities)。 |
表达式(必需) |
ifFalseActivities |
如果表达式的计算结果为 false,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
ifTrueActivities |
如果表达式的计算结果为 true,则要执行的活动列表。 这是一个可选属性,如果未提供,活动将退出而不执行任何操作。 |
活动[] |
IntegrationRuntimeReference
LinkedServiceReference
名字 |
描述 |
价值 |
参数 |
LinkedService 的参数。 |
ParameterValueSpecification |
referenceName |
引用 LinkedService 名称。 |
string (必需) |
类型 |
链接服务引用类型。 |
“LinkedServiceReference”(必需) |
LookupActivity
LookupActivityTypeProperties
名字 |
描述 |
价值 |
数据 |
查找活动数据集引用。 |
DatasetReference (必需) |
firstRowOnly |
是返回第一行还是所有行。 默认值为 true。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
源 |
特定于数据集的源属性,与复制活动源相同。 |
CopySource (必需) |
Microsoft.DataFactory/factories/pipelines
名字 |
描述 |
价值 |
名字 |
资源名称 |
字符串
约束: 最小长度 = 1 最大长度 = 260 模式 = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必需) |
parent_id |
此资源的父资源的 ID。 |
类型资源的 ID:工厂 |
性能 |
管道的属性。 |
管道(必需) |
类型 |
资源类型 |
“Microsoft.DataFactory/factories/pipelines@2017-09-01-preview” |
ParameterDefinitionSpecification
ParameterSpecification
名字 |
描述 |
价值 |
defaultValue |
参数的默认值。 |
任何 |
类型 |
参数类型。 |
“Array” “Bool” “Float” “Int” “Object” “SecureString” “String”(必需) |
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
ParameterValueSpecification
管道
PipelineReference
名字 |
描述 |
价值 |
名字 |
引用名称。 |
字符串 |
referenceName |
引用管道名称。 |
string (必需) |
类型 |
管道引用类型。 |
“PipelineReference”(必需) |
RedirectIncompatibleRowSettings
名字 |
描述 |
价值 |
linkedServiceName |
用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。 如果指定 redirectIncompatibleRowSettings,则必须指定。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
路径 |
用于存储重定向不兼容行数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
SecretBase
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
string (必需) |
价值 |
安全字符串的值。 |
string (必需) |
SecureString
名字 |
描述 |
价值 |
类型 |
机密的类型。 |
“SecureString”(必需) |
价值 |
安全字符串的值。 |
string (必需) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecretBase(必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisConnectionManager
SsisConnectionManager
SsisExecutionCredential
名字 |
描述 |
价值 |
域 |
用于 Windows 身份验证的域。 |
任何(必需) |
密码 |
Windows 身份验证的密码。 |
SecureString (必需) |
userName |
用于 Windows 身份验证的 UseName。 |
任何(必需) |
SsisExecutionParameter
名字 |
描述 |
价值 |
价值 |
SSIS 包执行参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
SsisLogLocation
名字 |
描述 |
价值 |
logPath |
SSIS 包执行日志路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
类型 |
SSIS 日志位置的类型。 |
“File”(必需) |
typeProperties |
SSIS 包执行日志位置属性。 |
SsisLogLocationTypeProperties (必需) |
SsisLogLocationTypeProperties
名字 |
描述 |
价值 |
|
|
accessCredential |
包执行日志访问凭据。 |
SsisAccessCredential |
|
|
logRefreshInterval |
指定刷新日志的间隔。 默认间隔为 5 分钟。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
SsisPackageLocation
SsisPackageLocationTypeProperties
SsisPropertyOverride
名字 |
描述 |
价值 |
isSensitive |
SSIS 包属性重写值是否为敏感数据。 如果值为 true,则会在 SSISDB 中加密值 |
bool |
价值 |
SSIS 包属性重写值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
StagingSettings
名字 |
描述 |
价值 |
enableCompression |
指定是否通过临时暂存复制数据时使用压缩。 默认值为 false。 类型:布尔值(或带有 resultType 布尔值的表达式)。 |
任何 |
linkedServiceName |
暂存链接服务引用。 |
LinkedServiceReference(必需) |
路径 |
用于存储临时数据的路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
StoredProcedureParameter
名字 |
描述 |
价值 |
类型 |
存储过程参数类型。 |
“Boolean” “Date” “Decimal” “Guid” “Int” “Int64” “String” |
价值 |
存储过程参数值。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |
UntilActivity
UntilActivityTypeProperties
名字 |
描述 |
价值 |
|
|
|
|
活动 |
要执行的活动列表。 |
活动[] (必需) |
|
|
|
|
表达 |
计算结果为布尔值的表达式。 循环将继续,直到此表达式的计算结果为 true |
表达式(必需) |
|
|
|
|
超时 |
指定要运行的活动的超时值。 如果未指定任何值,则采用 TimeSpan.FromDays(7)的值(默认值为 1 周)。 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). 类型:string(或带有 resultType 字符串的表达式),模式:(\d+)。?(\d\d):(60 |
([0-5][0-9])):(60 |
([0-5][0-9])). |
任何 |
WaitActivity
WaitActivityTypeProperties
名字 |
描述 |
价值 |
waitTimeInSeconds |
持续时间(以秒为单位)。 |
int (必需) |
WebActivity
WebActivityAuthentication
名字 |
描述 |
价值 |
密码 |
PFX 文件或基本身份验证的密码。 |
SecureString |
pfx |
PFX 文件的 Base64 编码内容。 |
SecureString |
资源 |
使用 MSI 身份验证时,将为其请求 Azure 身份验证令牌的资源。 |
字符串 |
类型 |
Web 活动身份验证 (Basic/ClientCertificate/MSI) |
string (必需) |
username |
用于基本身份验证的 Web 活动身份验证用户名。 |
字符串 |
WebActivityTypeProperties
名字 |
描述 |
价值 |
认证 |
用于调用终结点的身份验证方法。 |
WebActivityAuthentication |
身体 |
表示将发送到终结点的有效负载。 POST/PUT 方法是必需的,不允许 GET 方法类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
数据 |
传递给 Web 终结点的数据集列表。 |
DatasetReference[] |
disableCertValidation |
设置为 true 时,将禁用证书验证。 |
bool |
头 |
表示将发送到请求的标头。 例如,若要在请求上设置语言和类型:“headers”: { “Accept-Language”: “en-us”, “Content-Type”: “application/json” }。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何 |
linkedServices |
传递给 Web 终结点的链接服务列表。 |
LinkedServiceReference[] |
方法 |
目标终结点的 Rest API 方法。 |
“DELETE” “GET” “POST” “PUT”(必需) |
url |
Web 活动目标终结点和路径。 类型:字符串(或带有 resultType 字符串的表达式)。 |
任何(必需) |