Pipelines - Create Or Update

服務:

Data Factory

API 版本:

2018-06-01

建立或更新管線。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}?api-version=2018-06-01

URI 參數

名稱	位於	必要	類型	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Factory 名稱。
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$	管線名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	資源組名。
subscriptionId	path	True	string	訂用帳戶標識碼。
api-version	query	True	string	API 版本。

要求標頭

名稱	必要	類型	Description
If-Match		string	管線實體的 ETag。 應該只針對更新指定，而更新應該符合現有的實體，也可以為 * 進行無條件更新。

要求本文

名稱	類型	Description
properties.activities	Activity[]: ControlActivity[] ExecutionActivity[] ExecuteWranglingDataflowActivity[] CopyActivity[] HDInsightHiveActivity[] HDInsightPigActivity[] HDInsightMapReduceActivity[] HDInsightStreamingActivity[] HDInsightSparkActivity[] ExecuteSSISPackageActivity[] CustomActivity[] SqlServerStoredProcedureActivity[] DeleteActivity[] AzureDataExplorerCommandActivity[] LookupActivity[] WebActivity[] GetMetadataActivity[] AzureMLBatchExecutionActivity[] AzureMLUpdateResourceActivity[] AzureMLExecutePipelineActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DatabricksJobActivity[] AzureFunctionActivity[] ExecuteDataFlowActivity[] ScriptActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] ExecutePipelineActivity[] IfConditionActivity[] SwitchActivity[] ForEachActivity[] WaitActivity[] FailActivity[] UntilActivity[] ValidationActivity[] FilterActivity[] SetVariableActivity[] AppendVariableActivity[] WebHookActivity[]	管線中的活動清單。
properties.annotations	object[]	可用於描述管線的標記清單。
properties.concurrency	integer minimum: 1	管線的並行執行數目上限。
properties.description	string	管線的描述。
properties.folder	Folder	此管線位於的資料夾。 如果未指定，管線將會出現在根層級。
properties.parameters	<string,  ParameterSpecification>	管線的參數清單。
properties.policy	PipelinePolicy	管線原則。
properties.runDimensions	object	管線發出的維度。
properties.variables	<string,  VariableSpecification>	管線的變數清單。

回應

名稱	類型	Description
200 OK	PipelineResource	還行。
Other Status Codes	CloudError	從 Azure Data Factory 服務收到的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Pipelines_Create

Pipelines_Update

Pipelines_Create

範例要求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline?api-version=2018-06-01

{
  "properties": {
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      },
      "JobId": {
        "type": "String"
      }
    },
    "variables": {
      "TestVariableArray": {
        "type": "Array"
      }
    },
    "runDimensions": {
      "JobId": {
        "value": "@pipeline().parameters.JobId",
        "type": "Expression"
      }
    },
    "policy": {
      "elapsedTimeMetric": {
        "duration": "0.00:10:00"
      }
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Pipelines_Create.json
// this example is just showing the usage of "Pipelines_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
DataFactoryPipelineData data = new DataFactoryPipelineData
{
    Activities = {new ForEachActivity("ExampleForeachActivity", new DataFactoryExpression(DataFactoryExpressionType.Expression, "@pipeline().parameters.OutputBlobNameList"), new PipelineActivity[]
    {
    new CopyActivity("ExampleCopyActivity", new DataFactoryBlobSource(), new DataFactoryBlobSink())
    {
    Inputs = {new DatasetReference(DatasetReferenceType.DatasetReference, "exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson("examplecontainer.csv"),
    ["MyFolderPath"] = BinaryData.FromObjectAsJson("examplecontainer")
    },
    }},
    Outputs = {new DatasetReference(DatasetReferenceType.DatasetReference, "exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson(new
    {
    type = "Expression",
    value = "@item()",
    }),
    ["MyFolderPath"] = BinaryData.FromObjectAsJson("examplecontainer")
    },
    }},
    DataIntegrationUnits = null,
    }
    })
    {
    IsSequential = true,
    }},
    Parameters =
    {
    ["JobId"] = new EntityParameterSpecification(EntityParameterType.String),
    ["OutputBlobNameList"] = new EntityParameterSpecification(EntityParameterType.Array)
    },
    Variables =
    {
    ["TestVariableArray"] = new PipelineVariableSpecification(PipelineVariableType.Array)
    },
    RunDimensions =
    {
    ["JobId"] = BinaryData.FromObjectAsJson(new
    {
    type = "Expression",
    value = "@pipeline().parameters.JobId",
    })
    },
    ElapsedTimeMetricDuration = BinaryData.FromObjectAsJson("0.00:10:00"),
};
ArmOperation<DataFactoryPipelineResource> lro = await dataFactoryPipeline.UpdateAsync(WaitUntil.Completed, data);
DataFactoryPipelineResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryPipelineData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

Date: Sat, 16 Jun 2018 00:37:41 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
x-ms-correlation-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline",
  "name": "examplePipeline",
  "type": "Microsoft.DataFactory/factories/pipelines",
  "properties": {
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      },
      "JobId": {
        "type": "String"
      }
    },
    "variables": {
      "TestVariableArray": {
        "type": "Array"
      }
    },
    "runDimensions": {
      "JobId": {
        "value": "@pipeline().parameters.JobId",
        "type": "Expression"
      }
    }
  },
  "etag": "0a0069d4-0000-0000-0000-5b245bd50000"
}

Pipelines_Update

範例要求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline?api-version=2018-06-01

{
  "properties": {
    "description": "Example description",
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      }
    },
    "policy": {
      "elapsedTimeMetric": {
        "duration": "0.00:10:00"
      }
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Pipelines_Update.json
// this example is just showing the usage of "Pipelines_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
DataFactoryPipelineData data = new DataFactoryPipelineData
{
    Description = "Example description",
    Activities = {new ForEachActivity("ExampleForeachActivity", new DataFactoryExpression(DataFactoryExpressionType.Expression, "@pipeline().parameters.OutputBlobNameList"), new PipelineActivity[]
    {
    new CopyActivity("ExampleCopyActivity", new DataFactoryBlobSource(), new DataFactoryBlobSink())
    {
    Inputs = {new DatasetReference(DatasetReferenceType.DatasetReference, "exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson("examplecontainer.csv"),
    ["MyFolderPath"] = BinaryData.FromObjectAsJson("examplecontainer")
    },
    }},
    Outputs = {new DatasetReference(DatasetReferenceType.DatasetReference, "exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson(new
    {
    type = "Expression",
    value = "@item()",
    }),
    ["MyFolderPath"] = BinaryData.FromObjectAsJson("examplecontainer")
    },
    }},
    DataIntegrationUnits = null,
    }
    })
    {
    IsSequential = true,
    }},
    Parameters =
    {
    ["OutputBlobNameList"] = new EntityParameterSpecification(EntityParameterType.Array)
    },
    ElapsedTimeMetricDuration = BinaryData.FromObjectAsJson("0.00:10:00"),
};
ArmOperation<DataFactoryPipelineResource> lro = await dataFactoryPipeline.UpdateAsync(WaitUntil.Completed, data);
DataFactoryPipelineResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryPipelineData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

Date: Sat, 16 Jun 2018 00:37:43 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1191
x-ms-request-id: 91a763b0-d944-493f-83fc-e989c8b6e122
x-ms-correlation-request-id: 91a763b0-d944-493f-83fc-e989c8b6e122

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline",
  "name": "examplePipeline",
  "type": "Microsoft.DataFactory/factories/pipelines",
  "properties": {
    "description": "Example description",
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      }
    }
  },
  "etag": "0a006cd4-0000-0000-0000-5b245bd60000"
}

定義

