Pipelines - Create Or Update

Serviço:

Data Factory

Versão da API:

2018-06-01

Cria ou atualiza um pipeline.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
factoryName	path	True	string	O nome da fábrica. Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
pipelineName	path	True	string	O nome do pipeline. Padrão Regex: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
resourceGroupName	path	True	string	O nome do grupo de recursos. Padrão Regex: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match		string	ETag da entidade de pipeline. Deve ser especificado apenas para atualização, para o qual ele deve corresponder à entidade existente ou pode ser * para atualização incondicional.

Corpo da solicitação

Nome	Tipo	Description
properties.activities	Activity[]: ControlActivity[] ExecutionActivity[] ExecuteWranglingDataflowActivity[] CopyActivity[] HDInsightHiveActivity[] HDInsightPigActivity[] HDInsightMapReduceActivity[] HDInsightStreamingActivity[] HDInsightSparkActivity[] ExecuteSSISPackageActivity[] CustomActivity[] SqlServerStoredProcedureActivity[] DeleteActivity[] AzureDataExplorerCommandActivity[] LookupActivity[] WebActivity[] GetMetadataActivity[] AzureMLBatchExecutionActivity[] AzureMLUpdateResourceActivity[] AzureMLExecutePipelineActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] AzureFunctionActivity[] ExecuteDataFlowActivity[] ScriptActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] ExecutePipelineActivity[] IfConditionActivity[] SwitchActivity[] ForEachActivity[] WaitActivity[] FailActivity[] UntilActivity[] ValidationActivity[] FilterActivity[] SetVariableActivity[] AppendVariableActivity[] WebHookActivity[]	Lista de atividades no pipeline.
properties.annotations	object[]	Lista de marcas que podem ser usadas para descrever o Pipeline.
properties.concurrency	integer	O número máximo de execuções simultâneas para o pipeline.
properties.description	string	A descrição do pipeline.
properties.folder	Folder	A pasta na qual este Pipeline está. Se não for especificado, o Pipeline aparecerá no nível raiz.
properties.parameters	<string,  ParameterSpecification>	Lista de parâmetros para pipeline.
properties.policy	PipelinePolicy	Política de pipeline.
properties.runDimensions	object	Dimensões emitidas pelo Pipeline.
properties.variables	<string,  VariableSpecification>	Lista de variáveis para pipeline.

Respostas

Nome	Tipo	Description
200 OK	PipelineResource	OKEY.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Pipelines_Create

Pipelines_Update

Pipelines_Create

Solicitação de exemplo

HTTP

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

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Resposta de exemplo

Código de status:

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

Solicitação de exemplo

HTTP

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

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
ActivityDependency	Informações de dependência de atividade.
ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
ActivityPolicy	Política de execução para uma atividade.
ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
AppendVariableActivity	Valor de acréscimo para uma variável do tipo Matriz.
AzureDataExplorerCommandActivity	Atividade de comando do Azure Data Explorer.
AzureFunctionActivity	Atividade do Azure Function.
AzureFunctionActivityMethod	A lista de métodos HTTP com suporte por um AzureFunctionActivity.
AzureKeyVaultSecretReference	Referência de segredo do Azure Key Vault.
AzureMLBatchExecutionActivity	Atividade de Execução em Lote do Azure ML.
AzureMLExecutePipelineActivity	Atividade Executar Pipeline do Azure ML.
AzureMLUpdateResourceActivity	Atividade de gerenciamento de recursos de atualização do Azure ML.
AzureMLWebServiceFile	Arquivo de entrada/saída do WebService do Azure ML
BigDataPoolParametrizationReference	Tipo de referência do pool de Big Data.
BigDataPoolReferenceType	Tipo de referência do pool de Big Data.
CloudError	O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
Compute	Propriedades de computação para a atividade de fluxo de dados.
ConfigurationType	O tipo da configuração do spark.
ContinuationSettingsReference	Configurações de continuação para executar a atividade de fluxo de dados.
ControlActivity	Classe base para todas as atividades de controle, como IfCondition, ForEach, Until.
CopyActivity	Atividade de cópia.
CopyActivityLogSettings	Configurações para o log de atividades de cópia.
CredentialReference	Tipo de referência de credencial.
CredentialReferenceType	Tipo de referência de credencial.
CustomActivity	Tipo de atividade personalizada.
CustomActivityReferenceObject	Objetos de referência para atividade personalizada
DatabricksNotebookActivity	Atividade databricksNotebook.
DatabricksSparkJarActivity	Atividade databricksSparkJar.
DatabricksSparkPythonActivity	Atividade DatabricksSparkPython.
DataFlowReference	Tipo de referência de fluxo de dados.
DataFlowReferenceType	Tipo de referência de fluxo de dados.
DataFlowStagingInfo	Informações de preparo para executar a atividade de fluxo de dados.
DataLakeAnalyticsUSQLActivity	Atividade U-SQL do Data Lake Analytics.
DatasetReference	Tipo de referência do conjunto de dados.
DeleteActivity	Excluir atividade.
DependencyCondition	Match-Condition para a dependência.
ExecuteDataFlowActivity	Execute a atividade de fluxo de dados.
ExecutePipelineActivity	Execute a atividade de pipeline.
ExecutePipelineActivityPolicy	Política de execução para uma atividade de pipeline de execução.
ExecuteSSISPackageActivity	Execute a atividade do pacote SSIS.
ExecuteWranglingDataflowActivity	Execute a atividade de consulta de energia.
ExecutionActivity	Classe base para todas as atividades de execução.
Expression	Definição de expressão do Azure Data Factory.
FailActivity	Essa atividade falhará em seu próprio escopo e produzirá uma mensagem de erro personalizada e um código de erro. A mensagem de erro e o código podem ser fornecidos como um literal de cadeia de caracteres ou como uma expressão que pode ser avaliada para uma cadeia de caracteres em runtime. O escopo da atividade pode ser todo o pipeline ou uma atividade de controle (por exemplo, foreach, alternar, até), se a atividade de falha estiver contida nele.
FilterActivity	Filtrar e retornar resultados da matriz de entrada com base nas condições.
Folder	A pasta na qual este Pipeline está. Se não for especificado, o Pipeline aparecerá no nível raiz.
ForEachActivity	Essa atividade é usada para iterar em uma coleção e executar determinadas atividades.
GetMetadataActivity	Atividade para obter metadados do conjunto de dados
HDInsightActivityDebugInfoOption	As configurações de HDInsightActivityDebugInfoOption a serem usadas.
HDInsightHiveActivity	Tipo de atividade do Hive do HDInsight.
HDInsightMapReduceActivity	Tipo de atividade MapReduce do HDInsight.
HDInsightPigActivity	Tipo de atividade do Pig do HDInsight.
HDInsightSparkActivity	Atividade do Spark do HDInsight.
HDInsightStreamingActivity	Tipo de atividade de streaming do HDInsight.
IfConditionActivity	Essa atividade avalia uma expressão booliana e executa as atividades na propriedade ifTrueActivities ou na propriedade ifFalseActivities, dependendo do resultado da expressão.
IntegrationRuntimeReference	Tipo de referência de runtime de integração.
LinkedServiceReference	Tipo de referência de serviço vinculado.
LogLocationSettings	Configurações de local de log.
LogSettings	Configurações de log.
LogStorageSettings	(Preterido. Use as configurações de armazenamento de log do LogSettings).
LookupActivity	Atividade de pesquisa.
NotebookParameter	Parâmetro de bloco de anotações.
NotebookParameterType	Tipo de parâmetro notebook.
NotebookReferenceType	Tipo de referência do notebook do Synapse.
ParameterSpecification	Definição de um único parâmetro para uma entidade.
ParameterType	Tipo de parâmetro.
PipelineElapsedTimeMetricPolicy	Política de Métrica do ElapsedTime do Pipeline.
PipelinePolicy	Política de pipeline.
PipelineReference	Tipo de referência de pipeline.
PipelineResource	Tipo de recurso de pipeline.
PowerQuerySink	Coletor de consulta de energia.
PowerQuerySinkMapping	Mapeie a consulta de mashup do Power Query para conjuntos de dados do coletor.
RedirectIncompatibleRowSettings	Redirecionar configurações de linha incompatíveis
ScriptActivity	Tipo de atividade de script.
ScriptActivityLogDestination	O destino dos logs. Tipo: cadeia de caracteres.
ScriptActivityParameter	Parâmetros de um bloco de script.
ScriptActivityParameterDirection	A direção do parâmetro.
ScriptActivityParameterType	O tipo do parâmetro.
ScriptActivityScriptBlock	Bloco de scripts.
ScriptActivityTypeProperties.LogSettings	Configurações de log da atividade de script.
SecureInputOutputPolicy	Política de execução para uma atividade que dá suporte a entrada e saída seguras.
SecureString	Definição de cadeia de caracteres segura do Azure Data Factory. O valor da cadeia de caracteres será mascarado com asteriscos '*' durante as chamadas à API Get ou List.
SetVariableActivity	Defina o valor de uma variável.
SkipErrorFile	Ignorar o arquivo de erro.
SparkConfigurationParametrizationReference	Referência de configuração do Spark.
SparkConfigurationReferenceType	Tipo de referência de configuração do Spark.
SparkJobReferenceType	Tipo de referência de trabalho do Spark do Synapse.
SqlServerStoredProcedureActivity	Tipo de atividade de procedimento armazenado do SQL.
SSISAccessCredential	Credencial de acesso do SSIS.
SSISChildPackage	Pacote filho inserido do SSIS.
SSISExecutionCredential	Credencial de execução do pacote SSIS.
SSISExecutionParameter	Parâmetro de execução do SSIS.
SSISLogLocation	Local do log de execução do pacote SSIS
SsisLogLocationType	O tipo de local de log do SSIS.
SSISPackageLocation	Local do pacote SSIS.
SsisPackageLocationType	O tipo de local do pacote SSIS.
SSISPropertyOverride	Substituição da propriedade SSIS.
StagingSettings	Configurações de preparo.
SwitchActivity	Essa atividade avalia uma expressão e executa atividades na propriedade cases que correspondem à avaliação de expressão esperada na propriedade equals.
SwitchCase	Alterne casos com um valor e atividades correspondentes.
SynapseNotebookActivity	Execute a atividade do notebook do Synapse.
SynapseNotebookReference	Tipo de referência do notebook do Synapse.
SynapseSparkJobDefinitionActivity	Execute a atividade de trabalho do Spark.
SynapseSparkJobReference	Tipo de referência de trabalho do Spark do Synapse.
Type	Tipo de referência de serviço vinculado.
UntilActivity	Essa atividade executa atividades internas até que os resultados da expressão booliana especificados sejam atingidos como true ou tempo limite, o que for anterior.
UserProperty	Propriedade do usuário.
ValidationActivity	Essa atividade verifica se existe um recurso externo.
VariableSpecification	Definição de uma única variável para um Pipeline.
VariableType	Tipo de variável.
WaitActivity	Essa atividade suspende a execução do pipeline para o intervalo especificado.
WebActivity	Atividade da Web.
WebActivityAuthentication	Propriedades de autenticação de atividade da Web.
WebActivityMethod	A lista de métodos HTTP com suporte por uma WebActivity.
WebHookActivity	Atividade do WebHook.
WebHookActivityMethod	A lista de métodos HTTP com suporte por uma atividade do WebHook.

