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

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 参数

名称	在	必需	类型	说明
factoryName	path	True	string	工厂名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
pipelineName	path	True	string	管道名称。正则表达式模式: `^[A-Za-z0-9_][^<>#.%&:\\+?/]$`
resourceGroupName	path	True	string	资源组名称。正则表达式模式: `^[-\w\._]+$`
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 版本。

请求头

名称	必需	类型	说明
If-Match		string	管道实体的 ETag。应仅指定用于更新，应将其与现有实体匹配，也可以为 * 进行无条件更新。

请求正文

名称	类型	说明
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[] AzureFunctionActivity[] ExecuteDataFlowActivity[] ScriptActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] ExecutePipelineActivity[] IfConditionActivity[] SwitchActivity[] ForEachActivity[] WaitActivity[] FailActivity[] UntilActivity[] ValidationActivity[] FilterActivity[] SetVariableActivity[] AppendVariableActivity[] WebHookActivity[]	管道中的活动列表。
properties.annotations	object[]	可用于描述管道的标记列表。
properties.concurrency	integer	管道的最大并发运行数。
properties.description	string	管道的说明。
properties.folder	Folder	此管道所在的文件夹。如果未指定，管道将显示在根级别。
properties.parameters	<string, ParameterSpecification>	管道的参数列表。
properties.policy	PipelinePolicy	管道策略。
properties.runDimensions	object	管道发出的维度。
properties.variables	<string, VariableSpecification>	管道的变量列表。

响应

名称	类型	说明
200 OK	PipelineResource	还行。
Other Status Codes	CloudError	从 Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Pipelines_Create

Pipelines_Update

Pipelines_Create

示例请求

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"
      }
    }
  }
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.datafactory.models.BlobSink;
import com.azure.resourcemanager.datafactory.models.BlobSource;
import com.azure.resourcemanager.datafactory.models.CopyActivity;
import com.azure.resourcemanager.datafactory.models.DatasetReference;
import com.azure.resourcemanager.datafactory.models.Expression;
import com.azure.resourcemanager.datafactory.models.ForEachActivity;
import com.azure.resourcemanager.datafactory.models.ParameterSpecification;
import com.azure.resourcemanager.datafactory.models.ParameterType;
import com.azure.resourcemanager.datafactory.models.PipelineElapsedTimeMetricPolicy;
import com.azure.resourcemanager.datafactory.models.PipelinePolicy;
import com.azure.resourcemanager.datafactory.models.VariableSpecification;
import com.azure.resourcemanager.datafactory.models.VariableType;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Pipelines CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json
     */
    /**
     * Sample code: Pipelines_Create.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void pipelinesCreate(com.azure.resourcemanager.datafactory.DataFactoryManager manager)
        throws IOException {
        manager.pipelines().define("examplePipeline").withExistingFactory("exampleResourceGroup", "exampleFactoryName")
            .withActivities(Arrays.asList(new ForEachActivity().withName("ExampleForeachActivity")
                .withIsSequential(true)
                .withItems(new Expression().withValue("@pipeline().parameters.OutputBlobNameList"))
                .withActivities(Arrays.asList(new CopyActivity().withName("ExampleCopyActivity")
                    .withInputs(Arrays.asList(new DatasetReference().withReferenceName("exampleDataset").withParameters(
                        mapOf("MyFileName", "examplecontainer.csv", "MyFolderPath", "examplecontainer"))))
                    .withOutputs(Arrays.asList(new DatasetReference().withReferenceName("exampleDataset")
                        .withParameters(mapOf("MyFileName",
                            SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                                "{\"type\":\"Expression\",\"value\":\"@item()\"}", Object.class,
                                SerializerEncoding.JSON),
                            "MyFolderPath", "examplecontainer"))))
                    .withSource(new BlobSource()).withSink(new BlobSink()).withDataIntegrationUnits(32)))))
            .withParameters(mapOf("JobId", new ParameterSpecification().withType(ParameterType.STRING),
                "OutputBlobNameList", new ParameterSpecification().withType(ParameterType.ARRAY)))
            .withVariables(mapOf("TestVariableArray", new VariableSpecification().withType(VariableType.ARRAY)))
            .withRunDimensions(mapOf("JobId",
                SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                    "{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.JobId\"}", Object.class,
                    SerializerEncoding.JSON)))
            .withPolicy(new PipelinePolicy()
                .withElapsedTimeMetric(new PipelineElapsedTimeMetricPolicy().withDuration("0.00:10:00")))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python pipelines_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.pipelines.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        pipeline_name="examplePipeline",
        pipeline={
            "properties": {
                "activities": [
                    {
                        "name": "ExampleForeachActivity",
                        "type": "ForEach",
                        "typeProperties": {
                            "activities": [
                                {
                                    "inputs": [
                                        {
                                            "parameters": {
                                                "MyFileName": "examplecontainer.csv",
                                                "MyFolderPath": "examplecontainer",
                                            },
                                            "referenceName": "exampleDataset",
                                            "type": "DatasetReference",
                                        }
                                    ],
                                    "name": "ExampleCopyActivity",
                                    "outputs": [
                                        {
                                            "parameters": {
                                                "MyFileName": {"type": "Expression", "value": "@item()"},
                                                "MyFolderPath": "examplecontainer",
                                            },
                                            "referenceName": "exampleDataset",
                                            "type": "DatasetReference",
                                        }
                                    ],
                                    "type": "Copy",
                                    "typeProperties": {
                                        "dataIntegrationUnits": 32,
                                        "sink": {"type": "BlobSink"},
                                        "source": {"type": "BlobSource"},
                                    },
                                }
                            ],
                            "isSequential": True,
                            "items": {"type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList"},
                        },
                    }
                ],
                "parameters": {"JobId": {"type": "String"}, "OutputBlobNameList": {"type": "Array"}},
                "policy": {"elapsedTimeMetric": {"duration": "0.00:10:00"}},
                "runDimensions": {"JobId": {"type": "Expression", "value": "@pipeline().parameters.JobId"}},
                "variables": {"TestVariableArray": {"type": "Array"}},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json
if __name__ == "__main__":
    main()

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

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json
func ExamplePipelinesClient_CreateOrUpdate_pipelinesCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPipelinesClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "examplePipeline", armdatafactory.PipelineResource{
		Properties: &armdatafactory.Pipeline{
			Activities: []armdatafactory.ActivityClassification{
				&armdatafactory.ForEachActivity{
					Name: to.Ptr("ExampleForeachActivity"),
					Type: to.Ptr("ForEach"),
					TypeProperties: &armdatafactory.ForEachActivityTypeProperties{
						Activities: []armdatafactory.ActivityClassification{
							&armdatafactory.CopyActivity{
								Name: to.Ptr("ExampleCopyActivity"),
								Type: to.Ptr("Copy"),
								Inputs: []*armdatafactory.DatasetReference{
									{
										Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
										Parameters: map[string]any{
											"MyFileName":   "examplecontainer.csv",
											"MyFolderPath": "examplecontainer",
										},
										ReferenceName: to.Ptr("exampleDataset"),
									}},
								Outputs: []*armdatafactory.DatasetReference{
									{
										Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
										Parameters: map[string]any{
											"MyFileName": map[string]any{
												"type":  "Expression",
												"value": "@item()",
											},
											"MyFolderPath": "examplecontainer",
										},
										ReferenceName: to.Ptr("exampleDataset"),
									}},
								TypeProperties: &armdatafactory.CopyActivityTypeProperties{
									DataIntegrationUnits: float64(32),
									Sink: &armdatafactory.BlobSink{
										Type: to.Ptr("BlobSink"),
									},
									Source: &armdatafactory.BlobSource{
										Type: to.Ptr("BlobSource"),
									},
								},
							}},
						IsSequential: to.Ptr(true),
						Items: &armdatafactory.Expression{
							Type:  to.Ptr(armdatafactory.ExpressionTypeExpression),
							Value: to.Ptr("@pipeline().parameters.OutputBlobNameList"),
						},
					},
				}},
			Parameters: map[string]*armdatafactory.ParameterSpecification{
				"JobId": {
					Type: to.Ptr(armdatafactory.ParameterTypeString),
				},
				"OutputBlobNameList": {
					Type: to.Ptr(armdatafactory.ParameterTypeArray),
				},
			},
			Policy: &armdatafactory.PipelinePolicy{
				ElapsedTimeMetric: &armdatafactory.PipelineElapsedTimeMetricPolicy{
					Duration: "0.00:10:00",
				},
			},
			RunDimensions: map[string]any{
				"JobId": map[string]any{
					"type":  "Expression",
					"value": "@pipeline().parameters.JobId",
				},
			},
			Variables: map[string]*armdatafactory.VariableSpecification{
				"TestVariableArray": {
					Type: to.Ptr(armdatafactory.VariableTypeArray),
				},
			},
		},
	}, &armdatafactory.PipelinesClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PipelineResource = armdatafactory.PipelineResource{
	// 	Name: to.Ptr("examplePipeline"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/pipelines"),
	// 	Etag: to.Ptr("0a0069d4-0000-0000-0000-5b245bd50000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline"),
	// 	Properties: &armdatafactory.Pipeline{
	// 		Activities: []armdatafactory.ActivityClassification{
	// 			&armdatafactory.ForEachActivity{
	// 				Name: to.Ptr("ExampleForeachActivity"),
	// 				Type: to.Ptr("ForEach"),
	// 				TypeProperties: &armdatafactory.ForEachActivityTypeProperties{
	// 					Activities: []armdatafactory.ActivityClassification{
	// 						&armdatafactory.CopyActivity{
	// 							Name: to.Ptr("ExampleCopyActivity"),
	// 							Type: to.Ptr("Copy"),
	// 							Inputs: []*armdatafactory.DatasetReference{
	// 								{
	// 									Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 									Parameters: map[string]any{
	// 										"MyFileName": "examplecontainer.csv",
	// 										"MyFolderPath": "examplecontainer",
	// 									},
	// 									ReferenceName: to.Ptr("exampleDataset"),
	// 							}},
	// 							Outputs: []*armdatafactory.DatasetReference{
	// 								{
	// 									Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 									Parameters: map[string]any{
	// 										"MyFileName": map[string]any{
	// 											"type": "Expression",
	// 											"value": "@item()",
	// 										},
	// 										"MyFolderPath": "examplecontainer",
	// 									},
	// 									ReferenceName: to.Ptr("exampleDataset"),
	// 							}},
	// 							TypeProperties: &armdatafactory.CopyActivityTypeProperties{
	// 								DataIntegrationUnits: float64(32),
	// 								Sink: &armdatafactory.BlobSink{
	// 									Type: to.Ptr("BlobSink"),
	// 								},
	// 								Source: &armdatafactory.BlobSource{
	// 									Type: to.Ptr("BlobSource"),
	// 								},
	// 							},
	// 					}},
	// 					IsSequential: to.Ptr(true),
	// 					Items: &armdatafactory.Expression{
	// 						Type: to.Ptr(armdatafactory.ExpressionTypeExpression),
	// 						Value: to.Ptr("@pipeline().parameters.OutputBlobNameList"),
	// 					},
	// 				},
	// 		}},
	// 		Parameters: map[string]*armdatafactory.ParameterSpecification{
	// 			"JobId": &armdatafactory.ParameterSpecification{
	// 				Type: to.Ptr(armdatafactory.ParameterTypeString),
	// 			},
	// 			"OutputBlobNameList": &armdatafactory.ParameterSpecification{
	// 				Type: to.Ptr(armdatafactory.ParameterTypeArray),
	// 			},
	// 		},
	// 		RunDimensions: map[string]any{
	// 			"JobId": map[string]any{
	// 				"type": "Expression",
	// 				"value": "@pipeline().parameters.JobId",
	// 			},
	// 		},
	// 		Variables: map[string]*armdatafactory.VariableSpecification{
	// 			"TestVariableArray": &armdatafactory.VariableSpecification{
	// 				Type: to.Ptr(armdatafactory.VariableTypeArray),
	// 			},
	// 		},
	// 	},
	// }
}

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

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a pipeline.
 *
 * @summary Creates or updates a pipeline.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json
 */