名稱	Description
ActivityDependency	活動相依性資訊。
ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
ActivityPolicy	活動的執行原則。
ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
AppendVariableActivity	Array 類型的變數附加值。
AzureDataExplorerCommandActivity	Azure 資料總管命令活動。
AzureFunctionActivity	Azure 函式活動。
AzureFunctionActivityMethod	AzureFunctionActivity 支援的 HTTP 方法清單。
AzureKeyVaultSecretReference	Azure Key Vault 秘密參考。
AzureMLBatchExecutionActivity	Azure ML 批次執行活動。
AzureMLExecutePipelineActivity	Azure ML 執行管線活動。
AzureMLUpdateResourceActivity	Azure ML 更新資源管理活動。
AzureMLWebServiceFile	Azure ML WebService 輸入/輸出檔案
BigDataPoolParametrizationReference	巨量數據集區參考類型。
BigDataPoolReferenceType	巨量數據集區參考類型。
CloudError	對象，定義 Azure Data Factory 錯誤響應的結構。
Compute	數據流活動的計算屬性。
ConfigurationType	Spark 組態的類型。
ContinuationSettingsReference	執行數據流活動的接續設定。
ControlActivity	所有控件活動的基類，例如 IfCondition、ForEach 、Until。
CopyActivity	複製活動。
CopyActivityLogSettings	複製活動記錄的設定。
CredentialReference	認證參考類型。
CredentialReferenceType	認證參考類型。
CustomActivity	自訂活動類型。
CustomActivityReferenceObject	自訂活動的參考物件
DatabricksJobActivity	Databricks Job 活動。
DatabricksNotebookActivity	DatabricksNotebook 活動。
DatabricksSparkJarActivity	DatabricksSparkJar 活動。
DatabricksSparkPythonActivity	DatabricksSparkPython 活動。
DataFlowReference	數據流參考類型。
DataFlowReferenceType	數據流參考類型。
DataFlowStagingInfo	執行數據流活動的暫存資訊。
DataLakeAnalyticsUSQLActivity	Data Lake Analytics U-SQL 活動。
DatasetReference	數據集參考類型。
DeleteActivity	刪除活動。
DependencyCondition	相依性 Match-Condition。
ExecuteDataFlowActivity	執行數據流活動。
ExecutePipelineActivity	執行管線活動。
ExecutePipelineActivityPolicy	執行管線活動的執行原則。
ExecuteSSISPackageActivity	執行 SSIS 套件活動。
ExecuteWranglingDataflowActivity	執行 power query 活動。
ExecutionActivity	所有執行活動的基類。
Expression	Azure Data Factory 運算式定義。
FailActivity	此活動會在自己的範圍內失敗，並輸出自定義錯誤訊息和錯誤碼。 錯誤訊息和程式代碼可以當做字串常值或可在運行時間評估為字元串的表達式來提供。 如果失敗活動包含在其中，活動範圍可以是整個管線或控件活動（例如 foreach、switch、until）。
FilterActivity	根據條件篩選和傳回輸入陣列的結果。
Folder	此管線位於的資料夾。 如果未指定，管線將會出現在根層級。
ForEachActivity	此活動用於逐一查看集合並執行指定的活動。
GetMetadataActivity	取得數據集元數據的活動
HDInsightActivityDebugInfoOption	要使用的 HDInsightActivityDebugInfoOption 設定。
HDInsightHiveActivity	HDInsight Hive 活動類型。
HDInsightMapReduceActivity	HDInsight MapReduce 活動類型。
HDInsightPigActivity	HDInsight Pig 活動類型。
HDInsightSparkActivity	HDInsight Spark 活動。
HDInsightStreamingActivity	HDInsight 串流活動類型。
IfConditionActivity	此活動會評估布爾表達式，並根據表達式的結果執行 ifTrueActivities 屬性或 ifFalseActivities 屬性下的活動。
IntegrationRuntimeReference	整合運行時間參考類型。
LinkedServiceReference	連結服務參考類型。
LogLocationSettings	記錄位置設定。
LogSettings	記錄設定。
LogStorageSettings	（已被取代。請使用 LogSettings） 記錄記憶體設定。
LookupActivity	查閱活動。
NotebookParameter	Notebook 參數。
NotebookParameterType	Notebook 參數類型。
NotebookReferenceType	Synapse Notebook 參考類型。
ParameterSpecification	實體的單一參數定義。
ParameterType	參數類型。
PipelineElapsedTimeMetricPolicy	Pipeline ElapsedTime 計量原則。
PipelinePolicy	管線原則。
PipelineReference	管線參考類型。
PipelineResource	管線資源類型。
PowerQuerySink	電源查詢接收。
PowerQuerySinkMapping	將 Power Query 混搭查詢對應至接收數據集（s）。
RedirectIncompatibleRowSettings	重新導向不相容的數據列設定
ScriptActivity	文本活動類型。
ScriptActivityLogDestination	記錄的目的地。 類型：字串。
ScriptActivityParameter	腳本區塊的參數。
ScriptActivityParameterDirection	參數的方向。
ScriptActivityParameterType	參數的類型。
ScriptActivityScriptBlock	腳本區塊。
ScriptActivityTypeProperties.LogSettings	腳本活動的記錄設定。
SecureInputOutputPolicy	支援安全輸入和輸出的活動執行原則。
SecureString	Azure Data Factory 安全字串定義。 在取得或清單 API 呼叫期間，字串值會以星號 『*』 遮罩。
SetVariableActivity	設定變數的值。
SkipErrorFile	略過錯誤檔案。
SparkConfigurationParametrizationReference	Spark 組態參考。
SparkConfigurationReferenceType	Spark 組態參考類型。
SparkJobReferenceType	Synapse spark 作業參考類型。
SqlServerStoredProcedureActivity	SQL 預存程式活動類型。
SSISAccessCredential	SSIS 存取認證。
SSISChildPackage	SSIS 內嵌子封裝。
SSISExecutionCredential	SSIS 套件執行認證。
SSISExecutionParameter	SSIS 執行參數。
SSISLogLocation	SSIS 套件執行記錄檔位置
SsisLogLocationType	SSIS 記錄位置的類型。
SSISPackageLocation	SSIS 套件位置。
SsisPackageLocationType	SSIS 套件位置的類型。
SSISPropertyOverride	SSIS 屬性覆寫。
StagingSettings	預備設定。
SwitchActivity	此活動會評估表達式，並在 cases 屬性下執行活動，該屬性對應至 equals 屬性中預期的表達式評估。
SwitchCase	切換具有 值和對應活動的案例。
SynapseNotebookActivity	執行 Synapse 筆記本活動。
SynapseNotebookReference	Synapse Notebook 參考類型。
SynapseSparkJobDefinitionActivity	執行Spark作業活動。
SynapseSparkJobReference	Synapse spark 作業參考類型。
Type	連結服務參考類型。
UntilActivity	此活動會執行內部活動，直到達到指定的布爾表達式結果為 true 或逾時為止，只要稍早。
UserProperty	用戶屬性。
ValidationActivity	此活動會驗證外部資源是否存在。
VariableSpecification	管線的單一變數定義。
VariableType	變數類型。
WaitActivity	此活動會暫停指定間隔的管線執行。
WebActivity	Web 活動。
WebActivityAuthentication	Web 活動驗證屬性。
WebActivityMethod	WebActivity 支援的 HTTP 方法清單。
WebHookActivity	WebHook 活動。
WebHookActivityMethod	WebHook 活動支援的 HTTP 方法清單。

ActivityDependency

Object

活動相依性資訊。

名稱	類型	Description
activity	string	活動名稱。
dependencyConditions	DependencyCondition[]	相依性 Match-Condition。

ActivityOnInactiveMarkAs

列舉型別

當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。

值	Description
Succeeded
Failed
Skipped

ActivityPolicy

Object

活動的執行原則。

名稱	類型	Description
retry	object	一般重試次數上限。 預設值為 0。 類型：integer （或 expression with resultType integer）， minimum： 0。
retryIntervalInSeconds	integer minimum: 30 maximum: 86400	每個重試嘗試之間的間隔（以秒為單位）。 預設值為30秒。
secureInput	boolean	當設定為 true 時，來自活動的輸入會被視為安全，且不會記錄到監視。
secureOutput	boolean	設定為 true 時，活動輸出會視為安全，且不會記錄到監視。
timeout	object	指定要執行之活動的逾時。 默認逾時為 7 天。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).

ActivityState

列舉型別

活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。

值	Description
Active
Inactive

AppendVariableActivity

Object

Array 類型的變數附加值。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AppendVariable	活動類型。
typeProperties.value	object	要附加的值。 類型：可以是變數專案的靜態值比對類型，或是具有變數專案 resultType 比對類型的 Expression
typeProperties.variableName	string	必須附加其值之變數的名稱。
userProperties	UserProperty[]	活動用戶屬性。

AzureDataExplorerCommandActivity

Object

Azure 資料總管命令活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AzureDataExplorerCommand	活動類型。
typeProperties.command	object	控件命令，根據 Azure 數據總管命令語法。 Type：string （或 expression with resultType string） 。
typeProperties.commandTimeout	object	控制命令逾時。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9]))..)
userProperties	UserProperty[]	活動用戶屬性。

AzureFunctionActivity

Object

Azure 函式活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AzureFunctionActivity	活動類型。
typeProperties.body	object	表示將傳送至端點的承載。 POST/PUT 方法的必要專案，GET 方法類型不允許：string （或 expression with resultType 字串串的表達式）。
typeProperties.functionName	object	Azure 函式活動將呼叫的函式名稱。 類型：string （或 expression with resultType string）
typeProperties.headers	object	表示將傳送至要求的標頭。 例如，若要在要求上設定語言和類型：“headers” ： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 Type：string （或 expression with resultType string） 。
typeProperties.method	AzureFunctionActivityMethod	目標端點的 Rest API 方法。
userProperties	UserProperty[]	活動用戶屬性。

AzureFunctionActivityMethod

列舉型別

AzureFunctionActivity 支援的 HTTP 方法清單。

值	Description
GET
POST
PUT
DELETE
OPTIONS
HEAD
TRACE