ActivityDependency

Informações de dependência de atividade.

Nome	Tipo	Description
activity	string	Nome da atividade.
dependencyConditions	DependencyCondition[]	Match-Condition para a dependência.

ActivityOnInactiveMarkAs

Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.

Nome	Tipo	Description
Failed	string
Skipped	string
Succeeded	string

ActivityPolicy

Política de execução para uma atividade.

Nome	Tipo	Description
retry	object	Tentativas de repetição comuns máximas. O padrão é 0. Tipo: inteiro (ou Expressão com número inteiro resultType), mínimo: 0.
retryIntervalInSeconds	integer	Intervalo entre cada tentativa de repetição (em segundos). O padrão é 30 segundos.
secureInput	boolean	Quando definido como true, a entrada da atividade é considerada segura e não será registrada no monitoramento.
secureOutput	boolean	Quando definido como true, a saída da atividade é considerada segura e não será registrada no monitoramento.
timeout	object	Especifica o tempo limite para a atividade a ser executada. O tempo limite padrão é de 7 dias. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).

ActivityState

Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.

Nome	Tipo	Description
Active	string
Inactive	string

AppendVariableActivity

Valor de acréscimo para uma variável do tipo Matriz.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AppendVariable	Tipo de atividade.
typeProperties.value	object	Valor a ser acrescentado. Tipo: pode ser um tipo de correspondência de valor estático do item de variável ou expressão com o tipo de correspondência resultType do item de variável
typeProperties.variableName	string	Nome da variável cujo valor precisa ser acrescentado.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureDataExplorerCommandActivity

Atividade de comando do Azure Data Explorer.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AzureDataExplorerCommand	Tipo de atividade.
typeProperties.command	object	Um comando de controle, de acordo com a sintaxe de comando do Azure Data Explorer. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.commandTimeout	object	Controle o tempo limite do comando. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9]))..)
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureFunctionActivity

Atividade do Azure Function.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AzureFunctionActivity	Tipo de atividade.
typeProperties.body	object	Representa o conteúdo que será enviado para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.functionName	object	Nome da função que a Atividade de Função do Azure chamará. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType)
typeProperties.headers	object	Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e o tipo em uma solicitação: "cabeçalhos" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.method	AzureFunctionActivityMethod	Método de API Rest para o ponto de extremidade de destino.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureFunctionActivityMethod

A lista de métodos HTTP com suporte por um AzureFunctionActivity.

Nome	Tipo	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

AzureKeyVaultSecretReference

Referência de segredo do Azure Key Vault.

Nome	Tipo	Description
secretName	object	O nome do segredo no Azure Key Vault. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
secretVersion	object	A versão do segredo no Azure Key Vault. O valor padrão é a versão mais recente do segredo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
store	LinkedServiceReference	A referência de serviço vinculado do Azure Key Vault.
type	string: AzureKeyVaultSecret	Tipo do segredo.

AzureMLBatchExecutionActivity

Atividade de Execução em Lote do Azure ML.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AzureMLBatchExecution	Tipo de atividade.
typeProperties.globalParameters	object	Chave, pares de valor a serem passados para o ponto de extremidade do Serviço de Execução em Lote do Azure ML. As chaves devem corresponder aos nomes dos parâmetros de serviço Web definidos no serviço Web publicado do Azure ML. Os valores serão passados na propriedade GlobalParameters da solicitação de execução em lote do Azure ML.
typeProperties.webServiceInputs	<string,  AzureMLWebServiceFile>	Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. Essas informações serão passadas na propriedade WebServiceInputs da solicitação de execução em lote do Azure ML.
typeProperties.webServiceOutputs	<string,  AzureMLWebServiceFile>	Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. Essas informações serão passadas na propriedade WebServiceOutputs da solicitação de execução em lote do Azure ML.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureMLExecutePipelineActivity

Atividade Executar Pipeline do Azure ML.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AzureMLExecutePipeline	Tipo de atividade.
typeProperties.continueOnStepFailure	object	Se deve continuar a execução de outras etapas no PipelineRun se uma etapa falhar. Essas informações serão passadas na propriedade continueOnStepFailure da solicitação de execução de pipeline publicada. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.dataPathAssignments	object	Dicionário usado para alterar atribuições de caminho de dados sem treinar novamente. Os valores serão passados na propriedade dataPathAssignments da solicitação de execução de pipeline publicada. Tipo: objeto (ou Expressão com objeto resultType).
typeProperties.experimentName	object	Executar o nome do experimento de histórico da execução do pipeline. Essas informações serão passadas na propriedade ExperimentName da solicitação de execução de pipeline publicada. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.mlParentRunId	object	A ID de execução do pipeline do Serviço de ML do Azure pai. Essas informações serão passadas na propriedade ParentRunId da solicitação de execução de pipeline publicada. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.mlPipelineEndpointId	object	ID do ponto de extremidade de pipeline do Azure ML publicado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.mlPipelineId	object	ID do pipeline publicado do Azure ML. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.mlPipelineParameters	object	Chave, pares de valor a serem passados para o ponto de extremidade de pipeline do Azure ML publicado. As chaves devem corresponder aos nomes dos parâmetros de pipeline definidos no pipeline publicado. Os valores serão passados na propriedade ParameterAssignments da solicitação de execução de pipeline publicada. Tipo: objeto com pares de valor de chave (ou Expressão com objeto resultType).
typeProperties.version	object	Versão do ponto de extremidade de pipeline do Azure ML publicado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureMLUpdateResourceActivity

Atividade de gerenciamento de recursos de atualização do Azure ML.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: AzureMLUpdateResource	Tipo de atividade.
typeProperties.trainedModelFilePath	object	O caminho de arquivo relativo no trainedModelLinkedService para representar o arquivo .ilearner que será carregado pela operação de atualização. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.trainedModelLinkedServiceName	LinkedServiceReference	Nome do serviço vinculado do Armazenamento do Azure que contém o arquivo .ilearner que será carregado pela operação de atualização.
typeProperties.trainedModelName	object	Nome do módulo Modelo Treinado no experimento do Serviço Web a ser atualizado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

AzureMLWebServiceFile

Arquivo de entrada/saída do WebService do Azure ML

Nome	Tipo	Description
filePath	object	O caminho de arquivo relativo, incluindo o nome do contêiner, no Armazenamento de Blobs do Azure especificado pelo LinkedService. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
linkedServiceName	LinkedServiceReference	Referência a um LinkedService de Armazenamento do Azure, em que o arquivo de entrada/saída do WebService do Azure ML está localizado.

BigDataPoolParametrizationReference

Tipo de referência do pool de Big Data.

Nome	Tipo	Description
referenceName	object	Nome do pool de Big Data de referência. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	BigDataPoolReferenceType	Tipo de referência do pool de Big Data.

BigDataPoolReferenceType

Tipo de referência do pool de Big Data.

Nome	Tipo	Description
BigDataPoolReference	string

CloudError

O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.

Nome	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade na solicitação associada ao erro.

Compute

Propriedades de computação para a atividade de fluxo de dados.

Nome	Tipo	Description
computeType	object	Tipo de computação do cluster que executará o trabalho de fluxo de dados. Os valores possíveis incluem: 'Geral', 'MemoryOptimized', 'ComputeOptimized'. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType)
coreCount	object	Contagem principal do cluster que executará o trabalho de fluxo de dados. Os valores com suporte são: 8, 16, 32, 48, 80, 144 e 272. Tipo: inteiro (ou Expressão com inteiro resultType)

ConfigurationType

O tipo da configuração do spark.

Nome	Tipo	Description
Artifact	string
Customized	string
Default	string

ContinuationSettingsReference

Configurações de continuação para executar a atividade de fluxo de dados.

Nome	Tipo	Description
continuationTtlInMinutes	object	TTL de continuação em minutos.
customizedCheckpointKey	object	Chave de ponto de verificação personalizada.
idleCondition	object	Condição ociosa.

ControlActivity

Classe base para todas as atividades de controle, como IfCondition, ForEach, Until.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Container	Tipo de atividade.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

CopyActivity

Atividade de cópia.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
inputs	DatasetReference[]	Lista de entradas para a atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
outputs	DatasetReference[]	Lista de saídas para a atividade.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Copy	Tipo de atividade.
typeProperties.dataIntegrationUnits	object	Número máximo de unidades de integração de dados que podem ser usadas para executar essa movimentação de dados. Tipo: inteiro (ou Expressão com número inteiro resultType), mínimo: 0.
typeProperties.enableSkipIncompatibleRow	object	Se deve ignorar linha incompatível. O valor padrão é falso. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.enableStaging	object	Especifica se os dados devem ser copiados por meio de um preparo provisório. O valor padrão é falso. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.logSettings	LogSettings	As configurações de log que o cliente precisa fornecer ao habilitar o log.
typeProperties.logStorageSettings	LogStorageSettings	(Preterido. Use as configurações de armazenamento de log do LogSettings) que o cliente precisa fornecer ao habilitar o log de sessão.
typeProperties.parallelCopies	object	Número máximo de sessões simultâneas abertas na origem ou no coletor para evitar sobrecarregar o armazenamento de dados. Tipo: inteiro (ou Expressão com número inteiro resultType), mínimo: 0.
typeProperties.preserve	object[]	Preservar regras.
typeProperties.preserveRules	object[]	Preservar regras.
typeProperties.redirectIncompatibleRowSettings	RedirectIncompatibleRowSettings	Redirecione as configurações de linha incompatíveis quando EnableSkipIncompatibleRow for true.
typeProperties.sink	CopySink	Copiar coletor de atividade.
typeProperties.skipErrorFile	SkipErrorFile	Especifique a tolerância a falhas para consistência de dados.
typeProperties.source	CopySource	Origem da atividade de cópia.
typeProperties.stagingSettings	StagingSettings	Especifica as configurações de preparo provisório quando EnableStaging é verdadeiro.
typeProperties.translator	object	Copiar tradutor de atividade. Se não for especificado, o tradutor de tabela será usado.
typeProperties.validateDataConsistency	object	Se deseja habilitar a validação de Consistência de Dados. Tipo: booliano (ou Expressão com resultType booleano).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

CopyActivityLogSettings

Configurações para o log de atividades de cópia.

Nome	Tipo	Description
enableReliableLogging	object	Especifica se o registro em log confiável deve ser habilitado. Tipo: booliano (ou Expressão com resultType booleano).
logLevel	object	Obtém ou define o nível de log, suporte: Informações, Aviso. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

CredentialReference

Tipo de referência de credencial.

Nome	Tipo	Description
referenceName	string	Nome da credencial de referência.
type	CredentialReferenceType	Tipo de referência de credencial.

CredentialReferenceType

Tipo de referência de credencial.

Nome	Tipo	Description
CredentialReference	string

CustomActivity

Tipo de atividade personalizada.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Custom	Tipo de atividade.
typeProperties.autoUserSpecification	object	Nível de elevação e escopo para o usuário, o padrão é tarefa não administradora. Tipo: cadeia de caracteres (ou Expressão com resultType duplo).
typeProperties.command	object	Comando para a atividade personalizada Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.extendedProperties	object	Recipiente de propriedades definido pelo usuário. Não há nenhuma restrição nas chaves ou valores que podem ser usados. A atividade personalizada especificada pelo usuário tem a responsabilidade total de consumir e interpretar o conteúdo definido.
typeProperties.folderPath	object	Caminho da pasta para arquivos de recurso Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.referenceObjects	CustomActivityReferenceObject	Objetos de referência
typeProperties.resourceLinkedService	LinkedServiceReference	Referência de serviço vinculado a recursos.
typeProperties.retentionTimeInDays	object	O tempo de retenção para os arquivos enviados para atividade personalizada. Tipo: duplo (ou Expressão com resultType duplo).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

CustomActivityReferenceObject

Objetos de referência para atividade personalizada

Nome	Tipo	Description
datasets	DatasetReference[]	Referências de conjunto de dados.
linkedServices	LinkedServiceReference[]	Referências de serviço vinculado.

DatabricksNotebookActivity

Atividade databricksNotebook.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: DatabricksNotebook	Tipo de atividade.
typeProperties.baseParameters	object	Parâmetros base a serem usados para cada execução deste trabalho. Se o notebook usa um parâmetro que não é especificado, o valor padrão do notebook será usado.
typeProperties.libraries	object[]	Uma lista de bibliotecas a serem instaladas no cluster que executará o trabalho.
typeProperties.notebookPath	object	O caminho absoluto do notebook a ser executado no Workspace do Databricks. Esse caminho deve começar com uma barra. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

DatabricksSparkJarActivity

Atividade databricksSparkJar.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: DatabricksSparkJar	Tipo de atividade.
typeProperties.libraries	object[]	Uma lista de bibliotecas a serem instaladas no cluster que executará o trabalho.
typeProperties.mainClassName	object	O nome completo da classe que contém o método principal a ser executado. Essa classe deve estar contida em um JAR fornecido como uma biblioteca. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.parameters	object[]	Parâmetros que serão passados para o método principal.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

DatabricksSparkPythonActivity

Atividade DatabricksSparkPython.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: DatabricksSparkPython	Tipo de atividade.
typeProperties.libraries	object[]	Uma lista de bibliotecas a serem instaladas no cluster que executará o trabalho.
typeProperties.parameters	object[]	Parâmetros de linha de comando que serão passados para o arquivo Python.
typeProperties.pythonFile	object	O URI do arquivo Python a ser executado. Há suporte para caminhos DBFS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

DataFlowReference

Tipo de referência de fluxo de dados.

Nome	Tipo	Description
datasetParameters	object	Parâmetros de fluxo de dados de referência do conjunto de dados.
parameters	object	Parâmetros de fluxo de dados
referenceName	string	Nome do fluxo de dados de referência.
type	DataFlowReferenceType	Tipo de referência de fluxo de dados.