async function pipelinesCreate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const pipelineName = "examplePipeline";
  const pipeline = {
    activities: [
      {
        name: "ExampleForeachActivity",
        type: "ForEach",
        activities: [
          {
            name: "ExampleCopyActivity",
            type: "Copy",
            dataIntegrationUnits: 32,
            inputs: [
              {
                type: "DatasetReference",
                parameters: {
                  myFileName: "examplecontainer.csv",
                  myFolderPath: "examplecontainer",
                },
                referenceName: "exampleDataset",
              },
            ],
            outputs: [
              {
                type: "DatasetReference",
                parameters: {
                  myFileName: { type: "Expression", value: "@item()" },
                  myFolderPath: "examplecontainer",
                },
                referenceName: "exampleDataset",
              },
            ],
            sink: { type: "BlobSink" },
            source: { type: "BlobSource" },
          },
        ],
        isSequential: true,
        items: {
          type: "Expression",
          value: "@pipeline().parameters.OutputBlobNameList",
        },
      },
    ],
    parameters: {
      jobId: { type: "String" },
      outputBlobNameList: { type: "Array" },
    },
    policy: { elapsedTimeMetric: { duration: "0.00:10:00" } },
    runDimensions: {
      jobId: { type: "Expression", value: "@pipeline().parameters.JobId" },
    },
    variables: { testVariableArray: { type: "Array" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.pipelines.createOrUpdate(
    resourceGroupName,
    factoryName,
    pipelineName,
    pipeline,
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.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 DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// get the collection of this DataFactoryPipelineResource
DataFactoryPipelineCollection collection = dataFactory.GetDataFactoryPipelines();

// invoke the operation
string pipelineName = "examplePipeline";
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.FromString("\"examplecontainer.csv\""),
    ["MyFolderPath"] = BinaryData.FromString("\"examplecontainer\""),
    },
    }
    },
    Outputs =
    {
    new DatasetReference(DatasetReferenceType.DatasetReference,"exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["type"] = "Expression",
    ["value"] = "@item()"}),
    ["MyFolderPath"] = BinaryData.FromString("\"examplecontainer\""),
    },
    }
    },
    DataIntegrationUnits = 32,
    }
    })
    {
    IsSequential = true,
    }
    },
    Parameters =
    {
    ["JobId"] = new EntityParameterSpecification(EntityParameterType.String),
    ["OutputBlobNameList"] = new EntityParameterSpecification(EntityParameterType.Array),
    },
    Variables =
    {
    ["TestVariableArray"] = new PipelineVariableSpecification(PipelineVariableType.Array),
    },
    RunDimensions =
    {
    ["JobId"] = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["type"] = "Expression",
    ["value"] = "@pipeline().parameters.JobId"}),
    },
    ElapsedTimeMetricDuration = BinaryData.FromString("\"0.00:10:00\""),
};
ArmOperation<DataFactoryPipelineResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, pipelineName, 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

示例请求

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"
      }
    }
  }
}