AzureKeyVaultSecretReference

Object

Azure Key Vault 秘密參考。

名稱	類型	Description
secretName	object	Azure Key Vault 中的秘密名稱。 Type：string （或 expression with resultType string） 。
secretVersion	object	Azure Key Vault 中的秘密版本。 預設值是最新版本的秘密。 Type：string （或 expression with resultType string） 。
store	LinkedServiceReference	Azure Key Vault 鏈接服務參考。
type	string: AzureKeyVaultSecret	秘密的類型。

AzureMLBatchExecutionActivity

Object

Azure ML 批次執行活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AzureMLBatchExecution	活動類型。
typeProperties.globalParameters	object	要傳遞至 Azure ML 批次執行服務端點的索引鍵、值組。 密鑰必須符合已發佈 Azure ML Web 服務中所定義的 Web 服務參數名稱。 值將會在 Azure ML 批次執行要求的 GlobalParameters 屬性中傳遞。
typeProperties.webServiceInputs	<string,  AzureMLWebServiceFile>	索引鍵、值組，將 Azure ML 端點的 Web 服務輸入名稱對應至指定輸入 Blob 位置的 AzureMLWebServiceFile 物件。 這項資訊將會傳遞至 Azure ML 批次執行要求的 WebServiceInputs 屬性。
typeProperties.webServiceOutputs	<string,  AzureMLWebServiceFile>	索引鍵、值組，將 Azure ML 端點的 Web 服務輸出名稱對應至指定輸出 Blob 位置的 AzureMLWebServiceFile 物件。 這項資訊將會傳遞至 Azure ML 批次執行要求的 WebServiceOutputs 屬性。
userProperties	UserProperty[]	活動用戶屬性。

AzureMLExecutePipelineActivity

Object

Azure ML 執行管線活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AzureMLExecutePipeline	活動類型。
typeProperties.continueOnStepFailure	object	如果步驟失敗，是否要繼續執行 PipelineRun 中的其他步驟。 此資訊將會在已發佈管線執行要求的continueOnStepFailure屬性中傳遞。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.dataPathAssignments	object	用於變更數據路徑指派而不進行重新定型的字典。 值將會傳入已發佈管線執行要求的 dataPathAssignments 屬性。 Type：object （或 Expression with resultType 物件）。
typeProperties.experimentName	object	執行管線執行的執行歷程記錄實驗名稱。 此資訊將會傳遞在已發佈管線執行要求的 ExperimentName 屬性中。 Type：string （或 expression with resultType string） 。
typeProperties.mlParentRunId	object	父 Azure ML 服務管線執行標識碼。此資訊將會傳入已發佈管線執行要求的 ParentRunId 屬性。 Type：string （或 expression with resultType string） 。
typeProperties.mlPipelineEndpointId	object	已發佈之 Azure ML 管線端點的標識碼。 Type：string （或 expression with resultType string） 。
typeProperties.mlPipelineId	object	已發佈 Azure ML 管線的標識碼。 Type：string （或 expression with resultType string） 。
typeProperties.mlPipelineParameters	object	要傳遞至已發佈 Azure ML 管線端點的索引鍵、值組。 索引鍵必須符合已發佈管線中定義的管線參數名稱。 值將會在已發佈管線執行要求的ParameterAssignments屬性中傳遞。 類型：具有索引鍵值組的物件（或具有 resultType 物件的 Expression）。
typeProperties.version	object	已發佈的 Azure ML 管線端點版本。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

AzureMLUpdateResourceActivity

Object

Azure ML 更新資源管理活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: AzureMLUpdateResource	活動類型。
typeProperties.trainedModelFilePath	object	trainedModelLinkedService 中的相對檔案路徑，表示更新作業將上傳的 .ilearner 檔案。 Type：string （或 expression with resultType string） 。
typeProperties.trainedModelLinkedServiceName	LinkedServiceReference	保存更新作業所上傳之 .ilearner 檔案的 Azure 記憶體連結服務名稱。
typeProperties.trainedModelName	object	要更新之 Web 服務實驗中定型模型模組的名稱。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

AzureMLWebServiceFile

Object

Azure ML WebService 輸入/輸出檔案

名稱	類型	Description
filePath	object	LinkedService 所指定之 Azure Blob 記憶體中的相對檔案路徑，包括容器名稱。 Type：string （或 expression with resultType string） 。
linkedServiceName	LinkedServiceReference	Azure 記憶體 LinkedService 的參考，其中 Azure ML WebService 輸入/輸出檔案。

BigDataPoolParametrizationReference

Object

巨量數據集區參考類型。

名稱	類型	Description
referenceName	object	參考巨量數據集區名稱。 Type：string （或 expression with resultType string） 。
type	BigDataPoolReferenceType	巨量數據集區參考類型。

BigDataPoolReferenceType

列舉型別

巨量數據集區參考類型。

值	Description
BigDataPoolReference

CloudError

Object

對象，定義 Azure Data Factory 錯誤響應的結構。

名稱	類型	Description
error.code	string	錯誤碼。
error.details	CloudError[]	具有其他錯誤詳細數據的陣列。
error.message	string	錯誤資訊。
error.target	string	與錯誤相關聯之要求中的屬性名稱/路徑。

Compute

Object

數據流活動的計算屬性。

名稱	類型	Description
computeType	object	將執行數據流作業之叢集的計算類型。 可能的值包括：『General』、『MemoryOptimized』、『ComputeOptimized』。 類型：string （或 expression with resultType string）
coreCount	object	將執行數據流作業之叢集的核心計數。 支援的值為：8、16、32、48、80、144 和 272。 類型：integer（或 expression 含 resultType 整數的運算式）

ConfigurationType

列舉型別

Spark 組態的類型。

值	Description
Default
Customized
Artifact

ContinuationSettingsReference

Object

執行數據流活動的接續設定。

名稱	類型	Description
continuationTtlInMinutes	object	接續 TTL 以分鐘為單位。
customizedCheckpointKey	object	自訂的檢查點索引鍵。
idleCondition	object	閑置條件。

ControlActivity

Object

所有控件活動的基類，例如 IfCondition、ForEach 、Until。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Container	活動類型。
userProperties	UserProperty[]	活動用戶屬性。

CopyActivity

Object

複製活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
inputs	DatasetReference[]	活動的輸入清單。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
outputs	DatasetReference[]	活動的輸出清單。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Copy	活動類型。
typeProperties.dataIntegrationUnits	object	可用來執行此數據行動的數據整合單位數目上限。 類型：integer （或 expression with resultType integer）， minimum： 0。
typeProperties.enableSkipIncompatibleRow	object	是否略過不相容的數據列。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.enableStaging	object	指定是否要透過過渡暫存複製數據。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.logSettings	LogSettings	啟用記錄時，客戶需要提供的記錄設定。
typeProperties.logStorageSettings	LogStorageSettings	（已被取代。請使用 LogSettings） 啟用工作階段記錄時，客戶必須提供的記錄記憶體設定。
typeProperties.parallelCopies	object	在來源或接收上開啟的並行會話數目上限，以避免多載數據存放區。 類型：integer （或 expression with resultType integer）， minimum： 0。
typeProperties.preserve	object[]	保留規則。
typeProperties.preserveRules	object[]	保留規則。
typeProperties.redirectIncompatibleRowSettings	RedirectIncompatibleRowSettings	當 EnableSkipIncompatibleRow 為 true 時，重新導向不相容的數據列設定。
typeProperties.sink	CopySink	複製活動接收。
typeProperties.skipErrorFile	SkipErrorFile	指定數據一致性的容錯。
typeProperties.source	CopySource	複製活動來源。
typeProperties.stagingSettings	StagingSettings	指定 EnableStaging 為 true 時的過渡暫存設定。
typeProperties.translator	object	複製活動翻譯工具。 如果未指定，則會使用表格式翻譯工具。
typeProperties.validateDataConsistency	object	是否要啟用數據一致性驗證。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
userProperties	UserProperty[]	活動用戶屬性。

CopyActivityLogSettings

Object

複製活動記錄的設定。

名稱	類型	Description
enableReliableLogging	object	指定是否啟用可靠的記錄。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
logLevel	object	取得或設定記錄層級、支援：資訊、警告。 Type：string （或 expression with resultType string） 。

CredentialReference

Object

認證參考類型。

名稱	類型	Description
referenceName	string	參考認證名稱。
type	CredentialReferenceType	認證參考類型。

CredentialReferenceType

列舉型別

認證參考類型。

值	Description
CredentialReference

CustomActivity

Object