DataFlowReferenceType

Tipo de referência de fluxo de dados.

Nome	Tipo	Description
DataFlowReference	string

DataFlowStagingInfo

Informações de preparo para executar a atividade de fluxo de dados.

Nome	Tipo	Description
folderPath	object	Caminho da pasta para o blob de preparo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType)
linkedService	LinkedServiceReference	Referência de serviço vinculado de preparo.

DataLakeAnalyticsUSQLActivity

Atividade U-SQL do Data Lake Analytics.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: DataLakeAnalyticsU-SQL	Tipo de atividade.
typeProperties.compilationMode	object	Modo de compilação do U-SQL. Deve ser um destes valores: Semântico, Completo e SingleBox. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.degreeOfParallelism	object	O número máximo de nós usados simultaneamente para executar o trabalho. O valor padrão é 1. Tipo: inteiro (ou Expressão com número inteiro resultType), mínimo: 1.
typeProperties.parameters	object	Parâmetros para solicitação de trabalho U-SQL.
typeProperties.priority	object	Determina quais trabalhos de todos os que estão na fila devem ser selecionados para serem executados primeiro. Quanto menor o número, maior a prioridade. O valor padrão é 1000. Tipo: inteiro (ou Expressão com número inteiro resultType), mínimo: 1.
typeProperties.runtimeVersion	object	Versão de runtime do mecanismo U-SQL a ser usado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.scriptLinkedService	LinkedServiceReference	Referência de serviço vinculado de script.
typeProperties.scriptPath	object	Caminho diferencia maiúsculas de minúsculas para a pasta que contém o script U-SQL. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

DatasetReference

Tipo de referência do conjunto de dados.

Nome	Tipo	Description
parameters	object	Argumentos para o conjunto de dados.
referenceName	string	Nome do conjunto de dados de referência.
type	enum: DatasetReference	Tipo de referência do conjunto de dados.

DeleteActivity

Excluir atividade.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Delete	Tipo de atividade.
typeProperties.dataset	DatasetReference	Excluir referência do conjunto de dados da atividade.
typeProperties.enableLogging	object	Se os logs detalhados de execução de atividade de exclusão devem ser registrados. O valor padrão é falso. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.logStorageSettings	LogStorageSettings	As configurações de armazenamento de log que o cliente precisa fornecer quando enableLogging é verdadeiro.
typeProperties.maxConcurrentConnections	integer	As conexões simultâneas máximas para conectar a fonte de dados ao mesmo tempo.
typeProperties.recursive	object	Se for true, arquivos ou subpastas no caminho da pasta atual serão excluídos recursivamente. O padrão é false. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.storeSettings	StoreReadSettings	Excluir configurações do repositório de atividades.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

DependencyCondition

Match-Condition para a dependência.

Nome	Tipo	Description
Completed	string
Failed	string
Skipped	string
Succeeded	string

ExecuteDataFlowActivity

Execute a atividade de fluxo de dados.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: ExecuteDataFlow	Tipo de atividade.
typeProperties.compute	Compute	Propriedades de computação para a atividade de fluxo de dados.
typeProperties.continuationSettings	ContinuationSettingsReference	Configurações de continuação para executar a atividade de fluxo de dados.
typeProperties.continueOnError	object	Continue na configuração de erro usada para a execução do fluxo de dados. Permite que o processamento continue se um coletor falhar. Tipo: booliano (ou Expressão com resultType booleano)
typeProperties.dataFlow	DataFlowReference	Referência de fluxo de dados.
typeProperties.integrationRuntime	IntegrationRuntimeReference	A referência de runtime de integração.
typeProperties.runConcurrently	object	Configuração de execução simultânea usada para execução de fluxo de dados. Permite que coletores com a mesma ordem de salvamento sejam processados simultaneamente. Tipo: booliano (ou Expressão com resultType booleano)
typeProperties.sourceStagingConcurrency	object	Especifique o número de preparo paralelo para fontes aplicáveis ao coletor. Tipo: inteiro (ou Expressão com inteiro resultType)
typeProperties.staging	DataFlowStagingInfo	Informações de preparo para executar a atividade de fluxo de dados.
typeProperties.traceLevel	object	Configuração de nível de rastreamento usada para a saída de monitoramento de fluxo de dados. Os valores com suporte são: 'grosseiro', 'fino' e 'nenhum'. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType)
userProperties	UserProperty[]	Propriedades do usuário da atividade.

ExecutePipelineActivity

Execute a atividade de pipeline.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ExecutePipelineActivityPolicy	Execute a política de atividade de pipeline.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: ExecutePipeline	Tipo de atividade.
typeProperties.parameters	object	Parâmetros de pipeline.
typeProperties.pipeline	PipelineReference	Referência de pipeline.
typeProperties.waitOnCompletion	boolean	Define se a execução da atividade aguardará a conclusão da execução do pipeline dependente. O padrão é false.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

ExecutePipelineActivityPolicy

Política de execução para uma atividade de pipeline de execução.

Nome	Tipo	Description
secureInput	boolean	Quando definido como true, a entrada da atividade é considerada segura e não será registrada no monitoramento.

ExecuteSSISPackageActivity

Execute a atividade do pacote SSIS.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: ExecuteSSISPackage	Tipo de atividade.
typeProperties.connectVia	IntegrationRuntimeReference	A referência de runtime de integração.
typeProperties.environmentPath	object	O caminho do ambiente para executar o pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.executionCredential	SSISExecutionCredential	A credencial de execução do pacote.
typeProperties.logLocation	SSISLogLocation	Local do log de execução do pacote SSIS.
typeProperties.loggingLevel	object	O nível de log da execução do pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.packageConnectionManagers	object	Os gerenciadores de conexões no nível do pacote para executar o pacote SSIS.
typeProperties.packageLocation	SSISPackageLocation	Local do pacote SSIS.
typeProperties.packageParameters	<string,  SSISExecutionParameter>	Os parâmetros de nível de pacote para executar o pacote SSIS.
typeProperties.projectConnectionManagers	object	Os gerenciadores de conexões no nível do projeto para executar o pacote SSIS.
typeProperties.projectParameters	<string,  SSISExecutionParameter>	Os parâmetros de nível de projeto para executar o pacote SSIS.
typeProperties.propertyOverrides	<string,  SSISPropertyOverride>	A propriedade substitui para executar o pacote SSIS.
typeProperties.runtime	object	Especifica o runtime para executar o pacote SSIS. O valor deve ser "x86" ou "x64". Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

ExecuteWranglingDataflowActivity

Execute a atividade de consulta de energia.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: ExecuteWranglingDataflow	Tipo de atividade.
typeProperties.compute	Compute	Propriedades de computação para a atividade de fluxo de dados.
typeProperties.continuationSettings	ContinuationSettingsReference	Configurações de continuação para executar a atividade de fluxo de dados.
typeProperties.continueOnError	object	Continue na configuração de erro usada para a execução do fluxo de dados. Permite que o processamento continue se um coletor falhar. Tipo: booliano (ou Expressão com resultType booleano)
typeProperties.dataFlow	DataFlowReference	Referência de fluxo de dados.
typeProperties.integrationRuntime	IntegrationRuntimeReference	A referência de runtime de integração.
typeProperties.queries	PowerQuerySinkMapping[]	Lista de mapeamento para consulta de mashup do Power Query para conjuntos de dados do coletor.
typeProperties.runConcurrently	object	Configuração de execução simultânea usada para execução de fluxo de dados. Permite que coletores com a mesma ordem de salvamento sejam processados simultaneamente. Tipo: booliano (ou Expressão com resultType booleano)
typeProperties.sinks	<string,  PowerQuerySink>	(Preterido. Use consultas). Lista de coletores de atividades do Power Query mapeados para um queryName.
typeProperties.sourceStagingConcurrency	object	Especifique o número de preparo paralelo para fontes aplicáveis ao coletor. Tipo: inteiro (ou Expressão com inteiro resultType)
typeProperties.staging	DataFlowStagingInfo	Informações de preparo para executar a atividade de fluxo de dados.
typeProperties.traceLevel	object	Configuração de nível de rastreamento usada para a saída de monitoramento de fluxo de dados. Os valores com suporte são: 'grosseiro', 'fino' e 'nenhum'. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType)
userProperties	UserProperty[]	Propriedades do usuário da atividade.

ExecutionActivity

Classe base para todas as atividades de execução.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Execution	Tipo de atividade.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

Expression