import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import com.azure.resourcemanager.datafactory.models.BlobSink;
import com.azure.resourcemanager.datafactory.models.BlobSource;
import com.azure.resourcemanager.datafactory.models.CopyActivity;
import com.azure.resourcemanager.datafactory.models.DatasetReference;
import com.azure.resourcemanager.datafactory.models.Expression;
import com.azure.resourcemanager.datafactory.models.ForEachActivity;
import com.azure.resourcemanager.datafactory.models.ParameterSpecification;
import com.azure.resourcemanager.datafactory.models.ParameterType;
import com.azure.resourcemanager.datafactory.models.PipelineElapsedTimeMetricPolicy;
import com.azure.resourcemanager.datafactory.models.PipelinePolicy;
import com.azure.resourcemanager.datafactory.models.PipelineResource;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Pipelines CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json
     */
    /**
     * Sample code: Pipelines_Update.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void pipelinesUpdate(com.azure.resourcemanager.datafactory.DataFactoryManager manager)
        throws IOException {
        PipelineResource resource = manager.pipelines().getWithResponse("exampleResourceGroup", "exampleFactoryName",
            "examplePipeline", null, com.azure.core.util.Context.NONE).getValue();
        resource.update().withDescription("Example description").withActivities(Arrays.asList(new ForEachActivity()
            .withName("ExampleForeachActivity").withIsSequential(true)
            .withItems(new Expression().withValue("@pipeline().parameters.OutputBlobNameList"))
            .withActivities(Arrays.asList(new CopyActivity().withName("ExampleCopyActivity")
                .withInputs(Arrays.asList(new DatasetReference().withReferenceName("exampleDataset")
                    .withParameters(mapOf("MyFileName", "examplecontainer.csv", "MyFolderPath", "examplecontainer"))))
                .withOutputs(Arrays.asList(new DatasetReference().withReferenceName("exampleDataset")
                    .withParameters(mapOf("MyFileName",
                        SerializerFactory.createDefaultManagementSerializerAdapter().deserialize(
                            "{\"type\":\"Expression\",\"value\":\"@item()\"}", Object.class, SerializerEncoding.JSON),
                        "MyFolderPath", "examplecontainer"))))
                .withSource(new BlobSource()).withSink(new BlobSink()).withDataIntegrationUnits(32)))))
            .withParameters(mapOf("OutputBlobNameList", new ParameterSpecification().withType(ParameterType.ARRAY)))
            .withPolicy(new PipelinePolicy()
                .withElapsedTimeMetric(new PipelineElapsedTimeMetricPolicy().withDuration("0.00:10:00")))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python pipelines_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.pipelines.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        pipeline_name="examplePipeline",
        pipeline={
            "properties": {
                "activities": [
                    {
                        "name": "ExampleForeachActivity",
                        "type": "ForEach",
                        "typeProperties": {
                            "activities": [
                                {
                                    "inputs": [
                                        {
                                            "parameters": {
                                                "MyFileName": "examplecontainer.csv",
                                                "MyFolderPath": "examplecontainer",
                                            },
                                            "referenceName": "exampleDataset",
                                            "type": "DatasetReference",
                                        }
                                    ],
                                    "name": "ExampleCopyActivity",
                                    "outputs": [
                                        {
                                            "parameters": {
                                                "MyFileName": {"type": "Expression", "value": "@item()"},
                                                "MyFolderPath": "examplecontainer",
                                            },
                                            "referenceName": "exampleDataset",
                                            "type": "DatasetReference",
                                        }
                                    ],
                                    "type": "Copy",
                                    "typeProperties": {
                                        "dataIntegrationUnits": 32,
                                        "sink": {"type": "BlobSink"},
                                        "source": {"type": "BlobSource"},
                                    },
                                }
                            ],
                            "isSequential": True,
                            "items": {"type": "Expression", "value": "@pipeline().parameters.OutputBlobNameList"},
                        },
                    }
                ],
                "description": "Example description",
                "parameters": {"OutputBlobNameList": {"type": "Array"}},
                "policy": {"elapsedTimeMetric": {"duration": "0.00:10:00"}},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json
if __name__ == "__main__":
    main()

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

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json
func ExamplePipelinesClient_CreateOrUpdate_pipelinesUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPipelinesClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "examplePipeline", armdatafactory.PipelineResource{
		Properties: &armdatafactory.Pipeline{
			Description: to.Ptr("Example description"),
			Activities: []armdatafactory.ActivityClassification{
				&armdatafactory.ForEachActivity{
					Name: to.Ptr("ExampleForeachActivity"),
					Type: to.Ptr("ForEach"),
					TypeProperties: &armdatafactory.ForEachActivityTypeProperties{
						Activities: []armdatafactory.ActivityClassification{
							&armdatafactory.CopyActivity{
								Name: to.Ptr("ExampleCopyActivity"),
								Type: to.Ptr("Copy"),
								Inputs: []*armdatafactory.DatasetReference{
									{
										Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
										Parameters: map[string]any{
											"MyFileName":   "examplecontainer.csv",
											"MyFolderPath": "examplecontainer",
										},
										ReferenceName: to.Ptr("exampleDataset"),
									}},
								Outputs: []*armdatafactory.DatasetReference{
									{
										Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
										Parameters: map[string]any{
											"MyFileName": map[string]any{
												"type":  "Expression",
												"value": "@item()",
											},
											"MyFolderPath": "examplecontainer",
										},
										ReferenceName: to.Ptr("exampleDataset"),
									}},
								TypeProperties: &armdatafactory.CopyActivityTypeProperties{
									DataIntegrationUnits: float64(32),
									Sink: &armdatafactory.BlobSink{
										Type: to.Ptr("BlobSink"),
									},
									Source: &armdatafactory.BlobSource{
										Type: to.Ptr("BlobSource"),
									},
								},
							}},
						IsSequential: to.Ptr(true),
						Items: &armdatafactory.Expression{
							Type:  to.Ptr(armdatafactory.ExpressionTypeExpression),
							Value: to.Ptr("@pipeline().parameters.OutputBlobNameList"),
						},
					},
				}},
			Parameters: map[string]*armdatafactory.ParameterSpecification{
				"OutputBlobNameList": {
					Type: to.Ptr(armdatafactory.ParameterTypeArray),
				},
			},
			Policy: &armdatafactory.PipelinePolicy{
				ElapsedTimeMetric: &armdatafactory.PipelineElapsedTimeMetricPolicy{
					Duration: "0.00:10:00",
				},
			},
		},
	}, &armdatafactory.PipelinesClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PipelineResource = armdatafactory.PipelineResource{
	// 	Name: to.Ptr("examplePipeline"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/pipelines"),
	// 	Etag: to.Ptr("0a006cd4-0000-0000-0000-5b245bd60000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline"),
	// 	Properties: &armdatafactory.Pipeline{
	// 		Description: to.Ptr("Example description"),
	// 		Activities: []armdatafactory.ActivityClassification{
	// 			&armdatafactory.ForEachActivity{
	// 				Name: to.Ptr("ExampleForeachActivity"),
	// 				Type: to.Ptr("ForEach"),
	// 				TypeProperties: &armdatafactory.ForEachActivityTypeProperties{
	// 					Activities: []armdatafactory.ActivityClassification{
	// 						&armdatafactory.CopyActivity{
	// 							Name: to.Ptr("ExampleCopyActivity"),
	// 							Type: to.Ptr("Copy"),
	// 							Inputs: []*armdatafactory.DatasetReference{
	// 								{
	// 									Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 									Parameters: map[string]any{
	// 										"MyFileName": "examplecontainer.csv",
	// 										"MyFolderPath": "examplecontainer",
	// 									},
	// 									ReferenceName: to.Ptr("exampleDataset"),
	// 							}},
	// 							Outputs: []*armdatafactory.DatasetReference{
	// 								{
	// 									Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 									Parameters: map[string]any{
	// 										"MyFileName": map[string]any{
	// 											"type": "Expression",
	// 											"value": "@item()",
	// 										},
	// 										"MyFolderPath": "examplecontainer",
	// 									},
	// 									ReferenceName: to.Ptr("exampleDataset"),
	// 							}},
	// 							TypeProperties: &armdatafactory.CopyActivityTypeProperties{
	// 								DataIntegrationUnits: float64(32),
	// 								Sink: &armdatafactory.BlobSink{
	// 									Type: to.Ptr("BlobSink"),
	// 								},
	// 								Source: &armdatafactory.BlobSource{
	// 									Type: to.Ptr("BlobSource"),
	// 								},
	// 							},
	// 					}},
	// 					IsSequential: to.Ptr(true),
	// 					Items: &armdatafactory.Expression{
	// 						Type: to.Ptr(armdatafactory.ExpressionTypeExpression),
	// 						Value: to.Ptr("@pipeline().parameters.OutputBlobNameList"),
	// 					},
	// 				},
	// 		}},
	// 		Parameters: map[string]*armdatafactory.ParameterSpecification{
	// 			"OutputBlobNameList": &armdatafactory.ParameterSpecification{
	// 				Type: to.Ptr(armdatafactory.ParameterTypeArray),
	// 			},
	// 		},
	// 	},
	// }
}

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

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a pipeline.
 *
 * @summary Creates or updates a pipeline.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json
 */
async function pipelinesUpdate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const pipelineName = "examplePipeline";
  const pipeline = {
    description: "Example description",
    activities: [
      {
        name: "ExampleForeachActivity",
        type: "ForEach",
        activities: [
          {
            name: "ExampleCopyActivity",
            type: "Copy",
            dataIntegrationUnits: 32,
            inputs: [
              {
                type: "DatasetReference",
                parameters: {
                  myFileName: "examplecontainer.csv",
                  myFolderPath: "examplecontainer",
                },
                referenceName: "exampleDataset",
              },
            ],
            outputs: [
              {
                type: "DatasetReference",
                parameters: {
                  myFileName: { type: "Expression", value: "@item()" },
                  myFolderPath: "examplecontainer",
                },
                referenceName: "exampleDataset",
              },
            ],
            sink: { type: "BlobSink" },
            source: { type: "BlobSource" },
          },
        ],
        isSequential: true,
        items: {
          type: "Expression",
          value: "@pipeline().parameters.OutputBlobNameList",
        },
      },
    ],
    parameters: { outputBlobNameList: { type: "Array" } },
    policy: { elapsedTimeMetric: { duration: "0.00:10:00" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.pipelines.createOrUpdate(
    resourceGroupName,
    factoryName,
    pipelineName,
    pipeline,
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.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 DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// get the collection of this DataFactoryPipelineResource
DataFactoryPipelineCollection collection = dataFactory.GetDataFactoryPipelines();

// invoke the operation
string pipelineName = "examplePipeline";
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.FromString("\"examplecontainer.csv\""),
    ["MyFolderPath"] = BinaryData.FromString("\"examplecontainer\""),
    },
    }
    },
    Outputs =
    {
    new DatasetReference(DatasetReferenceType.DatasetReference,"exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["type"] = "Expression",
    ["value"] = "@item()"}),
    ["MyFolderPath"] = BinaryData.FromString("\"examplecontainer\""),
    },
    }
    },
    DataIntegrationUnits = 32,
    }
    })
    {
    IsSequential = true,
    }
    },
    Parameters =
    {
    ["OutputBlobNameList"] = new EntityParameterSpecification(EntityParameterType.Array),
    },
    ElapsedTimeMetricDuration = BinaryData.FromString("\"0.00:10:00\""),
};
ArmOperation<DataFactoryPipelineResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, pipelineName, 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"
}

定义