自訂活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Custom	活動類型。
typeProperties.autoUserSpecification	object	使用者的提高許可權層級和範圍，預設值為非系統管理員工作。 Type：string （或 expression with resultType double） 的表達式。
typeProperties.command	object	自定義活動類型的命令：string （或 expression with resultType string）。
typeProperties.extendedProperties	object	使用者定義的屬性包。 對可以使用的索引鍵或值沒有任何限制。 使用者指定的自定義活動完全負責取用和解譯定義的內容。
typeProperties.folderPath	object	資源文件的資料夾路徑 類型：string （或 expression with resultType string）。
typeProperties.referenceObjects	CustomActivityReferenceObject	參考物件
typeProperties.resourceLinkedService	LinkedServiceReference	資源連結服務參考。
typeProperties.retentionTimeInDays	object	針對自訂活動提交的檔案保留時間。 類型：double（或 expressionType double 的運算式）。
userProperties	UserProperty[]	活動用戶屬性。

CustomActivityReferenceObject

Object

自訂活動的參考物件

名稱	類型	Description
datasets	DatasetReference[]	數據集參考。
linkedServices	LinkedServiceReference[]	鏈接的服務參考。

DatabricksJobActivity

Object

Databricks Job 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: DatabricksJob	活動類型。
typeProperties.jobId	object	要執行的 Databricks 作業的 ID。 Type：string （或 expression with resultType string） 。
typeProperties.jobParameters	object	用於此作業的每次運行的作業參數。 如果作業採用未指定的參數，則將使用作業中的預設值。
userProperties	UserProperty[]	活動用戶屬性。

DatabricksNotebookActivity

Object

DatabricksNotebook 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: DatabricksNotebook	活動類型。
typeProperties.baseParameters	object	要用於此作業每個回合的基底參數。如果筆記本採用未指定的參數，則會使用筆記本中的預設值。
typeProperties.libraries	object[]	要安裝在將執行作業之叢集上的連結庫清單。
typeProperties.notebookPath	object	要在 Databricks 工作區中執行的筆記本絕對路徑。 此路徑的開頭必須是斜線。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

DatabricksSparkJarActivity

Object

DatabricksSparkJar 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: DatabricksSparkJar	活動類型。
typeProperties.libraries	object[]	要安裝在將執行作業之叢集上的連結庫清單。
typeProperties.mainClassName	object	類別的完整名稱，其中包含要執行的主要方法。 這個類別必須包含在提供做為連結庫的 JAR 中。 Type：string （或 expression with resultType string） 。
typeProperties.parameters	object[]	將傳遞至 main 方法的參數。
userProperties	UserProperty[]	活動用戶屬性。

DatabricksSparkPythonActivity

Object

DatabricksSparkPython 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: DatabricksSparkPython	活動類型。
typeProperties.libraries	object[]	要安裝在將執行作業之叢集上的連結庫清單。
typeProperties.parameters	object[]	將傳遞至 Python 檔案的命令行參數。
typeProperties.pythonFile	object	要執行的 Python 檔案 URI。 支援 DBFS 路徑。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

DataFlowReference

Object

數據流參考類型。

名稱	類型	Description
datasetParameters	object	從數據集參考數據流參數。
parameters	object	數據流參數
referenceName	string	參考數據流名稱。
type	DataFlowReferenceType	數據流參考類型。

DataFlowReferenceType

列舉型別

數據流參考類型。

值	Description
DataFlowReference

DataFlowStagingInfo

Object

執行數據流活動的暫存資訊。

名稱	類型	Description
folderPath	object	暫存 Blob 的資料夾路徑。 類型：string （或 expression with resultType string）
linkedService	LinkedServiceReference	暫存連結服務參考。

DataLakeAnalyticsUSQLActivity

Object

Data Lake Analytics U-SQL 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: DataLakeAnalyticsU-SQL	活動類型。
typeProperties.compilationMode	object	U-SQL 的編譯模式。 必須是下列其中一個值：Semantic、Full 和SingleBox。 Type：string （或 expression with resultType string） 。
typeProperties.degreeOfParallelism	object	用來執行作業的節點數目上限。 預設值為 1。 類型：integer（或 Expression 含 resultType 整數的運算式），最小值：1。
typeProperties.parameters	object	U-SQL 作業要求的參數。
typeProperties.priority	object	決定應該先選取已排入佇列的所有作業，以執行。 數位越低，優先順序越高。 預設值為 1000。 類型：integer（或 Expression 含 resultType 整數的運算式），最小值：1。
typeProperties.runtimeVersion	object	要使用的U-SQL引擎運行時間版本。 Type：string （或 expression with resultType string） 。
typeProperties.scriptLinkedService	LinkedServiceReference	編寫連結服務參考的腳本。
typeProperties.scriptPath	object	包含U-SQL 文稿之資料夾的區分大小寫路徑。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

DatasetReference

Object

數據集參考類型。

名稱	類型	Description
parameters	object	數據集的自變數。
referenceName	string	參考數據集名稱。
type	enum: DatasetReference	數據集參考類型。

DeleteActivity

Object

刪除活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Delete	活動類型。
typeProperties.dataset	DatasetReference	刪除活動數據集參考。
typeProperties.enableLogging	object	是否要記錄刪除活動執行的詳細記錄。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.logStorageSettings	LogStorageSettings	當 enableLogging 為 true 時，客戶必須提供記錄記憶體設定。
typeProperties.maxConcurrentConnections	integer minimum: 1	同時連接數據源的最大並行連線。
typeProperties.recursive	object	如果為 true，則會以遞歸方式刪除目前資料夾路徑下的檔案或子資料夾。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.storeSettings	StoreReadSettings	刪除活動存放區設定。
userProperties	UserProperty[]	活動用戶屬性。

DependencyCondition

列舉型別

相依性 Match-Condition。

值	Description
Succeeded
Failed
Skipped
Completed

ExecuteDataFlowActivity

Object

執行數據流活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: ExecuteDataFlow	活動類型。
typeProperties.compute	Compute	數據流活動的計算屬性。
typeProperties.continuationSettings	ContinuationSettingsReference	執行數據流活動的接續設定。
typeProperties.continueOnError	object	繼續執行用於數據流執行的錯誤設定。 如果接收失敗，可讓處理繼續。 類型：布爾值（或含 resultType 布爾值的表達式）
typeProperties.dataFlow	DataFlowReference	數據流參考。
typeProperties.integrationRuntime	IntegrationRuntimeReference	整合運行時間參考。
typeProperties.runConcurrently	object	用於數據流執行的並行執行設定。 允許同時處理具有相同儲存順序的接收。 類型：布爾值（或含 resultType 布爾值的表達式）
typeProperties.sourceStagingConcurrency	object	指定適用於接收之來源的平行暫存數目。 類型：integer（或 expression 含 resultType 整數的運算式）
typeProperties.staging	DataFlowStagingInfo	執行數據流活動的暫存資訊。
typeProperties.traceLevel	object	用於數據流監視輸出的追蹤層級設定。 支援的值為：『粗略』、『fine』和 『none』。 類型：string （或 expression with resultType string）
userProperties	UserProperty[]	活動用戶屬性。

ExecutePipelineActivity

Object

執行管線活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ExecutePipelineActivityPolicy	執行管線活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: ExecutePipeline	活動類型。
typeProperties.parameters	object	管線參數。
typeProperties.pipeline	PipelineReference	管線參考。
typeProperties.waitOnCompletion	boolean	定義活動執行是否會等候相依管線執行完成。 默認值為 false。
userProperties	UserProperty[]	活動用戶屬性。

ExecutePipelineActivityPolicy

Object

執行管線活動的執行原則。

名稱	類型	Description
secureInput	boolean	當設定為 true 時，來自活動的輸入會被視為安全，且不會記錄到監視。

ExecuteSSISPackageActivity

Object

執行 SSIS 套件活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: ExecuteSSISPackage	活動類型。
typeProperties.connectVia	IntegrationRuntimeReference	整合運行時間參考。
typeProperties.environmentPath	object	執行 SSIS 封裝的環境路徑。 Type：string （或 expression with resultType string） 。
typeProperties.executionCredential	SSISExecutionCredential	封裝執行認證。
typeProperties.logLocation	SSISLogLocation	SSIS 套件執行記錄檔位置。
typeProperties.loggingLevel	object	SSIS 封裝執行的記錄層級。 Type：string （或 expression with resultType string） 。
typeProperties.packageConnectionManagers	object	要執行 SSIS 封裝的封裝層級連接管理員。
typeProperties.packageLocation	SSISPackageLocation	SSIS 套件位置。
typeProperties.packageParameters	<string,  SSISExecutionParameter>	要執行 SSIS 封裝的封裝層級參數。
typeProperties.projectConnectionManagers	object	要執行 SSIS 封裝的專案層級連接管理員。
typeProperties.projectParameters	<string,  SSISExecutionParameter>	要執行 SSIS 封裝的專案層級參數。
typeProperties.propertyOverrides	<string,  SSISPropertyOverride>	屬性會覆寫以執行 SSIS 封裝。
typeProperties.runtime	object	指定要執行 SSIS 封裝的運行時間。 此值應該是 「x86」 或 「x64」。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