Definição de expressão do Azure Data Factory.

Nome	Tipo	Description
type	enum: Expression	Tipo de expressão.
value	string	Valor da expressão.

FailActivity

Essa atividade falhará em seu próprio escopo e produzirá uma mensagem de erro personalizada e um código de erro. A mensagem de erro e o código podem ser fornecidos como um literal de cadeia de caracteres ou como uma expressão que pode ser avaliada para uma cadeia de caracteres em runtime. O escopo da atividade pode ser todo o pipeline ou uma atividade de controle (por exemplo, foreach, alternar, até), se a atividade de falha estiver contida nele.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Fail	Tipo de atividade.
typeProperties.errorCode	object	O código de erro que categoriza o tipo de erro da atividade Fail. Pode ser um conteúdo dinâmico que é avaliado como uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.message	object	A mensagem de erro que veio à tona na atividade Fail. Pode ser um conteúdo dinâmico que é avaliado como uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

FilterActivity

Filtrar e retornar resultados da matriz de entrada com base nas condições.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Filter	Tipo de atividade.
typeProperties.condition	Expression	Condição a ser usada para filtrar a entrada.
typeProperties.items	Expression	Matriz de entrada na qual o filtro deve ser aplicado.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

Folder

A pasta na qual este Pipeline está. Se não for especificado, o Pipeline aparecerá no nível raiz.

Nome	Tipo	Description
name	string	O nome da pasta na qual este Pipeline está.

ForEachActivity

Essa atividade é usada para iterar em uma coleção e executar determinadas atividades.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: ForEach	Tipo de atividade.
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[]	Lista de atividades a serem executadas.
typeProperties.batchCount	integer	Contagem de lote a ser usada para controlar o número de execução paralela (quando isSequential é definido como false).
typeProperties.isSequential	boolean	Se o loop for executado em sequência ou em paralelo (máximo 50)
typeProperties.items	Expression	Coleção a ser iterada.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

GetMetadataActivity

Atividade para obter metadados do conjunto de dados

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: GetMetadata	Tipo de atividade.
typeProperties.dataset	DatasetReference	Referência do conjunto de dados da atividade GetMetadata.
typeProperties.fieldList	object[]	Campos de metadados a serem obtidos do conjunto de dados.
typeProperties.formatSettings	FormatReadSettings	Configurações de formato de atividade GetMetadata.
typeProperties.storeSettings	StoreReadSettings	Configurações do repositório de atividades GetMetadata.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

HDInsightActivityDebugInfoOption

As configurações de HDInsightActivityDebugInfoOption a serem usadas.

Nome	Tipo	Description
Always	string
Failure	string
None	string

HDInsightHiveActivity

Tipo de atividade do Hive do HDInsight.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: HDInsightHive	Tipo de atividade.
typeProperties.arguments	object[]	Argumentos especificados pelo usuário para HDInsightActivity.
typeProperties.defines	object	Permite que o usuário especifique as definições para solicitação de trabalho do Hive.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Opção de informações de depuração.
typeProperties.queryTimeout	integer	Valor do tempo limite da consulta (em minutos). Eficaz quando o cluster HDInsight está com ESP (Enterprise Security Package)
typeProperties.scriptLinkedService	LinkedServiceReference	Referência de serviço vinculado de script.
typeProperties.scriptPath	object	Caminho do script. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Referências de serviço vinculado de armazenamento.
typeProperties.variables	object	Argumentos especificados pelo usuário no namespace hivevar.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

HDInsightMapReduceActivity

Tipo de atividade MapReduce do HDInsight.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: HDInsightMapReduce	Tipo de atividade.
typeProperties.arguments	object[]	Argumentos especificados pelo usuário para HDInsightActivity.
typeProperties.className	object	Nome da classe. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.defines	object	Permite que o usuário especifique as definições para a solicitação de trabalho mapReduce.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Opção de informações de depuração.
typeProperties.jarFilePath	object	Caminho jar. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.jarLibs	object[]	Jar libs.
typeProperties.jarLinkedService	LinkedServiceReference	Referência de serviço vinculado jar.
typeProperties.storageLinkedServices	LinkedServiceReference[]	Referências de serviço vinculado de armazenamento.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

HDInsightPigActivity

Tipo de atividade do Pig do HDInsight.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: HDInsightPig	Tipo de atividade.
typeProperties.arguments	object	Argumentos especificados pelo usuário para HDInsightActivity. Tipo: matriz (ou Expressão com matriz resultType).
typeProperties.defines	object	Permite que o usuário especifique as definições para solicitação de trabalho do Pig.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Opção de informações de depuração.
typeProperties.scriptLinkedService	LinkedServiceReference	Referência de serviço vinculado de script.
typeProperties.scriptPath	object	Caminho do script. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Referências de serviço vinculado de armazenamento.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

HDInsightSparkActivity

Atividade do Spark do HDInsight.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: HDInsightSpark	Tipo de atividade.
typeProperties.arguments	object[]	Os argumentos especificados pelo usuário para HDInsightSparkActivity.
typeProperties.className	string	A classe principal java/Spark do aplicativo.
typeProperties.entryFilePath	object	O caminho relativo para a pasta raiz do código/pacote a ser executado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Opção de informações de depuração.
typeProperties.proxyUser	object	O usuário a ser representado que executará o trabalho. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.rootPath	object	O caminho raiz em 'sparkJobLinkedService' para todos os arquivos do trabalho. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.sparkConfig	object	Propriedade de configuração do Spark.
typeProperties.sparkJobLinkedService	LinkedServiceReference	O serviço vinculado de armazenamento para carregar o arquivo de entrada e as dependências e para receber logs.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

HDInsightStreamingActivity

Tipo de atividade de streaming do HDInsight.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: HDInsightStreaming	Tipo de atividade.
typeProperties.arguments	object[]	Argumentos especificados pelo usuário para HDInsightActivity.
typeProperties.combiner	object	Nome executável do combinador. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.commandEnvironment	object[]	Valores de ambiente de linha de comando.
typeProperties.defines	object	Permite que o usuário especifique as definições para solicitação de trabalho de streaming.
typeProperties.fileLinkedService	LinkedServiceReference	Referência de serviço vinculado em que os arquivos estão localizados.
typeProperties.filePaths	object[]	Caminhos para transmitir arquivos de trabalho. Pode ser diretórios.
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	Opção de informações de depuração.
typeProperties.input	object	Caminho do blob de entrada. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.mapper	object	Nome executável do mapeador. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.output	object	Caminho do blob de saída. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.reducer	object	Nome executável do redutor. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.storageLinkedServices	LinkedServiceReference[]	Referências de serviço vinculado de armazenamento.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

IfConditionActivity

Essa atividade avalia uma expressão booliana e executa as atividades na propriedade ifTrueActivities ou na propriedade ifFalseActivities, dependendo do resultado da expressão.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: IfCondition	Tipo de atividade.
typeProperties.expression	Expression	Uma expressão que seria avaliada como booliana. Isso é usado para determinar o bloco de atividades (ifTrueActivities ou ifFalseActivities) que serão executadas.
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[]	Lista de atividades a serem executadas se a expressão for avaliada como false. Essa é uma propriedade opcional e, se não for fornecida, a atividade sairá sem nenhuma ação.
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[]	Lista de atividades a serem executadas se a expressão for avaliada como true. Essa é uma propriedade opcional e, se não for fornecida, a atividade sairá sem nenhuma ação.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

IntegrationRuntimeReference

Tipo de referência de runtime de integração.

Nome	Tipo	Description
parameters	object	Argumentos para o runtime de integração.
referenceName	string	Nome do runtime de integração de referência.
type	enum: IntegrationRuntimeReference	Tipo de runtime de integração.

LinkedServiceReference

Tipo de referência de serviço vinculado.

Nome	Tipo	Description
parameters	object	Argumentos para LinkedService.
referenceName	string	Nome do LinkedService de referência.
type	Type	Tipo de referência de serviço vinculado.

LogLocationSettings

Configurações de local de log.

Nome	Tipo	Description
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado do armazenamento de log.
path	object	O caminho para o armazenamento para armazenar logs detalhados da execução da atividade. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

LogSettings

Configurações de log.

Nome	Tipo	Description
copyActivityLogSettings	CopyActivityLogSettings	Especifica as configurações para o log de atividades de cópia.
enableCopyActivityLog	object	Especifica se o log de atividades de cópia deve ser habilitado. Tipo: booliano (ou Expressão com resultType booleano).
logLocationSettings	LogLocationSettings	Configurações de local de log que o cliente precisa fornecer ao habilitar o log.