名称	说明
ActivityDependency	活动依赖项信息。
ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
ActivityPolicy	活动的执行策略。
ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
AppendVariableActivity	数组类型的变量的追加值。
AzureDataExplorerCommandActivity	Azure 数据资源管理器命令活动。
AzureFunctionActivity	Azure Function 活动。
AzureFunctionActivityMethod	AzureFunctionActivity 支持的 HTTP 方法列表。
AzureKeyVaultSecretReference	Azure Key Vault 机密参考。
AzureMLBatchExecutionActivity	Azure ML Batch 执行活动。
AzureMLExecutePipelineActivity	Azure ML 执行管道活动。
AzureMLUpdateResourceActivity	Azure ML 更新资源管理活动。
AzureMLWebServiceFile	Azure ML WebService 输入/输出文件
BigDataPoolParametrizationReference	大数据池引用类型。
BigDataPoolReferenceType	大数据池引用类型。
CloudError	定义 Azure 数据工厂错误响应结构的对象。
Compute	数据流活动的计算属性。
ConfigurationType	spark 配置的类型。
ContinuationSettingsReference	执行数据流活动的延续设置。
ControlActivity	所有控件活动的基类，如 IfCondition、ForEach、Until。
CopyActivity	复制活动。
CopyActivityLogSettings	复制活动日志的设置。
CredentialReference	凭据引用类型。
CredentialReferenceType	凭据引用类型。
CustomActivity	自定义活动类型。
CustomActivityReferenceObject	自定义活动的引用对象
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	执行电源查询活动。
ExecutionActivity	所有执行活动的基类。
Expression	Azure 数据工厂表达式定义。
FailActivity	此活动将在其自己的范围内失败，并输出自定义错误消息和错误代码。错误消息和代码可以作为字符串文本提供，也可以作为可在运行时计算为字符串的表达式提供。活动范围可以是整个管道或控制活动（例如 foreach，开关，直到），如果失败活动包含在其中。
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	笔记本参数类型。
NotebookReferenceType	Synapse 笔记本引用类型。
ParameterSpecification	为实体定义单个参数。
ParameterType	参数类型。
PipelineElapsedTimeMetricPolicy	管道运行时间指标策略。
PipelinePolicy	管道策略。
PipelineReference	管道引用类型。
PipelineResource	管道资源类型。
PowerQuerySink	Power Query 接收器。
PowerQuerySinkMapping	将 Power Query 混合查询映射到接收器数据集（s）。
RedirectIncompatibleRowSettings	重定向不兼容行设置
ScriptActivity	脚本活动类型。
ScriptActivityLogDestination	日志的目标。类型：字符串。
ScriptActivityParameter	脚本块的参数。
ScriptActivityParameterDirection	参数的方向。
ScriptActivityParameterType	参数的类型。
ScriptActivityScriptBlock	脚本块。
ScriptActivityTypeProperties.LogSettings	脚本活动的日志设置。
SecureInputOutputPolicy	支持安全输入和输出的活动的执行策略。
SecureString	Azure 数据工厂安全字符串定义。在获取或列出 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	此活动计算表达式，并在与 equals 属性中预期的表达式计算对应的 cases 属性下执行活动。
SwitchCase	切换具有值和相应活动的事例。
SynapseNotebookActivity	执行 Synapse 笔记本活动。
SynapseNotebookReference	Synapse 笔记本引用类型。
SynapseSparkJobDefinitionActivity	执行 spark 作业活动。
SynapseSparkJobReference	Synapse spark 作业引用类型。
Type	链接服务引用类型。
UntilActivity	此活动执行内部活动，直到达到指定的布尔表达式结果为 true 或超时，以较早者为准。
UserProperty	User 属性。
ValidationActivity	此活动验证外部资源是否存在。
VariableSpecification	管道的单个变量的定义。
VariableType	变量类型。
WaitActivity	此活动挂起指定间隔的管道执行。
WebActivity	Web 活动。
WebActivityAuthentication	Web 活动身份验证属性。
WebActivityMethod	WebActivity 支持的 HTTP 方法列表。
WebHookActivity	WebHook 活动。
WebHookActivityMethod	WebHook 活动支持的 HTTP 方法列表。

ActivityDependency

活动依赖项信息。

名称	类型	说明
activity	string	活动名称。
dependencyConditions	DependencyCondition[]	Match-Condition 依赖项。

ActivityOnInactiveMarkAs

当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。

名称	类型	说明
Failed	string
Skipped	string
Succeeded	string

ActivityPolicy

活动的执行策略。

名称	类型	说明
retry	object	最大普通重试尝试次数。默认值为 0。类型：整数（或包含 resultType 整数的表达式），最小值：0。
retryIntervalInSeconds	integer	每次重试尝试（以秒为单位）之间的间隔。默认值为 30 秒。
secureInput	boolean	设置为 true 时，活动输入被视为安全，不会记录到监视中。
secureOutput	boolean	设置为 true 时，活动输出被视为安全，不会记录到监视中。
timeout	object	指定要运行的活动的超时值。默认超时为 7 天。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).

ActivityState

活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。

名称	类型	说明
Active	string
Inactive	string

AppendVariableActivity

数组类型的变量的追加值。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AppendVariable	活动类型。
typeProperties.value	object	要追加的值。类型：可以是变量项的静态值匹配类型，也可以是具有变量项的 resultType 匹配类型的表达式
typeProperties.variableName	string	需要追加其值的变量的名称。
userProperties	UserProperty[]	活动用户属性。

AzureDataExplorerCommandActivity

Azure 数据资源管理器命令活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AzureDataExplorerCommand	活动类型。
typeProperties.command	object	控件命令，根据 Azure 数据资源管理器命令语法。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.commandTimeout	object	控制命令超时。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9]))..)
userProperties	UserProperty[]	活动用户属性。

AzureFunctionActivity

Azure Function 活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AzureFunctionActivity	活动类型。
typeProperties.body	object	表示将发送到终结点的有效负载。 POST/PUT 方法是必需的，不允许 GET 方法类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.functionName	object	Azure 函数活动将调用的函数的名称。类型：字符串（或带有 resultType 字符串的表达式）
typeProperties.headers	object	表示将发送到请求的标头。例如，若要在请求上设置语言和类型：“headers”： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.method	AzureFunctionActivityMethod	目标终结点的 Rest API 方法。
userProperties	UserProperty[]	活动用户属性。

AzureFunctionActivityMethod

AzureFunctionActivity 支持的 HTTP 方法列表。

名称	类型	说明
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

AzureKeyVaultSecretReference

Azure Key Vault 机密参考。

名称	类型	说明
secretName	object	Azure Key Vault 中机密的名称。类型：字符串（或带有 resultType 字符串的表达式）。
secretVersion	object	Azure Key Vault 中的机密版本。默认值为最新版本的机密。类型：字符串（或带有 resultType 字符串的表达式）。
store	LinkedServiceReference	Azure Key Vault 链接服务参考。
type	string: AzureKeyVaultSecret	机密的类型。

AzureMLBatchExecutionActivity

Azure ML Batch 执行活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AzureMLBatchExecution	活动类型。
typeProperties.globalParameters	object	要传递给 Azure ML Batch 执行服务终结点的键、值对。密钥必须与已发布的 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

Azure ML 执行管道活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AzureMLExecutePipeline	活动类型。
typeProperties.continueOnStepFailure	object	如果步骤失败，是否继续执行 PipelineRun 中的其他步骤。此信息将传入已发布管道执行请求的 continueOnStepFailure 属性中。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.dataPathAssignments	object	用于在不重新训练的情况下更改数据路径分配的字典。将在已发布管道执行请求的 dataPathAssignments 属性中传递值。类型：对象（或带有 resultType 对象的表达式）。
typeProperties.experimentName	object	管道运行的运行历史记录试验名称。此信息将传入已发布管道执行请求的 ExperimentName 属性。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.mlParentRunId	object	父 Azure ML 服务管道运行 ID。此信息将传入已发布管道执行请求的 ParentRunId 属性。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.mlPipelineEndpointId	object	已发布的 Azure ML 管道终结点的 ID。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.mlPipelineId	object	已发布的 Azure ML 管道的 ID。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.mlPipelineParameters	object	要传递给已发布的 Azure ML 管道终结点的键、值对。键必须与已发布管道中定义的管道参数的名称匹配。将在已发布管道执行请求的 ParameterAssignments 属性中传递值。类型：具有键值对的对象（或带有 resultType 对象的表达式）。
typeProperties.version	object	已发布的 Azure ML 管道终结点的版本。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

AzureMLUpdateResourceActivity

Azure ML 更新资源管理活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: AzureMLUpdateResource	活动类型。
typeProperties.trainedModelFilePath	object	trainedModelLinkedService 中的相对文件路径，表示将由更新操作上传的 .ilearner 文件。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.trainedModelLinkedServiceName	LinkedServiceReference	保存由更新操作上传的 .ilearner 文件的 Azure 存储链接服务的名称。
typeProperties.trainedModelName	object	要更新的 Web 服务试验中训练的模型模块的名称。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

AzureMLWebServiceFile

Azure ML WebService 输入/输出文件

名称	类型	说明
filePath	object	LinkedService 指定的 Azure Blob 存储中的相对文件路径，包括容器名称。类型：字符串（或带有 resultType 字符串的表达式）。
linkedServiceName	LinkedServiceReference	对 Azure 存储 LinkedService 的引用，其中 Azure ML WebService 输入/输出文件位于其中。

BigDataPoolParametrizationReference

大数据池引用类型。

名称	类型	说明
referenceName	object	引用大数据池名称。类型：字符串（或带有 resultType 字符串的表达式）。
type	BigDataPoolReferenceType	大数据池引用类型。

BigDataPoolReferenceType

大数据池引用类型。

名称	类型	说明
BigDataPoolReference	string

CloudError

定义 Azure 数据工厂错误响应结构的对象。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudError[]	包含其他错误详细信息的数组。
error.message	string	错误信息。
error.target	string	与错误关联的请求中的属性名称/路径。