ExecuteWranglingDataflowActivity

Object

執行 power query 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: ExecuteWranglingDataflow	活動類型。
typeProperties.compute	Compute	數據流活動的計算屬性。
typeProperties.continuationSettings	ContinuationSettingsReference	執行數據流活動的接續設定。
typeProperties.continueOnError	object	繼續執行用於數據流執行的錯誤設定。 如果接收失敗，可讓處理繼續。 類型：布爾值（或含 resultType 布爾值的表達式）
typeProperties.dataFlow	DataFlowReference	數據流參考。
typeProperties.integrationRuntime	IntegrationRuntimeReference	整合運行時間參考。
typeProperties.queries	PowerQuerySinkMapping[]	Power Query 混搭查詢對應至接收數據集的清單。
typeProperties.runConcurrently	object	用於數據流執行的並行執行設定。 允許同時處理具有相同儲存順序的接收。 類型：布爾值（或含 resultType 布爾值的表達式）
typeProperties.sinks	<string,  PowerQuerySink>	（已被取代。請使用查詢）。 對應至 queryName 的 Power Query 活動接收清單。
typeProperties.sourceStagingConcurrency	object	指定適用於接收之來源的平行暫存數目。 類型：integer（或 expression 含 resultType 整數的運算式）
typeProperties.staging	DataFlowStagingInfo	執行數據流活動的暫存資訊。
typeProperties.traceLevel	object	用於數據流監視輸出的追蹤層級設定。 支援的值為：『粗略』、『fine』和 『none』。 類型：string （或 expression with resultType string）
userProperties	UserProperty[]	活動用戶屬性。

ExecutionActivity

Object

所有執行活動的基類。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Execution	活動類型。
userProperties	UserProperty[]	活動用戶屬性。

Expression

Object

Azure Data Factory 運算式定義。

名稱	類型	Description
type	enum: Expression	表達式類型。
value	string	表達式值。

FailActivity

Object

此活動會在自己的範圍內失敗，並輸出自定義錯誤訊息和錯誤碼。 錯誤訊息和程式代碼可以當做字串常值或可在運行時間評估為字元串的表達式來提供。 如果失敗活動包含在其中，活動範圍可以是整個管線或控件活動（例如 foreach、switch、until）。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Fail	活動類型。
typeProperties.errorCode	object	錯誤碼，分類失敗活動的錯誤類型。 它可以是運行時間評估為非空白/空白字串的動態內容。 Type：string （或 expression with resultType string） 。
typeProperties.message	object	失敗活動中浮出水面的錯誤訊息。 它可以是運行時間評估為非空白/空白字串的動態內容。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

FilterActivity

Object

根據條件篩選和傳回輸入陣列的結果。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Filter	活動類型。
typeProperties.condition	Expression	用於篩選輸入的條件。
typeProperties.items	Expression	應套用篩選的輸入陣列。
userProperties	UserProperty[]	活動用戶屬性。

Folder

Object

此管線位於的資料夾。 如果未指定，管線將會出現在根層級。

名稱	類型	Description
name	string	此管線位於的資料夾名稱。

ForEachActivity

Object

此活動用於逐一查看集合並執行指定的活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: ForEach	活動類型。
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	要執行的活動清單。
typeProperties.batchCount	integer maximum: 50	用於控制平行執行的批次計數（當 isSequential 設定為 false 時）。
typeProperties.isSequential	boolean	循環應該以序列或平行方式執行 （最大值 50）
typeProperties.items	Expression	要反覆運算的集合。
userProperties	UserProperty[]	活動用戶屬性。

GetMetadataActivity

Object

取得數據集元數據的活動

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: GetMetadata	活動類型。
typeProperties.dataset	DatasetReference	GetMetadata 活動數據集參考。
typeProperties.fieldList	object[]	要從數據集取得的元數據欄位。
typeProperties.formatSettings	FormatReadSettings	GetMetadata 活動格式設定。
typeProperties.storeSettings	StoreReadSettings	GetMetadata 活動存放區設定。
userProperties	UserProperty[]	活動用戶屬性。

HDInsightActivityDebugInfoOption

列舉型別

要使用的 HDInsightActivityDebugInfoOption 設定。

值	Description
None
Always
Failure

HDInsightHiveActivity

Object

HDInsight Hive 活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: HDInsightHive	活動類型。
typeProperties.arguments	object[]	使用者指定的 HDInsightActivity 自變數。
typeProperties.defines	object	允許使用者指定Hive作業要求的定義。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	偵錯資訊選項。
typeProperties.queryTimeout	integer	查詢逾時值 （以分鐘為單位）。 當 HDInsight 叢集使用 ESP 時有效（企業安全性套件）
typeProperties.scriptLinkedService	LinkedServiceReference	編寫連結服務參考的腳本。
typeProperties.scriptPath	object	腳本路徑。 Type：string （或 expression with resultType string） 。
typeProperties.storageLinkedServices	LinkedServiceReference[]	記憶體連結服務參考。
typeProperties.variables	object	hivevar 命名空間下的使用者指定自變數。
userProperties	UserProperty[]	活動用戶屬性。

HDInsightMapReduceActivity

Object

HDInsight MapReduce 活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: HDInsightMapReduce	活動類型。
typeProperties.arguments	object[]	使用者指定的 HDInsightActivity 自變數。
typeProperties.className	object	類別名稱。 Type：string （或 expression with resultType string） 。
typeProperties.defines	object	允許使用者指定 MapReduce 作業要求的定義。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	偵錯資訊選項。
typeProperties.jarFilePath	object	Jar 路徑。 Type：string （或 expression with resultType string） 。
typeProperties.jarLibs	object[]	Jar libs。
typeProperties.jarLinkedService	LinkedServiceReference	Jar 連結服務參考。
typeProperties.storageLinkedServices	LinkedServiceReference[]	記憶體連結服務參考。
userProperties	UserProperty[]	活動用戶屬性。

HDInsightPigActivity

Object

HDInsight Pig 活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: HDInsightPig	活動類型。
typeProperties.arguments	object	使用者指定的 HDInsightActivity 自變數。 類型：array（或 expression with resultType array 的 Expression）。
typeProperties.defines	object	允許使用者指定 Pig 作業要求的定義。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	偵錯資訊選項。
typeProperties.scriptLinkedService	LinkedServiceReference	編寫連結服務參考的腳本。
typeProperties.scriptPath	object	腳本路徑。 Type：string （或 expression with resultType string） 。
typeProperties.storageLinkedServices	LinkedServiceReference[]	記憶體連結服務參考。
userProperties	UserProperty[]	活動用戶屬性。

HDInsightSparkActivity

Object

HDInsight Spark 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: HDInsightSpark	活動類型。
typeProperties.arguments	object[]	HDInsightSparkActivity 的使用者指定自變數。
typeProperties.className	string	應用程式的 Java/Spark 主要類別。
typeProperties.entryFilePath	object	要執行之程式代碼/套件根資料夾的相對路徑。 Type：string （或 expression with resultType string） 。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	偵錯資訊選項。
typeProperties.proxyUser	object	要模擬該作業的使用者。 Type：string （或 expression with resultType string） 。
typeProperties.rootPath	object	所有作業檔案之 'sparkJobLinkedService' 中的根路徑。 Type：string （或 expression with resultType string） 。
typeProperties.sparkConfig	object	Spark 組態屬性。
typeProperties.sparkJobLinkedService	LinkedServiceReference	用於上傳專案檔案和相依性的記憶體連結服務，以及用於接收記錄。
userProperties	UserProperty[]	活動用戶屬性。

HDInsightStreamingActivity

Object

HDInsight 串流活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: HDInsightStreaming	活動類型。
typeProperties.arguments	object[]	使用者指定的 HDInsightActivity 自變數。
typeProperties.combiner	object	合併器可執行檔名稱。 Type：string （或 expression with resultType string） 。
typeProperties.commandEnvironment	object[]	命令行環境值。
typeProperties.defines	object	允許使用者指定串流作業要求的定義。
typeProperties.fileLinkedService	LinkedServiceReference	檔案所在的連結服務參考。
typeProperties.filePaths	object[]	串流作業檔案的路徑。 可以是目錄。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	偵錯資訊選項。
typeProperties.input	object	輸入 Blob 路徑。 Type：string （或 expression with resultType string） 。
typeProperties.mapper	object	Mapper 可執行檔名稱。 Type：string （或 expression with resultType string） 。
typeProperties.output	object	輸出 Blob 路徑。 Type：string （或 expression with resultType string） 。
typeProperties.reducer	object	歸納器可執行檔名稱。 Type：string （或 expression with resultType string） 。
typeProperties.storageLinkedServices	LinkedServiceReference[]	記憶體連結服務參考。
userProperties	UserProperty[]	活動用戶屬性。

IfConditionActivity

Object