LogStorageSettings

(Preterido. Use as configurações de armazenamento de log do LogSettings).

Nome	Tipo	Description
enableReliableLogging	object	Especifica se o registro em log confiável deve ser habilitado. Tipo: booliano (ou Expressão com resultType booleano).
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado do armazenamento de log.
logLevel	object	Obtém ou define o nível de log, suporte: Informações, Aviso. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
path	object	O caminho para o armazenamento para armazenar logs detalhados da execução da atividade. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

LookupActivity

Atividade de pesquisa.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Lookup	Tipo de atividade.
typeProperties.dataset	DatasetReference	Referência do conjunto de dados de atividade de pesquisa.
typeProperties.firstRowOnly	object	Seja para retornar a primeira linha ou todas as linhas. O valor padrão é verdadeiro. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.source	CopySource	Propriedades de origem específicas do conjunto de dados, o mesmo que a origem da atividade de cópia.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

NotebookParameter

Parâmetro de bloco de anotações.

Nome	Tipo	Description
type	NotebookParameterType	Tipo de parâmetro notebook.
value	object	Valor do parâmetro notebook. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

NotebookParameterType

Tipo de parâmetro notebook.

Nome	Tipo	Description
bool	string
float	string
int	string
string	string

NotebookReferenceType

Tipo de referência do notebook do Synapse.

Nome	Tipo	Description
NotebookReference	string

ParameterSpecification

Definição de um único parâmetro para uma entidade.

Nome	Tipo	Description
defaultValue	object	Valor padrão do parâmetro.
type	ParameterType	Tipo de parâmetro.

ParameterType

Tipo de parâmetro.

Nome	Tipo	Description
Array	string
Bool	string
Float	string
Int	string
Object	string
SecureString	string
String	string

PipelineElapsedTimeMetricPolicy

Política de Métrica do ElapsedTime do Pipeline.

Nome	Tipo	Description
duration	object	Valor timeSpan, após o qual uma Métrica de Monitoramento do Azure é acionada.

PipelinePolicy

Política de pipeline.

Nome	Tipo	Description
elapsedTimeMetric	PipelineElapsedTimeMetricPolicy	Política de Métrica do ElapsedTime do Pipeline.

PipelineReference

Tipo de referência de pipeline.

Nome	Tipo	Description
name	string	Nome da referência.
referenceName	string	Nome do pipeline de referência.
type	enum: PipelineReference	Tipo de referência de pipeline.

PipelineResource

Tipo de recurso de pipeline.

Nome	Tipo	Description
etag	string	A etag identifica a alteração no recurso.
id	string	O identificador de recurso.
name	string	O nome do recurso.
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[]	Lista de atividades no pipeline.
properties.annotations	object[]	Lista de marcas que podem ser usadas para descrever o Pipeline.
properties.concurrency	integer	O número máximo de execuções simultâneas para o pipeline.
properties.description	string	A descrição do pipeline.
properties.folder	Folder	A pasta na qual este Pipeline está. Se não for especificado, o Pipeline aparecerá no nível raiz.
properties.parameters	<string,  ParameterSpecification>	Lista de parâmetros para pipeline.
properties.policy	PipelinePolicy	Política de pipeline.
properties.runDimensions	object	Dimensões emitidas pelo Pipeline.
properties.variables	<string,  VariableSpecification>	Lista de variáveis para pipeline.
type	string	O tipo de recurso.

PowerQuerySink

Coletor de consulta de energia.

Nome	Tipo	Description
dataset	DatasetReference	Referência do conjunto de dados.
description	string	Descrição da transformação.
flowlet	DataFlowReference	Referência de flowlet
linkedService	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da transformação.
rejectedDataLinkedService	LinkedServiceReference	Referência de serviço vinculado a dados rejeitados.
schemaLinkedService	LinkedServiceReference	Referência de serviço vinculado de esquema.
script	string	script de coletor.

PowerQuerySinkMapping

Mapeie a consulta de mashup do Power Query para conjuntos de dados do coletor.

Nome	Tipo	Description
dataflowSinks	PowerQuerySink[]	Lista de coletores mapeados para a consulta de mashup do Power Query.
queryName	string	Nome da consulta no documento de mashup do Power Query.

RedirectIncompatibleRowSettings

Redirecionar configurações de linha incompatíveis

Nome	Tipo	Description
linkedServiceName	object	Nome do Armazenamento do Azure, SAS de Armazenamento ou serviço vinculado do Azure Data Lake Store usado para redirecionar linha incompatível. Deve ser especificado se redirectIncompatibleRowSettings for especificado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
path	object	O caminho para armazenar os dados de linha incompatíveis de redirecionamento. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

ScriptActivity

Tipo de atividade de script.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Script	Tipo de atividade.
typeProperties.logSettings	ScriptActivityTypeProperties.LogSettings	Configurações de log da atividade de script.
typeProperties.returnMultistatementResult	object	Habilite a recuperação de conjuntos de resultados de várias instruções SQL e o número de linhas afetadas pela instrução DML. Conector com suporte: SnowflakeV2. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.scriptBlockExecutionTimeout	object	Tempo limite de execução do ScriptBlock. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
typeProperties.scripts	ScriptActivityScriptBlock[]	Matriz de blocos de script. Tipo: matriz.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

ScriptActivityLogDestination

O destino dos logs. Tipo: cadeia de caracteres.

Nome	Tipo	Description
ActivityOutput	string
ExternalStore	string

ScriptActivityParameter

Parâmetros de um bloco de script.

Nome	Tipo	Description
direction	ScriptActivityParameterDirection	A direção do parâmetro.
name	object	O nome do parâmetro. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
size	integer	O tamanho do parâmetro de direção de saída.
type	ScriptActivityParameterType	O tipo do parâmetro.
value	object	O valor do parâmetro. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

ScriptActivityParameterDirection

A direção do parâmetro.

Nome	Tipo	Description
Input	string
InputOutput	string
Output	string

ScriptActivityParameterType

O tipo do parâmetro.

Nome	Tipo	Description
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

Bloco de scripts.

Nome	Tipo	Description
parameters	ScriptActivityParameter[]	Matriz de parâmetros de script. Tipo: matriz.
text	object	O texto da consulta. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	object	O tipo da consulta. Consulte o ScriptType para obter opções válidas. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

ScriptActivityTypeProperties.LogSettings

Configurações de log da atividade de script.

Nome	Tipo	Description
logDestination	ScriptActivityLogDestination	O destino dos logs. Tipo: cadeia de caracteres.
logLocationSettings	LogLocationSettings	Configurações de local de log que o cliente precisa fornecer ao habilitar o log.

SecureInputOutputPolicy

Política de execução para uma atividade que dá suporte a entrada e saída seguras.

Nome	Tipo	Description
secureInput	boolean	Quando definido como true, a entrada da atividade é considerada segura e não será registrada no monitoramento.
secureOutput	boolean	Quando definido como true, a saída da atividade é considerada segura e não será registrada no monitoramento.

SecureString

Definição de cadeia de caracteres segura do Azure Data Factory. O valor da cadeia de caracteres será mascarado com asteriscos '*' durante as chamadas à API Get ou List.

Nome	Tipo	Description
type	string: SecureString	Tipo do segredo.
value	string	Valor da cadeia de caracteres segura.

SetVariableActivity

Defina o valor de uma variável.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	SecureInputOutputPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: SetVariable	Tipo de atividade.
typeProperties.setSystemVariable	boolean	Se definido como true, ele define o valor retornado da execução do pipeline.
typeProperties.value	object	Valor a ser definido. Pode ser um valor estático ou expressão.
typeProperties.variableName	string	Nome da variável cujo valor precisa ser definido.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

SkipErrorFile

Ignorar o arquivo de erro.

Nome	Tipo	Description
dataInconsistency	object	Ignore se o arquivo de origem/coletor foi alterado por outra gravação simultânea. O padrão é false. Tipo: booliano (ou Expressão com resultType booleano).
fileMissing	object	Ignore se o arquivo for excluído por outro cliente durante a cópia. O padrão é verdadeiro. Tipo: booliano (ou Expressão com resultType booleano).

SparkConfigurationParametrizationReference

Referência de configuração do Spark.

Nome	Tipo	Description
referenceName	object	Nome da configuração do Spark de referência. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	SparkConfigurationReferenceType	Tipo de referência de configuração do Spark.