Compute

数据流活动的计算属性。

名称	类型	说明
computeType	object	将执行数据流作业的群集的计算类型。可能的值包括：“General”、“MemoryOptimized”、“ComputeOptimized”。类型：字符串（或带有 resultType 字符串的表达式）
coreCount	object	将执行数据流作业的群集的核心计数。支持的值为：8、16、32、48、80、144 和 272。类型：整数（或包含 resultType 整数的表达式）

ConfigurationType

spark 配置的类型。

名称	类型	说明
Artifact	string
Customized	string
Default	string

ContinuationSettingsReference

执行数据流活动的延续设置。

名称	类型	说明
continuationTtlInMinutes	object	以分钟为单位的延续 TTL。
customizedCheckpointKey	object	自定义的检查点键。
idleCondition	object	空闲条件。

ControlActivity

所有控件活动的基类，如 IfCondition、ForEach、Until。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Container	活动类型。
userProperties	UserProperty[]	活动用户属性。

CopyActivity

复制活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
inputs	DatasetReference[]	活动的输入列表。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
outputs	DatasetReference[]	活动的输出列表。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Copy	活动类型。
typeProperties.dataIntegrationUnits	object	可用于执行此数据移动的数据集成单元的最大数量。类型：整数（或包含 resultType 整数的表达式），最小值：0。
typeProperties.enableSkipIncompatibleRow	object	是否跳过不兼容行。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.enableStaging	object	指定是否通过临时暂存复制数据。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.logSettings	LogSettings	启用日志时，客户需要提供的日志设置。
typeProperties.logStorageSettings	LogStorageSettings	（已弃用。请使用 LogSettings）启用会话日志时客户需要提供的日志存储设置。
typeProperties.parallelCopies	object	在源或接收器上打开的最大并发会话数，以避免重载数据存储。类型：整数（或包含 resultType 整数的表达式），最小值：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	是否启用数据一致性验证。类型：布尔值（或带有 resultType 布尔值的表达式）。
userProperties	UserProperty[]	活动用户属性。

CopyActivityLogSettings

复制活动日志的设置。

名称	类型	说明
enableReliableLogging	object	指定是否启用可靠的日志记录。类型：布尔值（或带有 resultType 布尔值的表达式）。
logLevel	object	获取或设置日志级别，支持：信息、警告。类型：字符串（或带有 resultType 字符串的表达式）。

CredentialReference

凭据引用类型。

名称	类型	说明
referenceName	string	引用凭据名称。
type	CredentialReferenceType	凭据引用类型。

CredentialReferenceType

凭据引用类型。

名称	类型	说明
CredentialReference	string

CustomActivity

自定义活动类型。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Custom	活动类型。
typeProperties.autoUserSpecification	object	用户的提升级别和范围，默认值为非admin 任务。类型：字符串（或带有 resultType double 的表达式）。
typeProperties.command	object	自定义活动类型的命令：字符串（或带有 resultType 字符串的表达式）。
typeProperties.extendedProperties	object	用户定义的属性包。对可以使用的键或值没有限制。用户指定的自定义活动完全负责使用和解释定义的内容。
typeProperties.folderPath	object	资源文件类型的文件夹路径：字符串（或带有 resultType 字符串的表达式）。
typeProperties.referenceObjects	CustomActivityReferenceObject	引用对象
typeProperties.resourceLinkedService	LinkedServiceReference	资源链接服务引用。
typeProperties.retentionTimeInDays	object	为自定义活动提交的文件的保留时间。类型：double（或带有 resultType double 的表达式）。
userProperties	UserProperty[]	活动用户属性。

CustomActivityReferenceObject

自定义活动的引用对象

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

DatabricksNotebookActivity

DatabricksNotebook 活动。

名称	类型	说明
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 工作区中运行的笔记本的绝对路径。此路径必须以斜杠开头。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

DatabricksSparkJarActivity

DatabricksSparkJar 活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: DatabricksSparkJar	活动类型。
typeProperties.libraries	object[]	要安装在将执行作业的群集上的库列表。
typeProperties.mainClassName	object	包含要执行的 main 方法的类的完整名称。此类必须包含在作为库提供的 JAR 中。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.parameters	object[]	将传递给主方法的参数。
userProperties	UserProperty[]	活动用户属性。

DatabricksSparkPythonActivity

DatabricksSparkPython 活动。

名称	类型	说明
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 路径。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

DataFlowReference

数据流引用类型。

名称	类型	说明
datasetParameters	object	从数据集引用数据流参数。
parameters	object	数据流参数
referenceName	string	引用数据流名称。
type	DataFlowReferenceType	数据流引用类型。

DataFlowReferenceType

数据流引用类型。

名称	类型	说明
DataFlowReference	string

DataFlowStagingInfo

用于执行数据流活动的暂存信息。

名称	类型	说明
folderPath	object	暂存 Blob 的文件夹路径。类型：字符串（或带有 resultType 字符串的表达式）
linkedService	LinkedServiceReference	暂存链接服务引用。

DataLakeAnalyticsUSQLActivity

Data Lake Analytics U-SQL 活动。

名称	类型	说明
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。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.degreeOfParallelism	object	用于运行作业的最大节点数。默认值为 1。类型：integer（或 Expression with resultType integer），最小值：1。
typeProperties.parameters	object	U-SQL 作业请求的参数。
typeProperties.priority	object	确定应选择已排队的所有作业中的哪些作业以先运行。数字越低，优先级越高。默认值为 1000。类型：integer（或 Expression with resultType integer），最小值：1。
typeProperties.runtimeVersion	object	要使用的 U-SQL 引擎的运行时版本。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.scriptLinkedService	LinkedServiceReference	编写链接服务引用脚本。
typeProperties.scriptPath	object	包含 U-SQL 脚本的文件夹的区分大小写的路径。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

DatasetReference

数据集引用类型。

名称	类型	说明
parameters	object	数据集的参数。
referenceName	string	引用数据集名称。
type	enum: DatasetReference	数据集引用类型。

DeleteActivity

删除活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Delete	活动类型。
typeProperties.dataset	DatasetReference	删除活动数据集引用。
typeProperties.enableLogging	object	是否记录删除活动执行的详细日志。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.logStorageSettings	LogStorageSettings	当 enableLogging 为 true 时，客户需要提供的日志存储设置。
typeProperties.maxConcurrentConnections	integer	同时连接数据源的最大并发连接数。
typeProperties.recursive	object	如果为 true，则以递归方式删除当前文件夹路径下的文件或子文件夹。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.storeSettings	StoreReadSettings	删除活动存储设置。
userProperties	UserProperty[]	活动用户属性。

DependencyCondition

Match-Condition 依赖项。

名称	类型	说明
Completed	string
Failed	string
Skipped	string
Succeeded	string

ExecuteDataFlowActivity

执行数据流活动。

名称	类型	说明
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	为适用于接收器的源指定并行暂存数。类型：整数（或包含 resultType 整数的表达式）
typeProperties.staging	DataFlowStagingInfo	用于执行数据流活动的暂存信息。
typeProperties.traceLevel	object	用于数据流监视输出的跟踪级别设置。支持的值包括：“粗”、“精细”和“none”。类型：字符串（或带有 resultType 字符串的表达式）
userProperties	UserProperty[]	活动用户属性。

ExecutePipelineActivity

执行管道活动。

名称	类型	说明
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

执行管道活动的执行策略。

名称	类型	说明
secureInput	boolean	设置为 true 时，活动输入被视为安全，不会记录到监视中。

ExecuteSSISPackageActivity

执行 SSIS 包活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: ExecuteSSISPackage	活动类型。
typeProperties.connectVia	IntegrationRuntimeReference	集成运行时参考。
typeProperties.environmentPath	object	执行 SSIS 包的环境路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.executionCredential	SSISExecutionCredential	包执行凭据。
typeProperties.logLocation	SSISLogLocation	SSIS 包执行日志位置。
typeProperties.loggingLevel	object	SSIS 包执行的日志记录级别。类型：字符串（或带有 resultType 字符串的表达式）。
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”。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

ExecuteWranglingDataflowActivity

执行电源查询活动。

名称	类型	说明
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	为适用于接收器的源指定并行暂存数。类型：整数（或包含 resultType 整数的表达式）
typeProperties.staging	DataFlowStagingInfo	用于执行数据流活动的暂存信息。
typeProperties.traceLevel	object	用于数据流监视输出的跟踪级别设置。支持的值包括：“粗”、“精细”和“none”。类型：字符串（或带有 resultType 字符串的表达式）
userProperties	UserProperty[]	活动用户属性。

ExecutionActivity

所有执行活动的基类。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Execution	活动类型。
userProperties	UserProperty[]	活动用户属性。

Expression

Azure 数据工厂表达式定义。

名称	类型	说明
type	enum: Expression	表达式类型。
value	string	表达式值。

FailActivity

此活动将在其自己的范围内失败，并输出自定义错误消息和错误代码。错误消息和代码可以作为字符串文本提供，也可以作为可在运行时计算为字符串的表达式提供。活动范围可以是整个管道或控制活动（例如 foreach，开关，直到），如果失败活动包含在其中。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Fail	活动类型。
typeProperties.errorCode	object	对 Fail 活动的错误类型进行分类的错误代码。它可以是运行时计算为非空/空字符串的动态内容。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.message	object	失败活动中显示的错误消息。它可以是运行时计算为非空/空字符串的动态内容。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