此活動會評估布爾表達式，並根據表達式的結果執行 ifTrueActivities 屬性或 ifFalseActivities 屬性下的活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: IfCondition	活動類型。
typeProperties.expression	Expression	評估為布爾值的表達式。 這是用來判斷將執行的活動區塊（ifTrueActivities 或 ifFalseActivities）。
typeProperties.ifFalseActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	如果表達式評估為 false，要執行的活動清單。 這是選擇性屬性，如果未提供，活動將會在沒有任何動作的情況下結束。
typeProperties.ifTrueActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	如果表達式評估為 true，要執行的活動清單。 這是選擇性屬性，如果未提供，活動將會在沒有任何動作的情況下結束。
userProperties	UserProperty[]	活動用戶屬性。

IntegrationRuntimeReference

Object

整合運行時間參考類型。

名稱	類型	Description
parameters	object	整合運行時間的自變數。
referenceName	string	參考整合運行時間名稱。
type	enum: IntegrationRuntimeReference	整合運行時間的類型。

LinkedServiceReference

Object

連結服務參考類型。

名稱	類型	Description
parameters	object	LinkedService 的自變數。
referenceName	string	參考 LinkedService 名稱。
type	Type	連結服務參考類型。

LogLocationSettings

Object

記錄位置設定。

名稱	類型	Description
linkedServiceName	LinkedServiceReference	記錄記憶體連結服務參考。
path	object	用來儲存活動執行詳細記錄的記憶體路徑。 Type：string （或 expression with resultType string） 。

LogSettings

Object

記錄設定。

名稱	類型	Description
copyActivityLogSettings	CopyActivityLogSettings	指定複製活動記錄的設定。
enableCopyActivityLog	object	指定是否啟用複製活動記錄。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
logLocationSettings	LogLocationSettings	客戶在啟用記錄時必須提供的記錄位置設定。

LogStorageSettings

Object

（已被取代。請使用 LogSettings） 記錄記憶體設定。

名稱	類型	Description
enableReliableLogging	object	指定是否啟用可靠的記錄。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
linkedServiceName	LinkedServiceReference	記錄記憶體連結服務參考。
logLevel	object	取得或設定記錄層級、支援：資訊、警告。 Type：string （或 expression with resultType string） 。
path	object	用來儲存活動執行詳細記錄的記憶體路徑。 Type：string （或 expression with resultType string） 。

LookupActivity

Object

查閱活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Lookup	活動類型。
typeProperties.dataset	DatasetReference	查閱活動數據集參考。
typeProperties.firstRowOnly	object	是否要傳回第一個數據列或所有數據列。 默認值為 true。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.source	CopySource	數據集特定的來源屬性，與複製活動來源相同。
typeProperties.treatDecimalAsString	object	指出是否將十進位值視為字串，以避免值溢位問題。 此選項僅適用於 SnowflakeV2 連接器。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
userProperties	UserProperty[]	活動用戶屬性。

NotebookParameter

Object

Notebook 參數。

名稱	類型	Description
type	NotebookParameterType	Notebook 參數類型。
value	object	Notebook 參數值。 Type：string （或 expression with resultType string） 。

NotebookParameterType

列舉型別

Notebook 參數類型。

值	Description
string
int
float
bool

NotebookReferenceType

列舉型別

Synapse Notebook 參考類型。

值	Description
NotebookReference

ParameterSpecification

Object

實體的單一參數定義。

名稱	類型	Description
defaultValue	object	參數的預設值。
type	ParameterType	參數類型。

ParameterType

列舉型別

參數類型。

值	Description
Object
String
Int
Float
Bool
Array
SecureString

PipelineElapsedTimeMetricPolicy

Object

Pipeline ElapsedTime 計量原則。

名稱	類型	Description
duration	object	TimeSpan 值，之後就會引發 Azure 監視計量。

PipelinePolicy

Object

管線原則。

名稱	類型	Description
elapsedTimeMetric	PipelineElapsedTimeMetricPolicy	Pipeline ElapsedTime 計量原則。

PipelineReference

Object

管線參考類型。

名稱	類型	Description
name	string	參考名稱。
referenceName	string	參考管線名稱。
type	enum: PipelineReference	管線參考類型。

PipelineResource

Object

管線資源類型。

名稱	類型	Description
etag	string	Etag 會識別資源中的變更。
id	string	資源標識碼。
name	string	資源名稱。
properties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	管線中的活動清單。
properties.annotations	object[]	可用於描述管線的標記清單。
properties.concurrency	integer minimum: 1	管線的並行執行數目上限。
properties.description	string	管線的描述。
properties.folder	Folder	此管線位於的資料夾。 如果未指定，管線將會出現在根層級。
properties.parameters	<string,  ParameterSpecification>	管線的參數清單。
properties.policy	PipelinePolicy	管線原則。
properties.runDimensions	object	管線發出的維度。
properties.variables	<string,  VariableSpecification>	管線的變數清單。
type	string	資源類型。

PowerQuerySink

Object

電源查詢接收。

名稱	類型	Description
dataset	DatasetReference	數據集參考。
description	string	轉換描述。
flowlet	DataFlowReference	Flowlet 參考
linkedService	LinkedServiceReference	鏈接的服務參考。
name	string	轉換名稱。
rejectedDataLinkedService	LinkedServiceReference	拒絕的數據連結服務參考。
schemaLinkedService	LinkedServiceReference	架構連結服務參考。
script	string	接收腳本。

PowerQuerySinkMapping

Object

將 Power Query 混搭查詢對應至接收數據集（s）。

名稱	類型	Description
dataflowSinks	PowerQuerySink[]	對應至 Power Query 混搭查詢的接收清單。
queryName	string	Power Query 混搭文件中查詢的名稱。

RedirectIncompatibleRowSettings

Object

重新導向不相容的數據列設定

名稱	類型	Description
linkedServiceName	object	用來重新導向不相容數據列的 Azure 記憶體、記憶體 SAS 或 Azure Data Lake Store 連結服務的名稱。 如果指定 redirectIncompatibleRowSettings，則必須指定 。 Type：string （或 expression with resultType string） 。
path	object	用來儲存重新導向不相容數據列數據的路徑。 Type：string （或 expression with resultType string） 。

ScriptActivity

Object

文本活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Script	活動類型。
typeProperties.logSettings	ScriptActivityTypeProperties.LogSettings	腳本活動的記錄設定。
typeProperties.returnMultistatementResult	object	啟用 以從多個 SQL 語句擷取結果集，以及 DML 語句所影響的數據列數目。 支持的連接器：SnowflakeV2。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.scriptBlockExecutionTimeout	object	ScriptBlock 執行逾時。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
typeProperties.scripts	ScriptActivityScriptBlock[]	腳本區塊的陣列。 類型：陣列。
typeProperties.treatDecimalAsString	object	指出是否將十進位值視為字串，以避免值溢位問題。 此選項僅適用於 SnowflakeV2 連接器。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
userProperties	UserProperty[]	活動用戶屬性。

ScriptActivityLogDestination

列舉型別

記錄的目的地。 類型：字串。

值	Description
ActivityOutput
ExternalStore

ScriptActivityParameter

Object

腳本區塊的參數。

名稱	類型	Description
direction	ScriptActivityParameterDirection	參數的方向。
name	object	參數的名稱。 Type：string （或 expression with resultType string） 。
size	integer (int32)	輸出方向參數的大小。
type	ScriptActivityParameterType	參數的類型。
value	object	參數的值。 Type：string （或 expression with resultType string） 。

ScriptActivityParameterDirection

列舉型別

參數的方向。

值	Description
Input
Output
InputOutput

ScriptActivityParameterType

列舉型別

參數的類型。

值	Description
Boolean
DateTime
DateTimeOffset
Decimal
Double
Guid
Int16
Int32
Int64
Single
String
Timespan

ScriptActivityScriptBlock

Object

腳本區塊。

名稱	類型	Description
parameters	ScriptActivityParameter[]	腳本參數的陣列。 類型：陣列。
text	object	查詢文字。 Type：string （或 expression with resultType string） 。
type	object	查詢的類型。 如需有效選項，請參閱 ScriptType。 Type：string （或 expression with resultType string） 。

ScriptActivityTypeProperties.LogSettings

Object

腳本活動的記錄設定。

名稱	類型	Description
logDestination	ScriptActivityLogDestination	記錄的目的地。 類型：字串。
logLocationSettings	LogLocationSettings	客戶在啟用記錄時必須提供的記錄位置設定。

SecureInputOutputPolicy

Object

支援安全輸入和輸出的活動執行原則。

名稱	類型	Description
secureInput	boolean	當設定為 true 時，來自活動的輸入會被視為安全，且不會記錄到監視。
secureOutput	boolean	設定為 true 時，活動輸出會視為安全，且不會記錄到監視。

SecureString

Object

Azure Data Factory 安全字串定義。 在取得或清單 API 呼叫期間，字串值會以星號 『*』 遮罩。