SparkConfigurationReferenceType

Tipo de referência de configuração do Spark.

Nome	Tipo	Description
SparkConfigurationReference	string

SparkJobReferenceType

Tipo de referência de trabalho do Spark do Synapse.

Nome	Tipo	Description
SparkJobDefinitionReference	string

SqlServerStoredProcedureActivity

Tipo de atividade de procedimento armazenado do SQL.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: SqlServerStoredProcedure	Tipo de atividade.
typeProperties.storedProcedureName	object	Nome do procedimento armazenado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.storedProcedureParameters	object	Configuração de valor e tipo para parâmetros de procedimento armazenado. Exemplo: "{Parameter1: {value: "1", type: "int"}}".
userProperties	UserProperty[]	Propriedades do usuário da atividade.

SSISAccessCredential

Credencial de acesso do SSIS.

Nome	Tipo	Description
domain	object	Domínio para autenticação do Windows. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
password	SecretBase: AzureKeyVaultSecretReference SecureString	Senha para autenticação do Windows.
userName	object	UseName para autenticação do Windows. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

SSISChildPackage

Pacote filho inserido do SSIS.

Nome	Tipo	Description
packageContent	object	Conteúdo do pacote filho inserido. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
packageLastModifiedDate	string	Data da última modificação do pacote filho inserido.
packageName	string	Nome do pacote filho inserido.
packagePath	object	Caminho para o pacote filho inserido. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

SSISExecutionCredential

Credencial de execução do pacote SSIS.

Nome	Tipo	Description
domain	object	Domínio para autenticação do Windows. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
password	SecureString	Senha para autenticação do Windows.
userName	object	UseName para autenticação do Windows. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

SSISExecutionParameter

Parâmetro de execução do SSIS.

Nome	Tipo	Description
value	object	Valor do parâmetro de execução do pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

SSISLogLocation

Local do log de execução do pacote SSIS

Nome	Tipo	Description
logPath	object	O caminho do log de execução do pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	SsisLogLocationType	O tipo de local de log do SSIS.
typeProperties.accessCredential	SSISAccessCredential	A credencial de acesso do log de execução do pacote.
typeProperties.logRefreshInterval	object	Especifica o intervalo para atualizar o log. O intervalo padrão é de 5 minutos. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).

SsisLogLocationType

O tipo de local de log do SSIS.

Nome	Tipo	Description
File	string

SSISPackageLocation

Local do pacote SSIS.

Nome	Tipo	Description
packagePath	object	O caminho do pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	SsisPackageLocationType	O tipo de local do pacote SSIS.
typeProperties.accessCredential	SSISAccessCredential	A credencial de acesso do pacote.
typeProperties.childPackages	SSISChildPackage[]	A lista de pacotes filho inseridos.
typeProperties.configurationAccessCredential	SSISAccessCredential	A credencial de acesso ao arquivo de configuração.
typeProperties.configurationPath	object	O arquivo de configuração da execução do pacote. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.packageContent	object	O conteúdo do pacote inserido. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.packageLastModifiedDate	string	A data da última modificação do pacote inserido.
typeProperties.packageName	string	O nome do pacote.
typeProperties.packagePassword	SecretBase: AzureKeyVaultSecretReference SecureString	Senha do pacote.

SsisPackageLocationType

O tipo de local do pacote SSIS.

Nome	Tipo	Description
File	string
InlinePackage	string
PackageStore	string
SSISDB	string

SSISPropertyOverride

Substituição da propriedade SSIS.

Nome	Tipo	Description
isSensitive	boolean	Se o valor de substituição da propriedade do pacote SSIS é dados confidenciais. O valor será criptografado no SSISDB se for verdadeiro
value	object	Valor de substituição da propriedade do pacote SSIS. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

StagingSettings

Configurações de preparo.

Nome	Tipo	Description
enableCompression	object	Especifica se a compactação deve ser usada ao copiar dados por meio de um preparo provisório. O valor padrão é falso. Tipo: booliano (ou Expressão com resultType booleano).
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado de preparo.
path	object	O caminho para o armazenamento para armazenar os dados provisórios. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

SwitchActivity

Essa atividade avalia uma expressão e executa atividades na propriedade cases que correspondem à avaliação de expressão esperada na propriedade equals.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Switch	Tipo de atividade.
typeProperties.cases	SwitchCase[]	Lista de casos que correspondem aos valores esperados da propriedade 'on'. Essa é uma propriedade opcional e, se não for fornecida, a atividade executará atividades fornecidas em 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[]	Lista de atividades a serem executadas se nenhuma condição de caso for atendida. Essa é uma propriedade opcional e, se não for fornecida, a atividade sairá sem nenhuma ação.
typeProperties.on	Expression	Uma expressão que seria avaliada como uma cadeia de caracteres ou inteiro. Isso é usado para determinar o bloco de atividades em casos que serão executados.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

SwitchCase

Alterne casos com um valor e atividades correspondentes.

Nome	Tipo	Description
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[]	Lista de atividades a serem executadas para a condição de caso atendida.
value	string	Valor esperado que satisfaz o resultado da expressão da propriedade 'on'.

SynapseNotebookActivity

Execute a atividade do notebook do Synapse.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: SynapseNotebook	Tipo de atividade.
typeProperties.conf	object	Propriedades de configuração do Spark, que substituirão a 'configuração' do notebook fornecido.
typeProperties.configurationType	ConfigurationType	O tipo da configuração do spark.
typeProperties.driverSize	object	Número de núcleo e memória a serem usados para o driver alocado no pool do Spark especificado para a sessão, que será usado para substituir 'driverCores' e 'driverMemory' do notebook fornecido. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.executorSize	object	Número de núcleo e memória a serem usados para executores alocados no pool do Spark especificado para a sessão, que será usado para substituir 'executorCores' e 'executorMemory' do notebook fornecido. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.notebook	SynapseNotebookReference	Referência do notebook do Synapse.
typeProperties.numExecutors	object	Número de executores a serem iniciados para esta sessão, que substituirá os 'numExecutors' do notebook fornecido. Tipo: inteiro (ou Expressão com inteiro resultType).
typeProperties.parameters	<string,  NotebookParameter>	Parâmetros do notebook.
typeProperties.sparkConfig	object	Propriedade de configuração do Spark.
typeProperties.sparkPool	BigDataPoolParametrizationReference	O nome do pool de Big Data que será usado para executar o notebook.
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	A configuração do spark do trabalho do Spark.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

SynapseNotebookReference

Tipo de referência do notebook do Synapse.

Nome	Tipo	Description
referenceName	object	Nome do bloco de anotações de referência. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	NotebookReferenceType	Tipo de referência do notebook do Synapse.

SynapseSparkJobDefinitionActivity

Execute a atividade de trabalho do Spark.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: SparkJob	Tipo de atividade.
typeProperties.args	SynapseSparkJobActivityTypeProperties.Args[]	Argumentos especificados pelo usuário para SynapseSparkJobDefinitionActivity.
typeProperties.className	object	O identificador totalmente qualificado ou a classe principal que está no arquivo de definição principal, que substituirá o 'className' da definição de trabalho do Spark fornecida. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.conf	object	Propriedades de configuração do Spark, que substituirão a 'configuração' da definição de trabalho do Spark que você fornece.
typeProperties.configurationType	ConfigurationType	O tipo da configuração do spark.
typeProperties.driverSize	object	Número de núcleo e memória a serem usados para o driver alocado no pool do Spark especificado para o trabalho, que será usado para substituir 'driverCores' e 'driverMemory' da definição de trabalho do Spark que você fornece. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.executorSize	object	Número de núcleo e memória a serem usados para executores alocados no pool do Spark especificado para o trabalho, que será usado para substituir 'executorCores' e 'executorMemory' da definição de trabalho do Spark fornecida. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.file	object	O arquivo principal usado para o trabalho, que substituirá o "arquivo" da definição de trabalho do Spark fornecida. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.files	object[]	(Preterido. Use pythonCodeReference e filesV2) Arquivos adicionais usados para referência no arquivo de definição principal, que substituirá os 'arquivos' da definição de trabalho do Spark fornecida.
typeProperties.filesV2	object[]	Arquivos adicionais usados para referência no arquivo de definição principal, que substituirá os 'jars' e os 'arquivos' da definição de trabalho do Spark fornecida.
typeProperties.numExecutors	object	Número de executores a serem iniciados para esse trabalho, que substituirá os 'numExecutors' da definição de trabalho do Spark fornecida. Tipo: inteiro (ou Expressão com inteiro resultType).
typeProperties.pythonCodeReference	object[]	Arquivos de código python adicionais usados para referência no arquivo de definição principal, que substituirá 'pyFiles' da definição de trabalho do Spark fornecida.
typeProperties.scanFolder	object	Verificando subpastas da pasta raiz do arquivo de definição principal, esses arquivos serão adicionados como arquivos de referência. As pastas denominadas 'jars', 'pyFiles', 'files' ou 'archives' serão verificadas e o nome das pastas diferencia maiúsculas de minúsculas. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.sparkConfig	object	Propriedade de configuração do Spark.
typeProperties.sparkJob	SynapseSparkJobReference	Referência de trabalho do Spark do Synapse.
typeProperties.targetBigDataPool	BigDataPoolParametrizationReference	O nome do pool de Big Data que será usado para executar o trabalho em lote do Spark, que substituirá o 'targetBigDataPool' da definição de trabalho do Spark fornecida.
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	A configuração do spark do trabalho do Spark.
userProperties	UserProperty[]	Propriedades do usuário da atividade.