FilterActivity

根据条件筛选和返回输入数组的结果。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Filter	活动类型。
typeProperties.condition	Expression	用于筛选输入的条件。
typeProperties.items	Expression	应对其应用筛选器的输入数组。
userProperties	UserProperty[]	活动用户属性。

Folder

此管道所在的文件夹。如果未指定，管道将显示在根级别。

名称	类型	说明
name	string	此管道所在的文件夹的名称。

ForEachActivity

此活动用于循环访问集合和执行给定的活动。

名称	类型	说明
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[] 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	用于控制并行执行的批计数（isSequential 设置为 false 时）。
typeProperties.isSequential	boolean	循环应按顺序或并行执行（最大 50）
typeProperties.items	Expression	要循环访问的集合。
userProperties	UserProperty[]	活动用户属性。

GetMetadataActivity

获取数据集元数据的活动

名称	类型	说明
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 设置。

名称	类型	说明
Always	string
Failure	string
None	string

HDInsightHiveActivity

HDInsight Hive 活动类型。

名称	类型	说明
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	脚本路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.storageLinkedServices	LinkedServiceReference[]	存储链接服务引用。
typeProperties.variables	object	hivevar 命名空间下的用户指定参数。
userProperties	UserProperty[]	活动用户属性。

HDInsightMapReduceActivity

HDInsight MapReduce 活动类型。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: HDInsightMapReduce	活动类型。
typeProperties.arguments	object[]	用户指定的 HDInsightActivity 参数。
typeProperties.className	object	类名。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.defines	object	允许用户为 MapReduce 作业请求指定定义。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	调试信息选项。
typeProperties.jarFilePath	object	Jar 路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.jarLibs	object[]	Jar 库
typeProperties.jarLinkedService	LinkedServiceReference	Jar 链接服务参考。
typeProperties.storageLinkedServices	LinkedServiceReference[]	存储链接服务引用。
userProperties	UserProperty[]	活动用户属性。

HDInsightPigActivity

HDInsight Pig 活动类型。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: HDInsightPig	活动类型。
typeProperties.arguments	object	用户指定的 HDInsightActivity 参数。类型：数组（或带有 resultType 数组的表达式）。
typeProperties.defines	object	允许用户指定 Pig 作业请求的定义。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	调试信息选项。
typeProperties.scriptLinkedService	LinkedServiceReference	编写链接服务引用脚本。
typeProperties.scriptPath	object	脚本路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.storageLinkedServices	LinkedServiceReference[]	存储链接服务引用。
userProperties	UserProperty[]	活动用户属性。

HDInsightSparkActivity

HDInsight Spark 活动。

名称	类型	说明
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	要执行的代码/包的根文件夹的相对路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	调试信息选项。
typeProperties.proxyUser	object	要模拟该作业的用户。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.rootPath	object	所有作业文件的“sparkJobLinkedService”中的根路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.sparkConfig	object	Spark 配置属性。
typeProperties.sparkJobLinkedService	LinkedServiceReference	用于上传条目文件和依赖项以及接收日志的存储链接服务。
userProperties	UserProperty[]	活动用户属性。

HDInsightStreamingActivity

HDInsight 流式处理活动类型。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: HDInsightStreaming	活动类型。
typeProperties.arguments	object[]	用户指定的 HDInsightActivity 参数。
typeProperties.combiner	object	合并器可执行文件名称。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.commandEnvironment	object[]	命令行环境值。
typeProperties.defines	object	允许用户指定流式处理作业请求的定义。
typeProperties.fileLinkedService	LinkedServiceReference	文件所在的链接服务引用。
typeProperties.filePaths	object[]	流式处理作业文件的路径。可以是目录。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	调试信息选项。
typeProperties.input	object	输入 Blob 路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.mapper	object	映射程序可执行文件名称。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.output	object	输出 blob 路径。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.reducer	object	化简器可执行文件名称。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.storageLinkedServices	LinkedServiceReference[]	存储链接服务引用。
userProperties	UserProperty[]	活动用户属性。

IfConditionActivity

此活动计算布尔表达式，并根据表达式的结果执行 ifTrueActivities 属性或 ifFalseActivities 属性下的活动。

名称	类型	说明
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[] 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[] 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

集成运行时引用类型。

名称	类型	说明
parameters	object	集成运行时的参数。
referenceName	string	引用集成运行时名称。
type	enum: IntegrationRuntimeReference	集成运行时的类型。

LinkedServiceReference

链接服务引用类型。

名称	类型	说明
parameters	object	LinkedService 的参数。
referenceName	string	引用 LinkedService 名称。
type	Type	链接服务引用类型。

LogLocationSettings

日志位置设置。

名称	类型	说明
linkedServiceName	LinkedServiceReference	日志存储链接服务参考。
path	object	用于存储活动执行的详细日志的存储路径。类型：字符串（或带有 resultType 字符串的表达式）。

LogSettings

日志设置。

名称	类型	说明
copyActivityLogSettings	CopyActivityLogSettings	指定复制活动日志的设置。
enableCopyActivityLog	object	指定是否启用复制活动日志。类型：布尔值（或带有 resultType 布尔值的表达式）。
logLocationSettings	LogLocationSettings	启用日志时，客户需要提供的日志位置设置。

LogStorageSettings

（已弃用。请使用 LogSettings）日志存储设置。

名称	类型	说明
enableReliableLogging	object	指定是否启用可靠的日志记录。类型：布尔值（或带有 resultType 布尔值的表达式）。
linkedServiceName	LinkedServiceReference	日志存储链接服务参考。
logLevel	object	获取或设置日志级别，支持：信息、警告。类型：字符串（或带有 resultType 字符串的表达式）。
path	object	用于存储活动执行的详细日志的存储路径。类型：字符串（或带有 resultType 字符串的表达式）。

LookupActivity

查找活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Lookup	活动类型。
typeProperties.dataset	DatasetReference	查找活动数据集引用。
typeProperties.firstRowOnly	object	是返回第一行还是所有行。默认值为 true。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.source	CopySource	特定于数据集的源属性，与复制活动源相同。
userProperties	UserProperty[]	活动用户属性。

NotebookParameter

Notebook 参数。

名称	类型	说明
type	NotebookParameterType	笔记本参数类型。
value	object	笔记本参数值。类型：字符串（或带有 resultType 字符串的表达式）。

NotebookParameterType

笔记本参数类型。

名称	类型	说明
bool	string
float	string
int	string
string	string

NotebookReferenceType

Synapse 笔记本引用类型。

名称	类型	说明
NotebookReference	string

ParameterSpecification

为实体定义单个参数。

名称	类型	说明
defaultValue	object	参数的默认值。
type	ParameterType	参数类型。

ParameterType

参数类型。

名称	类型	说明
Array	string
Bool	string
Float	string
Int	string
Object	string
SecureString	string
String	string

PipelineElapsedTimeMetricPolicy

管道运行时间指标策略。

名称	类型	说明
duration	object	TimeSpan 值，之后将触发 Azure 监视指标。

PipelinePolicy

管道策略。

名称	类型	说明
elapsedTimeMetric	PipelineElapsedTimeMetricPolicy	管道运行时间指标策略。

PipelineReference

管道引用类型。

名称	类型	说明
name	string	引用名称。
referenceName	string	引用管道名称。
type	enum: PipelineReference	管道引用类型。

PipelineResource

管道资源类型。

名称	类型	说明
etag	string	Etag 标识资源中的更改。
id	string	资源标识符。
name	string	资源名称。
properties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] 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	管道的最大并发运行数。
properties.description	string	管道的说明。
properties.folder	Folder	此管道所在的文件夹。如果未指定，管道将显示在根级别。
properties.parameters	<string, ParameterSpecification>	管道的参数列表。
properties.policy	PipelinePolicy	管道策略。
properties.runDimensions	object	管道发出的维度。
properties.variables	<string, VariableSpecification>	管道的变量列表。
type	string	资源类型。

PowerQuerySink

Power Query 接收器。

名称	类型	说明
dataset	DatasetReference	数据集引用。
description	string	转换说明。
flowlet	DataFlowReference	Flowlet 参考
linkedService	LinkedServiceReference	链接服务引用。
name	string	转换名称。
rejectedDataLinkedService	LinkedServiceReference	拒绝的数据链接服务引用。
schemaLinkedService	LinkedServiceReference	架构链接服务引用。
script	string	接收器脚本。

PowerQuerySinkMapping

将 Power Query 混合查询映射到接收器数据集（s）。

名称	类型	说明
dataflowSinks	PowerQuerySink[]	映射到 Power Query 混合查询的接收器列表。
queryName	string	Power Query 混合文档中查询的名称。

RedirectIncompatibleRowSettings

重定向不兼容行设置

名称	类型	说明
linkedServiceName	object	用于重定向不兼容行的 Azure 存储、存储 SAS 或 Azure Data Lake Store 链接服务的名称。如果指定 redirectIncompatibleRowSettings，则必须指定。类型：字符串（或带有 resultType 字符串的表达式）。
path	object	用于存储重定向不兼容行数据的路径。类型：字符串（或带有 resultType 字符串的表达式）。