名稱	類型	Description
type	string: SecureString	秘密的類型。
value	string	安全字串的值。

SetVariableActivity

Object

設定變數的值。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	SecureInputOutputPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: SetVariable	活動類型。
typeProperties.setSystemVariable	boolean	如果設定為 true，則會設定管線執行傳回值。
typeProperties.value	object	要設定的值。 可以是靜態值或Expression。
typeProperties.variableName	string	需要設定其值之變數的名稱。
userProperties	UserProperty[]	活動用戶屬性。

SkipErrorFile

Object

略過錯誤檔案。

名稱	類型	Description
dataInconsistency	object	如果來源/接收檔案由其他並行寫入變更，請略過 。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
fileMissing	object	如果在複製期間由其他用戶端刪除檔案，請略過。 默認值為 true。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。

SparkConfigurationParametrizationReference

Object

Spark 組態參考。

名稱	類型	Description
referenceName	object	參考Spark組態名稱。 Type：string （或 expression with resultType string） 。
type	SparkConfigurationReferenceType	Spark 組態參考類型。

SparkConfigurationReferenceType

列舉型別

Spark 組態參考類型。

值	Description
SparkConfigurationReference

SparkJobReferenceType

列舉型別

Synapse spark 作業參考類型。

值	Description
SparkJobDefinitionReference

SqlServerStoredProcedureActivity

Object

SQL 預存程式活動類型。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: SqlServerStoredProcedure	活動類型。
typeProperties.storedProcedureName	object	預存程式名稱。 Type：string （或 expression with resultType string） 。
typeProperties.storedProcedureParameters	object	預存程序參數的值和類型設定。 範例：“{Parameter1： {value： ”1“， type： ”int“}}”。
userProperties	UserProperty[]	活動用戶屬性。

SSISAccessCredential

Object

SSIS 存取認證。

名稱	類型	Description
domain	object	Windows 驗證的網域。 Type：string （或 expression with resultType string） 。
password	SecretBase: AzureKeyVaultSecretReference SecureString	Windows 驗證的密碼。
userName	object	使用Name 進行 Windows 驗證。 Type：string （或 expression with resultType string） 。

SSISChildPackage

Object

SSIS 內嵌子封裝。

名稱	類型	Description
packageContent	object	內嵌子封裝的內容。 Type：string （或 expression with resultType string） 。
packageLastModifiedDate	string	內嵌子封裝的上次修改日期。
packageName	string	內嵌子封裝的名稱。
packagePath	object	內嵌子封裝的路徑。 Type：string （或 expression with resultType string） 。

SSISExecutionCredential

Object

SSIS 套件執行認證。

名稱	類型	Description
domain	object	Windows 驗證的網域。 Type：string （或 expression with resultType string） 。
password	SecureString	Windows 驗證的密碼。
userName	object	使用Name 進行 Windows 驗證。 Type：string （或 expression with resultType string） 。

SSISExecutionParameter

Object

SSIS 執行參數。

名稱	類型	Description
value	object	SSIS 套件執行參數值。 Type：string （或 expression with resultType string） 。

SSISLogLocation

Object

SSIS 套件執行記錄檔位置

名稱	類型	Description
logPath	object	SSIS 套件執行記錄檔路徑。 Type：string （或 expression with resultType string） 。
type	SsisLogLocationType	SSIS 記錄位置的類型。
typeProperties.accessCredential	SSISAccessCredential	封裝執行記錄存取認證。
typeProperties.logRefreshInterval	object	指定要重新整理記錄的間隔。 默認間隔為 5 分鐘。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).

SsisLogLocationType

列舉型別

SSIS 記錄位置的類型。

值	Description
File

SSISPackageLocation

Object

SSIS 套件位置。

名稱	類型	Description
packagePath	object	SSIS 套件路徑。 Type：string （或 expression with resultType string） 。
type	SsisPackageLocationType	SSIS 套件位置的類型。
typeProperties.accessCredential	SSISAccessCredential	套件存取認證。
typeProperties.childPackages	SSISChildPackage[]	內嵌子封裝清單。
typeProperties.configurationAccessCredential	SSISAccessCredential	組態檔存取認證。
typeProperties.configurationPath	object	封裝執行的組態檔。 Type：string （或 expression with resultType string） 。
typeProperties.packageContent	object	內嵌套件內容。 Type：string （或 expression with resultType string） 。
typeProperties.packageLastModifiedDate	string	內嵌套件上次修改日期。
typeProperties.packageName	string	套件名稱。
typeProperties.packagePassword	SecretBase: AzureKeyVaultSecretReference SecureString	封裝的密碼。

SsisPackageLocationType

列舉型別

SSIS 套件位置的類型。

值	Description
SSISDB
File
InlinePackage
PackageStore

SSISPropertyOverride

Object

SSIS 屬性覆寫。

名稱	類型	Description
isSensitive	boolean	SSIS 套件屬性覆寫值是否為敏感數據。 如果值為 true，則會在 SSISDB 中加密值
value	object	SSIS 封裝屬性覆寫值。 Type：string （或 expression with resultType string） 。

StagingSettings

Object

預備設定。

名稱	類型	Description
enableCompression	object	指定是否要在透過過渡暫存複製數據時使用壓縮。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
linkedServiceName	LinkedServiceReference	暫存連結服務參考。
path	object	用來儲存過渡數據之記憶體的路徑。 Type：string （或 expression with resultType string） 。

SwitchActivity

Object

此活動會評估表達式，並在 cases 屬性下執行活動，該屬性對應至 equals 屬性中預期的表達式評估。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Switch	活動類型。
typeProperties.cases	SwitchCase[]	對應至 『on』 屬性值的案例清單。 這是選擇性屬性，如果未提供，活動將會執行 defaultActivities 中提供的活動。
typeProperties.defaultActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	如果未滿足案例條件，要執行的活動清單。 這是選擇性屬性，如果未提供，活動將會在沒有任何動作的情況下結束。
typeProperties.on	Expression	評估為字串或整數的表達式。 這會用來判斷將執行的活動區塊。
userProperties	UserProperty[]	活動用戶屬性。

SwitchCase

Object

切換具有 值和對應活動的案例。

名稱	類型	Description
activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	要針對符合案例條件執行的活動清單。
value	string	符合 『on』 屬性表示式結果的預期值。

SynapseNotebookActivity

Object

執行 Synapse 筆記本活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: SynapseNotebook	活動類型。
typeProperties.conf	object	Spark 組態屬性，這會覆寫您提供的筆記本 'conf'。
typeProperties.configurationType	ConfigurationType	Spark 組態的類型。
typeProperties.driverSize	object	要用於會話指定 Spark 集區中配置之驅動程式的核心和記憶體數目，用於覆寫您提供的筆記本的 'driverCores' 和 'driverMemory'。 Type：string （或 expression with resultType string） 。
typeProperties.executorSize	object	要用於會話指定 Spark 集區中配置之執行程式的核心和記憶體數目，用於覆寫您提供的筆記本的 'executorCores' 和 'executorMemory'。 Type：string （或 expression with resultType string） 。
typeProperties.notebook	SynapseNotebookReference	Synapse 筆記本參考。
typeProperties.numExecutors	object	要針對此工作階段啟動的執行程式數目，這會覆寫您提供的筆記本 'numExecutors'。 類型：integer （或 expression with resultType integer） 。
typeProperties.parameters	<string,  NotebookParameter>	筆記本參數。
typeProperties.sparkConfig	object	Spark 組態屬性。
typeProperties.sparkPool	BigDataPoolParametrizationReference	將用來執行筆記本的巨量數據集區名稱。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	Spark 作業的Spark組態。
userProperties	UserProperty[]	活動用戶屬性。

SynapseNotebookReference

Object

Synapse Notebook 參考類型。

名稱	類型	Description
referenceName	object	參考筆記本名稱。 Type：string （或 expression with resultType string） 。
type	NotebookReferenceType	Synapse Notebook 參考類型。

SynapseSparkJobDefinitionActivity

Object