SynapseSparkJobReference

Tipo de referência de trabalho do Spark do Synapse.

Nome	Tipo	Description
referenceName	object	Nome do trabalho do Spark de referência. Expressão com cadeia de caracteres resultType.
type	SparkJobReferenceType	Tipo de referência de trabalho do Spark do Synapse.

Type

Tipo de referência de serviço vinculado.

Nome	Tipo	Description
LinkedServiceReference	string

UntilActivity

Essa atividade executa atividades internas até que os resultados da expressão booliana especificados sejam atingidos como true ou tempo limite, o que for anterior.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Until	Tipo de atividade.
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[]	Lista de atividades a serem executadas.
typeProperties.expression	Expression	Uma expressão que seria avaliada como booliana. O loop continuará até que essa expressão seja avaliada como true
typeProperties.timeout	object	Especifica o tempo limite para a atividade a ser executada. Se não houver nenhum valor especificado, ele usará o valor de TimeSpan.FromDays(7), que é de 1 semana como padrão. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

UserProperty

Propriedade do usuário.

Nome	Tipo	Description
name	string	Nome da propriedade do usuário.
value	object	Valor da propriedade do usuário. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

ValidationActivity

Essa atividade verifica se existe um recurso externo.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Validation	Tipo de atividade.
typeProperties.childItems	object	Pode ser usado se o conjunto de dados apontar para uma pasta. Se definido como true, a pasta deverá ter pelo menos um arquivo. Se definido como false, a pasta deverá estar vazia. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.dataset	DatasetReference	Referência do conjunto de dados da atividade de validação.
typeProperties.minimumSize	object	Pode ser usado se o conjunto de dados apontar para um arquivo. O arquivo deve ser maior ou igual ao valor especificado. Tipo: inteiro (ou Expressão com inteiro resultType).
typeProperties.sleep	object	Um atraso em segundos entre as tentativas de validação. Se nenhum valor for especificado, 10 segundos serão usados como o padrão. Tipo: inteiro (ou Expressão com inteiro resultType).
typeProperties.timeout	object	Especifica o tempo limite para a atividade a ser executada. Se não houver nenhum valor especificado, ele usará o valor de TimeSpan.FromDays(7), que é de 1 semana como padrão. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType), padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

VariableSpecification

Definição de uma única variável para um Pipeline.

Nome	Tipo	Description
defaultValue	object	Valor padrão da variável.
type	VariableType	Tipo de variável.

VariableType

Tipo de variável.

Nome	Tipo	Description
Array	string
Bool	string
String	string

WaitActivity

Essa atividade suspende a execução do pipeline para o intervalo especificado.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: Wait	Tipo de atividade.
typeProperties.waitTimeInSeconds	object	Duração em segundos. Tipo: inteiro (ou Expressão com inteiro resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

WebActivity

Atividade da Web.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
linkedServiceName	LinkedServiceReference	Referência de serviço vinculado.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	ActivityPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: WebActivity	Tipo de atividade.
typeProperties.authentication	WebActivityAuthentication	Método de autenticação usado para chamar o ponto de extremidade.
typeProperties.body	object	Representa o conteúdo que será enviado para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.connectVia	IntegrationRuntimeReference	A referência de runtime de integração.
typeProperties.datasets	DatasetReference[]	Lista de conjuntos de dados passados para o ponto de extremidade da Web.
typeProperties.disableCertValidation	boolean	Quando definido como true, a validação do certificado será desabilitada.
typeProperties.headers	object	Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e o tipo em uma solicitação: "cabeçalhos" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.httpRequestTimeout	object	Tempo limite para a solicitação HTTP obter uma resposta. O formato está em TimeSpan (hh:mm:ss). Esse valor é o tempo limite para obter uma resposta, não o tempo limite da atividade. O valor padrão é 00:01:00 (1 minuto). O intervalo é de 1 a 10 minutos
typeProperties.linkedServices	LinkedServiceReference[]	Lista de serviços vinculados passados para o ponto de extremidade da Web.
typeProperties.method	WebActivityMethod	Método de API Rest para o ponto de extremidade de destino.
typeProperties.turnOffAsync	boolean	Opção para desabilitar a invocação de HTTP GET no local dado no cabeçalho de resposta de uma resposta HTTP 202. Se definido como true, ele para de invocar HTTP GET no local http dado no cabeçalho de resposta. Se definido false, continua a invocar a chamada HTTP GET no local dado em cabeçalhos de resposta http.
typeProperties.url	object	Ponto de extremidade e caminho de destino da atividade da Web. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

WebActivityAuthentication

Propriedades de autenticação de atividade da Web.

Nome	Tipo	Description
credential	CredentialReference	A referência de credencial que contém informações de autenticação.
password	SecretBase: AzureKeyVaultSecretReference SecureString	Senha para o arquivo PFX ou autenticação/segredo básico quando usada para ServicePrincipal
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	Conteúdo codificado em Base64 de um arquivo PFX ou certificado quando usado para ServicePrincipal
resource	object	Recurso para o qual o token de autenticação do Azure será solicitado ao usar a Autenticação MSI. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	string	Autenticação de atividade da Web (Basic/ClientCertificate/MSI/ServicePrincipal)
userTenant	object	TenantId para o qual o token do Azure Auth será solicitado ao usar a Autenticação ServicePrincipal. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
username	object	Nome de usuário de autenticação de atividade da Web para autenticação básica ou ClientID quando usado para ServicePrincipal. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

WebActivityMethod

A lista de métodos HTTP com suporte por uma WebActivity.

Nome	Tipo	Description
DELETE	string
GET	string
POST	string
PUT	string

WebHookActivity

Atividade do WebHook.

Nome	Tipo	Description
dependsOn	ActivityDependency[]	A atividade depende da condição.
description	string	Descrição da atividade.
name	string	Nome da atividade.
onInactiveMarkAs	ActivityOnInactiveMarkAs	Resultado do status da atividade quando o estado é definido como Inativo. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será bem-sucedido por padrão.
policy	SecureInputOutputPolicy	Política de atividade.
state	ActivityState	Estado da atividade. Essa é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
type	string: WebHook	Tipo de atividade.
typeProperties.authentication	WebActivityAuthentication	Método de autenticação usado para chamar o ponto de extremidade.
typeProperties.body	object	Representa o conteúdo que será enviado para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.headers	object	Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e o tipo em uma solicitação: "cabeçalhos" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
typeProperties.method	WebHookActivityMethod	Método de API Rest para o ponto de extremidade de destino.
typeProperties.reportStatusOnCallBack	object	Quando definido como true, statusCode, saída e erro no corpo da solicitação de retorno de chamada serão consumidos pela atividade. A atividade pode ser marcada como falha ao definir o statusCode >= 400 na solicitação de retorno de chamada. O padrão é false. Tipo: booliano (ou Expressão com resultType booleano).
typeProperties.timeout	string	O tempo limite no qual o webhook deve ser chamado de volta. Se não houver nenhum valor especificado, o padrão será 10 minutos. Tipo: cadeia de caracteres. Padrão: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
typeProperties.url	object	Caminho e ponto de extremidade de atividade do WebHook. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
userProperties	UserProperty[]	Propriedades do usuário da atividade.

WebHookActivityMethod

A lista de métodos HTTP com suporte por uma atividade do WebHook.

Nome	Tipo	Description
POST	string