ScriptActivity

脚本活动类型。

名称	类型	说明
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。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.scriptBlockExecutionTimeout	object	ScriptBlock 执行超时。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).
typeProperties.scripts	ScriptActivityScriptBlock[]	脚本块数组。类型：数组。
userProperties	UserProperty[]	活动用户属性。

ScriptActivityLogDestination

日志的目标。类型：字符串。

名称	类型	说明
ActivityOutput	string
ExternalStore	string

ScriptActivityParameter

脚本块的参数。

名称	类型	说明
direction	ScriptActivityParameterDirection	参数的方向。
name	object	参数的名称。类型：字符串（或带有 resultType 字符串的表达式）。
size	integer	输出方向参数的大小。
type	ScriptActivityParameterType	参数的类型。
value	object	参数的值。类型：字符串（或带有 resultType 字符串的表达式）。

ScriptActivityParameterDirection

参数的方向。

名称	类型	说明
Input	string
InputOutput	string
Output	string

ScriptActivityParameterType

参数的类型。

名称	类型	说明
Boolean	string
DateTime	string
DateTimeOffset	string
Decimal	string
Double	string
Guid	string
Int16	string
Int32	string
Int64	string
Single	string
String	string
Timespan	string

ScriptActivityScriptBlock

脚本块。

名称	类型	说明
parameters	ScriptActivityParameter[]	脚本参数数组。类型：数组。
text	object	查询文本。类型：字符串（或带有 resultType 字符串的表达式）。
type	object	查询的类型。有关有效选项，请参阅 ScriptType。类型：字符串（或带有 resultType 字符串的表达式）。

ScriptActivityTypeProperties.LogSettings

脚本活动的日志设置。

名称	类型	说明
logDestination	ScriptActivityLogDestination	日志的目标。类型：字符串。
logLocationSettings	LogLocationSettings	启用日志时，客户需要提供的日志位置设置。

SecureInputOutputPolicy

支持安全输入和输出的活动的执行策略。

名称	类型	说明
secureInput	boolean	设置为 true 时，活动输入被视为安全，不会记录到监视中。
secureOutput	boolean	设置为 true 时，活动输出被视为安全，不会记录到监视中。

SecureString

Azure 数据工厂安全字符串定义。在获取或列出 API 调用期间，字符串值将用星号“*”屏蔽。

名称	类型	说明
type	string: SecureString	机密的类型。
value	string	安全字符串的值。

SetVariableActivity

设置变量的值。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	SecureInputOutputPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: SetVariable	活动类型。
typeProperties.setSystemVariable	boolean	如果设置为 true，则设置管道运行返回值。
typeProperties.value	object	要设置的值。可以是静态值或表达式。
typeProperties.variableName	string	需要设置其值的变量的名称。
userProperties	UserProperty[]	活动用户属性。

SkipErrorFile

跳过错误文件。

名称	类型	说明
dataInconsistency	object	如果其他并发写入更改了源/接收器文件，请跳过。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
fileMissing	object	如果复制过程中其他客户端删除了文件，则跳过该文件。默认值为 true。类型：布尔值（或带有 resultType 布尔值的表达式）。

SparkConfigurationParametrizationReference

Spark 配置参考。

名称	类型	说明
referenceName	object	引用 spark 配置名称。类型：字符串（或带有 resultType 字符串的表达式）。
type	SparkConfigurationReferenceType	Spark 配置引用类型。

SparkConfigurationReferenceType

Spark 配置引用类型。

名称	类型	说明
SparkConfigurationReference	string

SparkJobReferenceType

Synapse spark 作业引用类型。

名称	类型	说明
SparkJobDefinitionReference	string

SqlServerStoredProcedureActivity

SQL 存储过程活动类型。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
linkedServiceName	LinkedServiceReference	链接服务引用。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	ActivityPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: SqlServerStoredProcedure	活动类型。
typeProperties.storedProcedureName	object	存储过程名称。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.storedProcedureParameters	object	存储过程参数的值和类型设置。示例：“{Parameter1： {value： ”1“， type： ”int“}}”。
userProperties	UserProperty[]	活动用户属性。

SSISAccessCredential

SSIS 访问凭据。

名称	类型	说明
domain	object	用于 Windows 身份验证的域。类型：字符串（或带有 resultType 字符串的表达式）。
password	SecretBase: AzureKeyVaultSecretReference SecureString	Windows 身份验证的密码。
userName	object	用于 Windows 身份验证的 UseName。类型：字符串（或带有 resultType 字符串的表达式）。

SSISChildPackage

SSIS 嵌入子包。

名称	类型	说明
packageContent	object	嵌入子包的内容。类型：字符串（或带有 resultType 字符串的表达式）。
packageLastModifiedDate	string	嵌入子包的上次修改日期。
packageName	string	嵌入子包的名称。
packagePath	object	嵌入子包的路径。类型：字符串（或带有 resultType 字符串的表达式）。

SSISExecutionCredential

SSIS 包执行凭据。

名称	类型	说明
domain	object	用于 Windows 身份验证的域。类型：字符串（或带有 resultType 字符串的表达式）。
password	SecureString	Windows 身份验证的密码。
userName	object	用于 Windows 身份验证的 UseName。类型：字符串（或带有 resultType 字符串的表达式）。

SSISExecutionParameter

SSIS 执行参数。

名称	类型	说明
value	object	SSIS 包执行参数值。类型：字符串（或带有 resultType 字符串的表达式）。

SSISLogLocation

SSIS 包执行日志位置

名称	类型	说明
logPath	object	SSIS 包执行日志路径。类型：字符串（或带有 resultType 字符串的表达式）。
type	SsisLogLocationType	SSIS 日志位置的类型。
typeProperties.accessCredential	SSISAccessCredential	包执行日志访问凭据。
typeProperties.logRefreshInterval	object	指定刷新日志的间隔。默认间隔为 5 分钟。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).

SsisLogLocationType

SSIS 日志位置的类型。

名称	类型	说明
File	string

SSISPackageLocation

SSIS 包位置。

名称	类型	说明
packagePath	object	SSIS 包路径。类型：字符串（或带有 resultType 字符串的表达式）。
type	SsisPackageLocationType	SSIS 包位置的类型。
typeProperties.accessCredential	SSISAccessCredential	包访问凭据。
typeProperties.childPackages	SSISChildPackage[]	嵌入的子包列表。
typeProperties.configurationAccessCredential	SSISAccessCredential	配置文件访问凭据。
typeProperties.configurationPath	object	包执行的配置文件。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.packageContent	object	嵌入包内容。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.packageLastModifiedDate	string	嵌入包上次修改日期。
typeProperties.packageName	string	包名称。
typeProperties.packagePassword	SecretBase: AzureKeyVaultSecretReference SecureString	包的密码。

SsisPackageLocationType

SSIS 包位置的类型。

名称	类型	说明
File	string
InlinePackage	string
PackageStore	string
SSISDB	string

SSISPropertyOverride

SSIS 属性重写。

名称	类型	说明
isSensitive	boolean	SSIS 包属性重写值是否为敏感数据。如果值为 true，则会在 SSISDB 中加密值
value	object	SSIS 包属性重写值。类型：字符串（或带有 resultType 字符串的表达式）。

StagingSettings

暂存设置。

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

SwitchActivity

此活动计算表达式，并在与 equals 属性中预期的表达式计算对应的 cases 属性下执行活动。

名称	类型	说明
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[] 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

切换具有值和相应活动的事例。

名称	类型	说明
activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] 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

执行 Synapse 笔记本活动。

名称	类型	说明
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”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.executorSize	object	要用于在会话的指定 Spark 池中分配的执行程序的核心和内存数，该池将用于替代你提供的笔记本的“executorCores”和“executorMemory”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.notebook	SynapseNotebookReference	Synapse 笔记本参考。
typeProperties.numExecutors	object	要为此会话启动的执行程序数，这将替代你提供的笔记本的“numExecutors”。类型：整数（或包含 resultType 整数的表达式）。
typeProperties.parameters	<string, NotebookParameter>	笔记本参数。
typeProperties.sparkConfig	object	Spark 配置属性。
typeProperties.sparkPool	BigDataPoolParametrizationReference	用于执行笔记本的大数据池的名称。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	spark 作业的 Spark 配置。
userProperties	UserProperty[]	活动用户属性。

SynapseNotebookReference

Synapse 笔记本引用类型。

名称	类型	说明
referenceName	object	引用笔记本名称。类型：字符串（或带有 resultType 字符串的表达式）。
type	NotebookReferenceType	Synapse 笔记本引用类型。

SynapseSparkJobDefinitionActivity

执行 spark 作业活动。