執行Spark作業活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: SparkJob	活動類型。
typeProperties.args	SynapseSparkJobActivityTypeProperties.Args[]	使用者指定的 SynapseSparkJobDefinitionActivity 自變數。
typeProperties.className	object	主要定義檔案中的完整標識碼或主要類別，其會覆寫您提供的spark作業定義的 『className』。 Type：string （或 expression with resultType string） 。
typeProperties.conf	object	Spark 組態屬性，將會覆寫您提供的 Spark 作業定義的 'conf'。
typeProperties.configurationType	ConfigurationType	Spark 組態的類型。
typeProperties.driverSize	object	要用於指定 Spark 集區中針對作業配置之驅動程式的核心和記憶體數目，將用於覆寫您提供的 Spark 作業定義的 'driverCores' 和 'driverMemory'。 Type：string （或 expression with resultType string） 。
typeProperties.executorSize	object	要用於指定 Spark 集區中針對作業配置之執行程式的核心和記憶體數目，將用於覆寫您提供的 Spark 作業定義的 'executorCores' 和 'executorMemory'。 Type：string （或 expression with resultType string） 。
typeProperties.file	object	用於作業的主要檔案，這會覆寫您提供的Spark作業定義的 『file』。 Type：string （或 expression with resultType string） 。
typeProperties.files	object[]	（已被取代。請使用 pythonCodeReference 和 filesV2） 主要定義檔中用於參考的其他檔案，這會覆寫您提供的 Spark 作業定義的 'files'。
typeProperties.filesV2	object[]	用於主要定義檔案中參考的其他檔案，這會覆寫您提供的Spark作業定義的 'jars' 和 'files'。
typeProperties.numExecutors	object	要針對此作業啟動的執行程式數目，這會覆寫您提供的Spark作業定義的 'numExecutors'。 類型：integer （或 expression with resultType integer） 。
typeProperties.pythonCodeReference	object[]	用於主要定義檔中參考的其他 Python 程式代碼檔案，這會覆寫您提供的 Spark 作業定義的 'pyFiles'。
typeProperties.scanFolder	object	從主要定義檔案的根資料夾掃描子資料夾，這些檔案將會新增為參考檔案。 系統會掃描名為 『jars』、'pyFiles'、'files' 或 'archive' 的資料夾，而且資料夾名稱會區分大小寫。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.sparkConfig	object	Spark 組態屬性。
typeProperties.sparkJob	SynapseSparkJobReference	Synapse spark 作業參考。
typeProperties.targetBigDataPool	BigDataPoolParametrizationReference	巨量數據集區的名稱，將用來執行 Spark 批次作業，這會覆寫您提供的 Spark 作業定義的 'targetBigDataPool'。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	Spark 作業的Spark組態。
userProperties	UserProperty[]	活動用戶屬性。

SynapseSparkJobReference

Object

Synapse spark 作業參考類型。

名稱	類型	Description
referenceName	object	參考 Spark 作業名稱。 具有 resultType 字串的運算式。
type	SparkJobReferenceType	Synapse spark 作業參考類型。

Type

列舉型別

連結服務參考類型。

值	Description
LinkedServiceReference

UntilActivity

Object

此活動會執行內部活動，直到達到指定的布爾表達式結果為 true 或逾時為止，只要稍早。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Until	活動類型。
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksJobActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	要執行的活動清單。
typeProperties.expression	Expression	評估為布爾值的表達式。 迴圈會繼續執行，直到此表達式評估為 true 為止
typeProperties.timeout	object	指定要執行之活動的逾時。 如果沒有指定任何值，則會使用預設為 1 周的 TimeSpan.FromDays（7） 值。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
userProperties	UserProperty[]	活動用戶屬性。

UserProperty

Object

用戶屬性。

名稱	類型	Description
name	string	用戶屬性名稱。
value	object	用戶屬性值。 Type：string （或 expression with resultType string） 。

ValidationActivity

Object

此活動會驗證外部資源是否存在。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Validation	活動類型。
typeProperties.childItems	object	如果數據集指向資料夾，可以使用。 如果設定為 true，資料夾必須至少有一個檔案。 如果設定為 false，資料夾必須是空的。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.dataset	DatasetReference	驗證活動數據集參考。
typeProperties.minimumSize	object	如果數據集指向檔案，可以使用。 檔案的大小必須大於或等於指定的值。 類型：integer （或 expression with resultType integer） 。
typeProperties.sleep	object	驗證嘗試之間的延遲以秒為單位。 如果未指定任何值，則會使用10秒做為預設值。 類型：integer （或 expression with resultType integer） 。
typeProperties.timeout	object	指定要執行之活動的逾時。 如果沒有指定任何值，則會使用預設為 1 周的 TimeSpan.FromDays（7） 值。 類型：string （或 expression with resultType string）， pattern： （\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
userProperties	UserProperty[]	活動用戶屬性。

VariableSpecification

Object

管線的單一變數定義。

名稱	類型	Description
defaultValue	object	變數的預設值。
type	VariableType	變數類型。

VariableType

列舉型別

變數類型。

值	Description
String
Bool
Array

WaitActivity

Object

此活動會暫停指定間隔的管線執行。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: Wait	活動類型。
typeProperties.waitTimeInSeconds	object	持續時間以秒為單位。 類型：integer （或 expression with resultType integer） 。
userProperties	UserProperty[]	活動用戶屬性。

WebActivity

Object

Web 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
linkedServiceName	LinkedServiceReference	鏈接的服務參考。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	ActivityPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: WebActivity	活動類型。
typeProperties.authentication	WebActivityAuthentication	用於呼叫端點的驗證方法。
typeProperties.body	object	表示將傳送至端點的承載。 POST/PUT 方法的必要專案，GET 方法類型不允許：string （或 expression with resultType 字串串的表達式）。
typeProperties.connectVia	IntegrationRuntimeReference	整合運行時間參考。
typeProperties.datasets	DatasetReference[]	傳遞至 Web 端點的數據集清單。
typeProperties.disableCertValidation	boolean	設定為 true 時，將會停用憑證驗證。
typeProperties.headers	object	表示將傳送至要求的標頭。 例如，若要在要求上設定語言和類型：“headers” ： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 Type：string （或 expression with resultType string） 。
typeProperties.httpRequestTimeout	object	HTTP 要求取得回應的逾時。 格式為 TimeSpan （hh：mm：ss）。 此值是取得回應的逾時，而不是活動逾時。 默認值為 00：01：00 （1 分鐘）。 範圍從 1 到 10 分鐘
typeProperties.linkedServices	LinkedServiceReference[]	傳遞至 Web 端點的連結服務清單。
typeProperties.method	WebActivityMethod	目標端點的 Rest API 方法。
typeProperties.turnOffAsync	boolean	在 HTTP 202 回應的響應標頭中指定的位置停用叫用 HTTP GET 的選項。 如果設定為 true，它會停止在響應標頭中指定的 HTTP 位置上叫用 HTTP GET。 如果設定 false，則會繼續在 HTTP 回應標頭中指定的位置上叫用 HTTP GET 呼叫。
typeProperties.url	object	Web 活動目標端點和路徑。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

WebActivityAuthentication

Object

Web 活動驗證屬性。

名稱	類型	Description
credential	CredentialReference	包含驗證資訊的認證參考。
password	SecretBase: AzureKeyVaultSecretReference SecureString	PFX 檔案的密碼或基本身份驗證/密碼用於 ServicePrincipal 時
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	用於 ServicePrincipal 時，PFX 檔案或憑證的 Base64 編碼內容
resource	object	使用 MSI 驗證時，將會要求 Azure 驗證令牌的資源。 Type：string （或 expression with resultType string） 。
type	string	Web 活動驗證 （Basic/ClientCertificate/MSI/ServicePrincipal）
userTenant	object	使用 ServicePrincipal Authentication 時，將會要求 Azure 驗證令牌的 TenantId。 Type：string （或 expression with resultType string） 。
username	object	用於 ServicePrincipal 時，基本身份驗證或 ClientID 的 Web 活動驗證用戶名稱。 Type：string （或 expression with resultType string） 。

WebActivityMethod

列舉型別

WebActivity 支援的 HTTP 方法清單。

值	Description
GET
POST
PUT
DELETE

WebHookActivity

Object

WebHook 活動。

名稱	類型	Description
dependsOn	ActivityDependency[]	活動取決於條件。
description	string	活動描述。
name	string	活動名稱。
onInactiveMarkAs	ActivityOnInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
policy	SecureInputOutputPolicy	活動原則。
state	ActivityState	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
type	string: WebHook	活動類型。
typeProperties.authentication	WebActivityAuthentication	用於呼叫端點的驗證方法。
typeProperties.body	object	表示將傳送至端點的承載。 POST/PUT 方法的必要專案，GET 方法類型不允許：string （或 expression with resultType 字串串的表達式）。
typeProperties.headers	object	表示將傳送至要求的標頭。 例如，若要在要求上設定語言和類型：“headers” ： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 Type：string （或 expression with resultType string） 。
typeProperties.method	WebHookActivityMethod	目標端點的 Rest API 方法。
typeProperties.reportStatusOnCallBack	object	當設定為 true 時，活動會取用回呼要求本文中的 statusCode、輸出和錯誤。 您可以在回呼要求中設定 statusCode >= 400，將活動標示為失敗。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
typeProperties.timeout	string	應該在其中呼叫 Webhook 的逾時。 如果沒有指定任何值，則預設為10分鐘。 類型：字串。 模式：（\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
typeProperties.url	object	WebHook 活動目標端點和路徑。 Type：string （或 expression with resultType string） 。
userProperties	UserProperty[]	活動用戶屬性。

WebHookActivityMethod

列舉型別

WebHook 活動支援的 HTTP 方法清單。

值	Description
POST