名称	类型	说明
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”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.conf	object	Spark 配置属性，这将替代你提供的 spark 作业定义的“conf”。
typeProperties.configurationType	ConfigurationType	spark 配置的类型。
typeProperties.driverSize	object	要用于在作业的指定 Spark 池中分配的驱动程序的核心和内存数，该池将用于替代你提供的 Spark 作业定义的“driverCores”和“driverMemory”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.executorSize	object	要用于在作业的指定 Spark 池中分配的执行程序的核心和内存数，该池将用于替代你提供的 Spark 作业定义的“executorCores”和“executorMemory”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.file	object	用于作业的主文件，它将替代你提供的 spark 作业定义的“文件”。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.files	object[]	（已弃用。请使用 pythonCodeReference 和 filesV2）主定义文件中用于引用的其他文件，这将替代你提供的 spark 作业定义的“文件”。
typeProperties.filesV2	object[]	用于在主定义文件中引用的其他文件，这将替代你提供的 spark 作业定义的“jars”和“files”。
typeProperties.numExecutors	object	要为此作业启动的执行程序数，这将替代你提供的 spark 作业定义的“numExecutors”。类型：整数（或包含 resultType 整数的表达式）。
typeProperties.pythonCodeReference	object[]	用于在主定义文件中引用的其他 python 代码文件，这将替代你提供的 spark 作业定义的“pyFiles”。
typeProperties.scanFolder	object	从主定义文件的根文件夹扫描子文件夹，这些文件将添加为引用文件。将扫描名为“jars”、“pyFiles”、“files”或“archives”的文件夹，文件夹名称区分大小写。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.sparkConfig	object	Spark 配置属性。
typeProperties.sparkJob	SynapseSparkJobReference	Synapse spark 作业参考。
typeProperties.targetBigDataPool	BigDataPoolParametrizationReference	用于执行 spark 批处理作业的大数据池的名称，该作业将替代你提供的 spark 作业定义的“targetBigDataPool”。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	spark 作业的 Spark 配置。
userProperties	UserProperty[]	活动用户属性。

SynapseSparkJobReference

Synapse spark 作业引用类型。

名称	类型	说明
referenceName	object	引用 spark 作业名称。带有 resultType 字符串的表达式。
type	SparkJobReferenceType	Synapse spark 作业引用类型。

Type

链接服务引用类型。

名称	类型	说明
LinkedServiceReference	string

UntilActivity

此活动执行内部活动，直到达到指定的布尔表达式结果为 true 或超时，以较早者为准。

名称	类型	说明
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[] 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	指定要运行的活动的超时值。如果未指定任何值，则采用 TimeSpan.FromDays（7）的值（默认值为 1 周）。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).
userProperties	UserProperty[]	活动用户属性。

UserProperty

User 属性。

名称	类型	说明
name	string	用户属性名称。
value	object	用户属性值。类型：字符串（或带有 resultType 字符串的表达式）。

ValidationActivity

此活动验证外部资源是否存在。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Validation	活动类型。
typeProperties.childItems	object	如果数据集指向文件夹，则可以使用。如果设置为 true，则文件夹必须至少有一个文件。如果设置为 false，则文件夹必须为空。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.dataset	DatasetReference	验证活动数据集参考。
typeProperties.minimumSize	object	如果数据集指向文件，则可以使用。文件的大小必须大于或等于指定的值。类型：整数（或包含 resultType 整数的表达式）。
typeProperties.sleep	object	验证尝试之间的延迟（以秒为单位）。如果未指定任何值，则 10 秒将用作默认值。类型：整数（或包含 resultType 整数的表达式）。
typeProperties.timeout	object	指定要运行的活动的超时值。如果未指定任何值，则采用 TimeSpan.FromDays（7）的值（默认值为 1 周）。类型：string（或带有 resultType 字符串的表达式），模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).
userProperties	UserProperty[]	活动用户属性。

VariableSpecification

管道的单个变量的定义。

名称	类型	说明
defaultValue	object	变量的默认值。
type	VariableType	变量类型。

VariableType

变量类型。

名称	类型	说明
Array	string
Bool	string
String	string

WaitActivity

此活动挂起指定间隔的管道执行。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: Wait	活动类型。
typeProperties.waitTimeInSeconds	object	持续时间（以秒为单位）。类型：整数（或包含 resultType 整数的表达式）。
userProperties	UserProperty[]	活动用户属性。

WebActivity

Web 活动。

名称	类型	说明
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 方法类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.connectVia	IntegrationRuntimeReference	集成运行时参考。
typeProperties.datasets	DatasetReference[]	传递给 Web 终结点的数据集列表。
typeProperties.disableCertValidation	boolean	设置为 true 时，将禁用证书验证。
typeProperties.headers	object	表示将发送到请求的标头。例如，若要在请求上设置语言和类型：“headers”： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。类型：字符串（或带有 resultType 字符串的表达式）。
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 活动目标终结点和路径。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

WebActivityAuthentication

Web 活动身份验证属性。

名称	类型	说明
credential	CredentialReference	包含身份验证信息的凭据引用。
password	SecretBase: AzureKeyVaultSecretReference SecureString	用于 ServicePrincipal 的 PFX 文件或基本身份验证/机密的密码
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	用于 ServicePrincipal 时 PFX 文件或证书的 Base64 编码内容
resource	object	使用 MSI 身份验证时，将为其请求 Azure 身份验证令牌的资源。类型：字符串（或带有 resultType 字符串的表达式）。
type	string	Web 活动身份验证（Basic/ClientCertificate/MSI/ServicePrincipal）
userTenant	object	使用 ServicePrincipal 身份验证时，将为其请求 Azure 身份验证令牌的 TenantId。类型：字符串（或带有 resultType 字符串的表达式）。
username	object	用于 ServicePrincipal 时用于基本身份验证或 ClientID 的 Web 活动身份验证用户名。类型：字符串（或带有 resultType 字符串的表达式）。

WebActivityMethod

WebActivity 支持的 HTTP 方法列表。

名称	类型	说明
DELETE	string
GET	string
POST	string
PUT	string

WebHookActivity

WebHook 活动。

名称	类型	说明
dependsOn	ActivityDependency[]	活动取决于条件。
description	string	活动说明。
name	string	活动名称。
onInactiveMarkAs	ActivityOnInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
policy	SecureInputOutputPolicy	活动策略。
state	ActivityState	活动状态。这是一个可选属性，如果未提供，则状态默认为“活动”。
type	string: WebHook	活动类型。
typeProperties.authentication	WebActivityAuthentication	用于调用终结点的身份验证方法。
typeProperties.body	object	表示将发送到终结点的有效负载。 POST/PUT 方法是必需的，不允许 GET 方法类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.headers	object	表示将发送到请求的标头。例如，若要在请求上设置语言和类型：“headers”： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。类型：字符串（或带有 resultType 字符串的表达式）。
typeProperties.method	WebHookActivityMethod	目标终结点的 Rest API 方法。
typeProperties.reportStatusOnCallBack	object	设置为 true 时，活动将使用回调请求正文中的 statusCode、输出和错误。可以通过在回调请求中设置 statusCode >= 400 来将活动标记为失败。默认值为 false。类型：布尔值（或带有 resultType 布尔值的表达式）。
typeProperties.timeout	string	Webhook 应调用回的超时。如果没有指定值，则默认为 10 分钟。类型：字符串。模式：（\d+）。？（\d\d）:(60\|（[0-5][0-9]）:(60\|（[0-5][0-9])).
typeProperties.url	object	WebHook 活动目标终结点和路径。类型：字符串（或带有 resultType 字符串的表达式）。
userProperties	UserProperty[]	活动用户属性。

WebHookActivityMethod

WebHook 活动支持的 HTTP 方法列表。

名称	类型	说明
POST	string

通过

Pipelines - Create Or Update

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

Pipelines_Create

示例请求

示例响应

Pipelines_Update

示例请求

示例响应

定义

ActivityDependency

ActivityOnInactiveMarkAs

ActivityPolicy

ActivityState

AppendVariableActivity

AzureDataExplorerCommandActivity

AzureFunctionActivity

AzureFunctionActivityMethod

AzureKeyVaultSecretReference

AzureMLBatchExecutionActivity

AzureMLExecutePipelineActivity

AzureMLUpdateResourceActivity

AzureMLWebServiceFile

BigDataPoolParametrizationReference

BigDataPoolReferenceType

CloudError

Compute

ConfigurationType

ContinuationSettingsReference

ControlActivity

CopyActivity

CopyActivityLogSettings

CredentialReference

CredentialReferenceType

CustomActivity

CustomActivityReferenceObject

DatabricksNotebookActivity

DatabricksSparkJarActivity

DatabricksSparkPythonActivity

DataFlowReference

DataFlowReferenceType

DataFlowStagingInfo

DataLakeAnalyticsUSQLActivity

DatasetReference

DeleteActivity

DependencyCondition

ExecuteDataFlowActivity

ExecutePipelineActivity

ExecutePipelineActivityPolicy

ExecuteSSISPackageActivity

ExecuteWranglingDataflowActivity

ExecutionActivity

Expression

FailActivity

FilterActivity

Folder

ForEachActivity

GetMetadataActivity

HDInsightActivityDebugInfoOption

HDInsightHiveActivity

HDInsightMapReduceActivity

HDInsightPigActivity

HDInsightSparkActivity

HDInsightStreamingActivity

IfConditionActivity

IntegrationRuntimeReference

LinkedServiceReference

LogLocationSettings

LogSettings

LogStorageSettings

LookupActivity

NotebookParameter

NotebookParameterType