Pipelines - Create Or Update

Service:

Data Factory

API Version:

2018-06-01

パイプラインを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
factoryName	path	True	string	ファクトリ名。 Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
pipelineName	path	True	string	パイプライン名。 Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
resourceGroupName	path	True	string	リソース グループ名。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	サブスクリプションの識別子です。
api-version	query	True	string	API のバージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	パイプライン エンティティの ETag。 更新に対してのみ指定する必要があります。この更新は既存のエンティティと一致する必要があります。また、無条件更新の場合は * にすることができます。

要求本文

名前	型	説明
properties.activities	Activity[]: ControlActivity[] ExecutionActivity[] ExecuteWranglingDataflowActivity[] CopyActivity[] HDInsightHiveActivity[] HDInsightPigActivity[] HDInsightMapReduceActivity[] HDInsightStreamingActivity[] HDInsightSparkActivity[] ExecuteSSISPackageActivity[] CustomActivity[] SqlServerStoredProcedureActivity[] DeleteActivity[] AzureDataExplorerCommandActivity[] LookupActivity[] WebActivity[] GetMetadataActivity[] AzureMLBatchExecutionActivity[] AzureMLUpdateResourceActivity[] AzureMLExecutePipelineActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] AzureFunctionActivity[] ExecuteDataFlowActivity[] ScriptActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] ExecutePipelineActivity[] IfConditionActivity[] SwitchActivity[] ForEachActivity[] WaitActivity[] FailActivity[] UntilActivity[] ValidationActivity[] FilterActivity[] SetVariableActivity[] AppendVariableActivity[] WebHookActivity[]	パイプライン内のアクティビティの一覧。
properties.annotations	object[]	パイプラインの記述に使用できるタグの一覧。
properties.concurrency	integer	パイプラインの同時実行の最大数。
properties.description	string	パイプラインの説明。
properties.folder	Folder	このパイプラインが存在するフォルダー。 指定しない場合、パイプラインはルート レベルで表示されます。
properties.parameters	<string,  ParameterSpecification>	パイプラインのパラメーターの一覧。
properties.policy	PipelinePolicy	パイプライン ポリシー。
properties.runDimensions	object	パイプラインによって出力されるディメンション。
properties.variables	<string,  VariableSpecification>	パイプラインの変数の一覧。

応答

名前	型	説明
200 OK	PipelineResource	OK です。
Other Status Codes	CloudError	Azure Data Factory サービスから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Pipelines_Create

Pipelines_Update

Pipelines_Create

Sample Request

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/01a71545e82bb98b8137d3038150c436d46a59ed/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 System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;

// 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 DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
DataFactoryPipelineData data = new DataFactoryPipelineData()
{
    Activities =
    {
    new ForEachActivity("ExampleForeachActivity",new DataFactoryExpression(DataFactoryExpressionType.Expression,"@pipeline().parameters.OutputBlobNameList"),new PipelineActivity[]
    {
    new CopyActivity("ExampleCopyActivity",new DataFactoryBlobSource(),new DataFactoryBlobSink())
    {
    Inputs =
    {
    new DatasetReference(DatasetReferenceType.DatasetReference,"exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.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 dataFactoryPipeline.UpdateAsync(WaitUntil.Completed, data);
DataFactoryPipelineResource result = lro.Value;

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

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

Sample Response

Status code:

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

Response Body

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

Sample Request

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/01a71545e82bb98b8137d3038150c436d46a59ed/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 System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;

// 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 DataFactoryPipelineResource created on azure
// for more information of creating DataFactoryPipelineResource, please refer to the document of DataFactoryPipelineResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string pipelineName = "examplePipeline";
ResourceIdentifier dataFactoryPipelineResourceId = DataFactoryPipelineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, pipelineName);
DataFactoryPipelineResource dataFactoryPipeline = client.GetDataFactoryPipelineResource(dataFactoryPipelineResourceId);

// invoke the operation
DataFactoryPipelineData data = new DataFactoryPipelineData()
{
    Description = "Example description",
    Activities =
    {
    new ForEachActivity("ExampleForeachActivity",new DataFactoryExpression(DataFactoryExpressionType.Expression,"@pipeline().parameters.OutputBlobNameList"),new PipelineActivity[]
    {
    new CopyActivity("ExampleCopyActivity",new DataFactoryBlobSource(),new DataFactoryBlobSink())
    {
    Inputs =
    {
    new DatasetReference(DatasetReferenceType.DatasetReference,"exampleDataset")
    {
    Parameters =
    {
    ["MyFileName"] = BinaryData.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 dataFactoryPipeline.UpdateAsync(WaitUntil.Completed, data);
DataFactoryPipelineResource result = lro.Value;

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

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

Sample Response

Status code:

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

Response Body

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

定義

名前	説明
ActivityDependency	アクティビティの依存関係情報。
ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
ActivityPolicy	アクティビティの実行ポリシー。
ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
AppendVariableActivity	配列型の変数の値を追加します。
AzureDataExplorerCommandActivity	Azure Data Explorer のコマンド アクティビティ。
AzureFunctionActivity	Azure 関数アクティビティ。
AzureFunctionActivityMethod	AzureFunctionActivity でサポートされている HTTP メソッドの一覧。
AzureKeyVaultSecretReference	Azure Key Vault シークレット リファレンス。
AzureMLBatchExecutionActivity	Azure ML バッチ実行アクティビティ。
AzureMLExecutePipelineActivity	Azure ML のパイプライン実行アクティビティ。
AzureMLUpdateResourceActivity	Azure ML Update リソース管理アクティビティ。
AzureMLWebServiceFile	Azure ML WebService 入出力ファイル
BigDataPoolParametrizationReference	ビッグ データ プールの参照型。
BigDataPoolReferenceType	ビッグ データ プール参照の種類。
CloudError	Azure Data Factoryエラー応答の構造を定義する オブジェクト。
Compute	データ フロー アクティビティのコンピューティング プロパティ。
ConfigurationType	Spark 構成の種類。
ControlActivity	IfCondition、ForEach、Until などのすべてのコントロール アクティビティの基本クラス。
CopyActivity	コピー アクティビティ。
CopyActivityLogSettings	コピー アクティビティ ログの設定。
CredentialReference	資格情報参照の種類。
CredentialReferenceType	資格情報参照の種類。
CustomActivity	カスタム アクティビティの種類。
CustomActivityReferenceObject	カスタム アクティビティの参照オブジェクト
DatabricksNotebookActivity	DatabricksNotebook アクティビティ。
DatabricksSparkJarActivity	DatabricksSparkJar アクティビティ。
DatabricksSparkPythonActivity	DatabricksSparkPython アクティビティ。
DataFlowReference	データ フロー参照型。
DataFlowReferenceType	データ フロー参照の種類。
DataFlowStagingInfo	データ フローの実行アクティビティのステージング情報。
DataLakeAnalyticsUSQLActivity	U-SQL アクティビティをData Lake Analyticsします。
DatasetReference	データセット参照型。
DeleteActivity	アクティビティを削除します。
DependencyCondition	依存関係の Match-Condition。
ExecuteDataFlowActivity	データ フロー アクティビティを実行します。
ExecutePipelineActivity	パイプラインの実行アクティビティ。
ExecutePipelineActivityPolicy	実行パイプライン アクティビティの実行ポリシー。
ExecuteSSISPackageActivity	SSIS パッケージ アクティビティを実行します。
ExecuteWranglingDataflowActivity	電源クエリ アクティビティを実行します。
ExecutionActivity	すべての実行アクティビティの基本クラス。
Expression	式定義をAzure Data Factoryします。
FailActivity	このアクティビティは、独自のスコープ内で失敗し、カスタム エラー メッセージとエラー コードを出力します。 エラー メッセージとコードは、文字列リテラルとして、または実行時に文字列に評価できる式として指定できます。 失敗アクティビティが含まれている場合、アクティビティ スコープはパイプライン全体または制御アクティビティ (foreach、switch、until など) にすることができます。
FilterActivity	条件に基づいて入力配列から結果をフィルター処理して返します。
Folder	このパイプラインが存在するフォルダー。 指定しない場合、パイプラインはルート レベルで表示されます。
ForEachActivity	このアクティビティは、コレクションを反復処理し、特定のアクティビティを実行するために使用されます。
GetMetadataActivity	データセットのメタデータを取得するアクティビティ
HDInsightActivityDebugInfoOption	使用する HDInsightActivityDebugInfoOption 設定。
HDInsightHiveActivity	HDInsight Hive アクティビティの種類。
HDInsightMapReduceActivity	HDInsight MapReduce アクティビティの種類。
HDInsightPigActivity	HDInsight Pig アクティビティの種類。
HDInsightSparkActivity	HDInsight Spark アクティビティ。
HDInsightStreamingActivity	HDInsight ストリーミング アクティビティの種類。
IfConditionActivity	このアクティビティはブール式を評価し、式の結果に応じて、ifTrueActivities プロパティまたは ifFalseActivities プロパティのアクティビティを実行します。
IntegrationRuntimeReference	統合ランタイム参照型。
LinkedServiceReference	リンクされたサービス参照の種類。
LogLocationSettings	ログの場所の設定。
LogSettings	ログ設定。
LogStorageSettings	(非推奨。LogSettings) ログ ストレージ設定を使用してください。
LookupActivity	ルックアップ アクティビティ。
NotebookParameter	Notebook パラメーター。
NotebookParameterType	ノートブック パラメーターの種類。
NotebookReferenceType	Synapse ノートブック参照の種類。
ParameterSpecification	エンティティの 1 つのパラメーターの定義。
ParameterType	パラメーターの型。
PipelineElapsedTimeMetricPolicy	パイプラインの ElapsedTime メトリック ポリシー。
PipelinePolicy	パイプライン ポリシー。
PipelineReference	パイプライン参照型。
PipelineResource	パイプライン リソースの種類。
PowerQuerySink	Power Query シンク。
PowerQuerySinkMapping	Power Queryマッシュアップ クエリをシンク データセットにマップします。
RedirectIncompatibleRowSettings	互換性のない行設定をリダイレクトする
ScriptActivity	スクリプト アクティビティの種類。
ScriptActivityLogDestination	ログの宛先。 型: string。
ScriptActivityParameter	スクリプト ブロックのパラメーター。
ScriptActivityParameterDirection	パラメーターの方向。
ScriptActivityParameterType	パラメーターの型。
ScriptActivityScriptBlock	スクリプトのスクリプト ブロック。
ScriptActivityTypeProperties.LogSettings	スクリプト アクティビティのログ設定。
ScriptType	クエリの型。 型: string。
SecureInputOutputPolicy	セキュリティで保護された入力と出力をサポートするアクティビティの実行ポリシー。
SecureString	セキュリティで保護された文字列定義をAzure Data Factoryします。 文字列値は、Get または List API の呼び出し中にアスタリスク '*' でマスクされます。
SetVariableActivity	変数の値を設定します。
SkipErrorFile	エラー ファイルをスキップします。
SparkConfigurationParametrizationReference	Spark 構成リファレンス。
SparkConfigurationReferenceType	Spark 構成参照の種類。
SparkJobReferenceType	Synapse Spark ジョブ参照の種類。
SqlServerStoredProcedureActivity	SQL ストアド プロシージャのアクティビティの種類。
SSISAccessCredential	SSIS アクセス資格情報。
SSISChildPackage	SSIS 埋め込み子パッケージ。
SSISExecutionCredential	SSIS パッケージの実行資格情報。
SSISExecutionParameter	SSIS 実行パラメーター。
SSISLogLocation	SSIS パッケージの実行ログの場所
SsisLogLocationType	SSIS ログの場所の種類。
SSISPackageLocation	SSIS パッケージの場所。
SsisPackageLocationType	SSIS パッケージの場所の種類。
SSISPropertyOverride	SSIS プロパティのオーバーライド。
StagingSettings	ステージング設定。
SwitchActivity	このアクティビティは式を評価し、equals プロパティで想定される式の評価に対応する cases プロパティでアクティビティを実行します。
SwitchCase	を持つスイッチ ケースには、値と対応するアクティビティがあります。
SynapseNotebookActivity	Synapse ノートブック アクティビティを実行します。
SynapseNotebookReference	Synapse ノートブックの参照型。
SynapseSparkJobDefinitionActivity	Spark ジョブ アクティビティを実行します。
SynapseSparkJobReference	Synapse Spark ジョブ参照の種類。
Type	リンクされたサービス参照の種類。
UntilActivity	このアクティビティは、指定されたブール式の結果が true またはタイムアウトになるまで、どちらか早い方に達するまで、内部アクティビティを実行します。
UserProperty	User プロパティ。
ValidationActivity	このアクティビティは、外部リソースが存在することを確認します。
VariableSpecification	パイプラインの 1 つの変数の定義。
VariableType	変数の型。
WaitActivity	このアクティビティは、指定された間隔でパイプラインの実行を中断します。
WebActivity	Web アクティビティ。
WebActivityAuthentication	Web アクティビティの認証プロパティ。
WebActivityMethod	WebActivity でサポートされている HTTP メソッドの一覧。
WebHookActivity	WebHook アクティビティ。
WebHookActivityMethod	WebHook アクティビティでサポートされる HTTP メソッドの一覧。

ActivityDependency

アクティビティの依存関係情報。

名前	型	説明
activity	string	アクティビティ名。
dependencyConditions	DependencyCondition[]	依存関係の Match-Condition。

ActivityOnInactiveMarkAs

状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。

名前	型	説明
Failed	string
Skipped	string
Succeeded	string

ActivityPolicy

アクティビティの実行ポリシー。

名前	型	説明
retry	object	通常の再試行の最大数。 既定値は 0 です。 型: integer (または resultType 整数を持つ式)、最小値: 0。
retryIntervalInSeconds	integer	再試行の間隔 (秒単位)。 既定値は 30 秒です。
secureInput	boolean	true に設定すると、アクティビティからの入力はセキュリティで保護されたと見なされ、監視に記録されません。
secureOutput	boolean	true に設定すると、アクティビティからの出力はセキュリティで保護されたと見なされ、監視に記録されません。
timeout	object	アクティビティの実行に関するタイムアウトを指定します。 既定のタイムアウトは 7 日間です。 型: string (または resultType 文字列を含む式)、pattern: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).

ActivityState

アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。

名前	型	説明
Active	string
Inactive	string

AppendVariableActivity

配列型の変数の値を追加します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: AppendVariable	アクティビティの種類。
typeProperties.value	object	追加する値。 型: 変数項目の静的値一致型、または変数項目の resultType 一致型を持つ式を指定できます。
typeProperties.variableName	string	値を追加する必要がある変数の名前。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureDataExplorerCommandActivity

Azure Data Explorer のコマンド アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: AzureDataExplorerCommand	アクティビティの種類。
typeProperties.command	object	Azure Data Explorer コマンド構文に従った制御コマンド。 型: string (または resultType 文字列を含む式)。
typeProperties.commandTimeout	object	コマンドのタイムアウトを制御します。 型: string (または resultType 文字列を含む式)、pattern: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9]))..)
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureFunctionActivity

Azure 関数アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: AzureFunctionActivity	アクティビティの種類。
typeProperties.body	object	エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドに必要です。GET メソッドの Type: string (または ResultType 文字列を含む式) には使用できません。
typeProperties.functionName	object	Azure 関数アクティビティが呼び出す関数の名前。 型: string (または resultType 文字列を含む式)
typeProperties.headers	object	要求に送信されるヘッダーを表します。 たとえば、要求に種類と言語を設定する場合: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。
typeProperties.method	AzureFunctionActivityMethod	ターゲット エンドポイントの REST API メソッド。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureFunctionActivityMethod

AzureFunctionActivity でサポートされている HTTP メソッドの一覧。

名前	型	説明
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

AzureKeyVaultSecretReference

Azure Key Vault シークレット リファレンス。

名前	型	説明
secretName	object	Azure Key Vault内のシークレットの名前。 型: string (または resultType 文字列を含む式)。
secretVersion	object	Azure Key Vault内のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。
store	LinkedServiceReference	Azure Key Vaultリンクされたサービス リファレンス。
type	string: AzureKeyVaultSecret	シークレットの種類。

AzureMLBatchExecutionActivity

Azure ML バッチ実行アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: AzureMLBatchExecution	アクティビティの種類。
typeProperties.globalParameters	object	Azure ML Batch Execution Service エンドポイントに渡されるキー、値のペア。 キーは、公開済みの Azure ML Web サービスで定義されている、Web サービスのパラメーターの名前と一致する必要があります。 値は、Azure ML バッチ実行要求の GlobalParameters プロパティで渡されます。
typeProperties.webServiceInputs	<string,  AzureMLWebServiceFile>	キー、値のペア。入力 BLOB の場所を指定する Azure ML エンドポイントの Web サービス入力の名前を AzureMLWebServiceFile オブジェクトにマッピングします。 この情報は、Azure ML バッチ実行要求の WebServiceInputs プロパティで渡されます。
typeProperties.webServiceOutputs	<string,  AzureMLWebServiceFile>	キー、値のペア。Azure ML エンドポイントの Web サービス出力の名前を、出力 BLOB の場所を指定する AzureMLWebServiceFile オブジェクトにマッピングします。 この情報は、Azure ML バッチ実行要求の WebServiceOutputs プロパティで渡されます。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureMLExecutePipelineActivity

Azure ML のパイプライン実行アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: AzureMLExecutePipeline	アクティビティの種類。
typeProperties.continueOnStepFailure	object	あるステップが失敗した場合に、PipelineRun 内の別のステップの実行を続行するかどうか。 この情報は、発行されたパイプライン実行要求の continueOnStepFailure プロパティで渡されます。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.dataPathAssignments	object	再トレーニングなしでデータ パスの割り当てを変更するために使用されるディクショナリ。 値は、発行されたパイプライン実行要求の dataPathAssignments プロパティで渡されます。 型: object (または resultType オブジェクトを含む Expression)。
typeProperties.experimentName	object	パイプライン実行の実行履歴実験名。 この情報は、発行されたパイプライン実行要求の ExperimentName プロパティに渡されます。 型: string (または resultType 文字列を含む式)。
typeProperties.mlParentRunId	object	親 Azure ML サービス パイプラインの実行 ID。この情報は、発行されたパイプライン実行要求の ParentRunId プロパティで渡されます。 型: string (または resultType 文字列を含む式)。
typeProperties.mlPipelineEndpointId	object	発行された Azure ML パイプライン エンドポイントの ID。 型: string (または resultType 文字列を含む式)。
typeProperties.mlPipelineId	object	発行された Azure ML パイプラインの ID。 型: string (または resultType 文字列を含む式)。
typeProperties.mlPipelineParameters	object	発行された Azure ML パイプライン エンドポイントに渡されるキー、値のペア。 キーは、発行されたパイプラインで定義されているパイプライン パラメーターの名前と一致する必要があります。 値は、発行されたパイプライン実行要求の ParameterAssignments プロパティで渡されます。 型: キーと値のペアを持つオブジェクト (または ResultType オブジェクトを持つ式)。
typeProperties.version	object	発行された Azure ML パイプライン エンドポイントのバージョン。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureMLUpdateResourceActivity

Azure ML Update リソース管理アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: AzureMLUpdateResource	アクティビティの種類。
typeProperties.trainedModelFilePath	object	更新操作によってアップロードされる .ilearner ファイルを表す trainedModelLinkedService の相対ファイル パス。 型: string (または resultType 文字列を含む式)。
typeProperties.trainedModelLinkedServiceName	LinkedServiceReference	更新操作によってアップロードされる .ilearner ファイルを保持する Azure Storage のリンクされたサービスの名前。
typeProperties.trainedModelName	object	更新する Web サービス実験のトレーニング済みモデル モジュールの名前。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

AzureMLWebServiceFile

Azure ML WebService 入出力ファイル

名前	型	説明
filePath	object	LinkedService で指定されたAzure Blob Storage内のコンテナー名を含む相対ファイル パス。 型: string (または resultType 文字列を含む式)。
linkedServiceName	LinkedServiceReference	Azure ML WebService 入出力ファイルがある Azure Storage LinkedService への参照。

BigDataPoolParametrizationReference

ビッグ データ プールの参照型。

名前	型	説明
referenceName	object	ビッグ データ プール名を参照します。 型: string (または resultType 文字列を含む式)。
type	BigDataPoolReferenceType	ビッグ データ プールの参照型。

BigDataPoolReferenceType

ビッグ データ プール参照の種類。

名前	型	説明
BigDataPoolReference	string

CloudError

Azure Data Factoryエラー応答の構造を定義する オブジェクト。

名前	型	説明
error.code	string	エラー コード。
error.details	CloudError[]	追加のエラーの詳細を含む配列。
error.message	string	エラー メッセージ。
error.target	string	エラーに関連付けられている要求のプロパティ名/パス。

Compute

データ フロー アクティビティのコンピューティング プロパティ。

名前	型	説明
computeType	object	データ フロー ジョブを実行するクラスターのコンピューティングの種類。 使用できる値は、'General'、'MemoryOptimized'、'ComputeOptimized' です。 型: string (または resultType 文字列を含む式)
coreCount	object	データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 型: integer (または resultType 整数を持つ式)

ConfigurationType

Spark 構成の種類。

名前	型	説明
Artifact	string
Customized	string
Default	string

ControlActivity

IfCondition、ForEach、Until などのすべてのコントロール アクティビティの基本クラス。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Container	アクティビティの種類。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

CopyActivity

コピー アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
inputs	DatasetReference[]	アクティビティの入力の一覧。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
outputs	DatasetReference[]	アクティビティの出力の一覧。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Copy	アクティビティの種類。
typeProperties.dataIntegrationUnits	object	このデータ移動の実行に使用できるデータ統合ユニットの最大数。 型: integer (または resultType 整数を持つ式)、最小値: 0。
typeProperties.enableSkipIncompatibleRow	object	互換性のない行をスキップするかどうか。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.enableStaging	object	中間ステージングを使用してデータをコピーするかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.logSettings	LogSettings	ログを有効にする際に、お客様が必要とするログ設定が提供されます。
typeProperties.logStorageSettings	LogStorageSettings	(非推奨。LogSettings) セッション ログを有効にする際に、お客様が指定する必要があるログ ストレージ設定を使用してください。
typeProperties.parallelCopies	object	データ ストアのオーバーロードを回避するために、ソースまたはシンクで開かれた同時セッションの最大数。 型: integer (または resultType 整数を持つ式)、最小値: 0。
typeProperties.preserve	object[]	ルールを保持します。
typeProperties.preserveRules	object[]	ルールを保持します。
typeProperties.redirectIncompatibleRowSettings	RedirectIncompatibleRowSettings	EnableSkipIncompatibleRow が true の場合に、互換性のない行設定をリダイレクトします。
typeProperties.sink	CopySink	シンクCopy アクティビティします。
typeProperties.skipErrorFile	SkipErrorFile	データ整合性のフォールト トレランスを指定します。
typeProperties.source	CopySource	ソースCopy アクティビティ。
typeProperties.stagingSettings	StagingSettings	EnableStaging が true の場合の中間ステージング設定を指定します。
typeProperties.translator	object	Copy アクティビティ translator。 指定しない場合は、表形式変換プログラムが使用されます。
typeProperties.validateDataConsistency	object	データ整合性の検証を有効にするかどうか。 型: boolean (または resultType ブール値を持つ式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

CopyActivityLogSettings

コピー アクティビティ ログの設定。

名前	型	説明
enableReliableLogging	object	信頼できるログ記録を有効にするかどうかを指定します。 型: boolean (または resultType ブール値を持つ式)。
logLevel	object	ログ レベル、サポート: Info、Warning を取得または設定します。 型: string (または resultType 文字列を含む式)。

CredentialReference

資格情報参照の種類。

名前	型	説明
referenceName	string	参照資格情報の名前。
type	CredentialReferenceType	資格情報参照の種類。

CredentialReferenceType

資格情報参照の種類。

名前	型	説明
CredentialReference	string

CustomActivity

カスタム アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Custom	アクティビティの種類。
typeProperties.autoUserSpecification	object	ユーザーの昇格レベルとスコープ。既定値は nonadmin タスクです。 型: string (または resultType double を持つ式)。
typeProperties.command	object	カスタム アクティビティの種類のコマンド: string (または resultType 文字列を含む式)。
typeProperties.extendedProperties	object	ユーザー定義のプロパティ バッグ。 使用できるキーまたは値に制限はありません。 ユーザーが指定したカスタム アクティビティには、定義されたコンテンツを使用して解釈する責任があります。
typeProperties.folderPath	object	リソース ファイルのフォルダー パス 種類: string (または resultType 文字列を含む式)。
typeProperties.referenceObjects	CustomActivityReferenceObject	参照オブジェクト
typeProperties.resourceLinkedService	LinkedServiceReference	リソースにリンクされたサービス 参照。
typeProperties.retentionTimeInDays	object	カスタム アクティビティ用に送信するファイルのリテンション期間。 型: double (または resultType double を持つ式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

CustomActivityReferenceObject

カスタム アクティビティの参照オブジェクト

名前	型	説明
datasets	DatasetReference[]	データセット参照。
linkedServices	LinkedServiceReference[]	リンクされたサービス参照。

DatabricksNotebookActivity

DatabricksNotebook アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: DatabricksNotebook	アクティビティの種類。
typeProperties.baseParameters	object	このジョブの実行ごとに使用される基本パラメーター。ノートブックが指定されていないパラメーターを受け取る場合は、ノートブックの既定値が使用されます。
typeProperties.libraries	object[]	ジョブを実行するクラスターにインストールされるライブラリのリスト。
typeProperties.notebookPath	object	Databricks ワークスペースで実行するノートブックの絶対パスです。 このパスはスラッシュで始まる必要があります。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

DatabricksSparkJarActivity

DatabricksSparkJar アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: DatabricksSparkJar	アクティビティの種類。
typeProperties.libraries	object[]	ジョブを実行するクラスターにインストールされるライブラリのリスト。
typeProperties.mainClassName	object	実行される main メソッドを含むクラスのフル ネーム。 このクラスは、ライブラリとして提供される JAR に含まれている必要があります。 型: string (または resultType 文字列を含む式)。
typeProperties.parameters	object[]	main メソッドに渡されるパラメーター。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

DatabricksSparkPythonActivity

DatabricksSparkPython アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: DatabricksSparkPython	アクティビティの種類。
typeProperties.libraries	object[]	ジョブを実行するクラスターにインストールされるライブラリのリスト。
typeProperties.parameters	object[]	Python ファイルに渡されるコマンド ライン パラメーター。
typeProperties.pythonFile	object	実行される Python ファイルの URI。 DBFS パスがサポートされています。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

DataFlowReference

データ フロー参照型。

名前	型	説明
datasetParameters	object	データセットからデータ フロー パラメーターを参照します。
parameters	object	データ フローのパラメーター
referenceName	string	参照データ フロー名。
type	DataFlowReferenceType	データ フロー参照型。

DataFlowReferenceType

データ フロー参照の種類。

名前	型	説明
DataFlowReference	string

DataFlowStagingInfo

データ フローの実行アクティビティのステージング情報。

名前	型	説明
folderPath	object	ステージング BLOB のフォルダー パス。 型: string (または resultType 文字列を含む式)
linkedService	LinkedServiceReference	ステージングリンクされたサービスリファレンス。

DataLakeAnalyticsUSQLActivity

U-SQL アクティビティをData Lake Analyticsします。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: DataLakeAnalyticsU-SQL	アクティビティの種類。
typeProperties.compilationMode	object	U-SQL のコンパイル モード。 Semantic、Full、SingleBox のいずれかの値を指定する必要があります。 型: string (または resultType 文字列を含む式)。
typeProperties.degreeOfParallelism	object	ジョブを実行するために同時に使用される最大ノード数。 既定値は 1 です。 型: integer (または resultType 整数を含む式)、最小: 1。
typeProperties.parameters	object	U-SQL ジョブ要求のパラメーター。
typeProperties.priority	object	キューされているすべてのジョブのうち、先に実行するジョブを決定します。 数値が小さいほど、優先度は高くなります。 既定値は 1,000 です。 型: integer (または resultType 整数を含む式)、最小: 1。
typeProperties.runtimeVersion	object	使用する U-SQL エンジンのランタイム バージョン。 型: string (または resultType 文字列を含む式)。
typeProperties.scriptLinkedService	LinkedServiceReference	リンクされたサービス 参照をスクリプト化します。
typeProperties.scriptPath	object	U-SQL スクリプトを含むフォルダーへの大文字と小文字を区別するパス。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

DatasetReference

データセット参照型。

名前	型	説明
parameters	object	データセットの引数。
referenceName	string	参照データセット名。
type	enum: DatasetReference	データセット参照型。

DeleteActivity

アクティビティを削除します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Delete	アクティビティの種類。
typeProperties.dataset	DatasetReference	アクティビティ データセットの参照を削除します。
typeProperties.enableLogging	object	delete-activity 実行の詳細なログを記録するかどうか。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.logStorageSettings	LogStorageSettings	ログ ストレージ設定は、ログ記録が true の場合に指定する必要があります。
typeProperties.maxConcurrentConnections	integer	データ ソースを同時に接続するための最大同時接続数。
typeProperties.recursive	object	true の場合、現在のフォルダー パスの下にあるファイルまたはサブフォルダーは再帰的に削除されます。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.storeSettings	StoreReadSettings	アクティビティ ストアの設定を削除します。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

DependencyCondition

依存関係の Match-Condition。

名前	型	説明
Completed	string
Failed	string
Skipped	string
Succeeded	string

ExecuteDataFlowActivity

データ フロー アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: ExecuteDataFlow	アクティビティの種類。
typeProperties.compute	Compute	データ フロー アクティビティのコンピューティング プロパティ。
typeProperties.continueOnError	object	データ フローの実行に使用されるエラー設定を続行します。 シンクが失敗した場合に処理を続行できるようにします。 型: boolean (または resultType ブール値を持つ式)
typeProperties.dataFlow	DataFlowReference	データ フローリファレンス。
typeProperties.integrationRuntime	IntegrationRuntimeReference	統合ランタイム参照。
typeProperties.runConcurrently	object	データ フローの実行に使用される同時実行設定。 同じ保存順序のシンクを同時に処理できるようにします。 型: boolean (または resultType ブール値を持つ式)
typeProperties.sourceStagingConcurrency	object	シンクに適用できるソースの並列ステージングの数を指定します。 型: 整数 (または resultType 整数を含む式)
typeProperties.staging	DataFlowStagingInfo	データ フローの実行アクティビティのステージング情報。
typeProperties.traceLevel	object	データ フロー監視出力に使用されるトレース レベルの設定。 サポートされている値は、'粗い'、'fine'、および 'none' です。 型: string (または resultType 文字列を含む式)
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

ExecutePipelineActivity

パイプラインの実行アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ExecutePipelineActivityPolicy	パイプライン アクティビティ ポリシーを実行します。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: ExecutePipeline	アクティビティの種類。
typeProperties.parameters	object	パイプラインのパラメーター。
typeProperties.pipeline	PipelineReference	パイプラインリファレンス。
typeProperties.waitOnCompletion	boolean	アクティビティの実行が依存パイプラインの実行が完了するまで待機するかどうかを定義します。 既定値は false です。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

ExecutePipelineActivityPolicy

実行パイプライン アクティビティの実行ポリシー。

名前	型	説明
secureInput	boolean	true に設定すると、アクティビティからの入力は安全と見なされ、監視に記録されません。

ExecuteSSISPackageActivity

SSIS パッケージ アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: ExecuteSSISPackage	アクティビティの種類。
typeProperties.connectVia	IntegrationRuntimeReference	統合ランタイム参照。
typeProperties.environmentPath	object	SSIS パッケージを実行する環境パス。 型: string (または resultType 文字列を含む式)。
typeProperties.executionCredential	SSISExecutionCredential	パッケージ実行資格情報。
typeProperties.logLocation	SSISLogLocation	SSIS パッケージ実行ログの場所。
typeProperties.loggingLevel	object	SSIS パッケージ実行のログ レベル。 型: string (または resultType 文字列を含む式)。
typeProperties.packageConnectionManagers	object	SSIS パッケージを実行するパッケージ レベルの接続マネージャー。
typeProperties.packageLocation	SSISPackageLocation	SSIS パッケージの場所。
typeProperties.packageParameters	<string,  SSISExecutionParameter>	SSIS パッケージを実行するためのパッケージ レベル パラメーター。
typeProperties.projectConnectionManagers	object	SSIS パッケージを実行するプロジェクト レベルの接続マネージャー。
typeProperties.projectParameters	<string,  SSISExecutionParameter>	SSIS パッケージを実行するプロジェクト レベルのパラメーター。
typeProperties.propertyOverrides	<string,  SSISPropertyOverride>	プロパティは、 をオーバーライドして SSIS パッケージを実行します。
typeProperties.runtime	object	SSIS パッケージを実行するランタイムを指定します。 値は "x86" または "x64" である必要があります。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

ExecuteWranglingDataflowActivity

電源クエリ アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: ExecuteWranglingDataflow	アクティビティの種類。
typeProperties.compute	Compute	データ フロー アクティビティのコンピューティング プロパティ。
typeProperties.continueOnError	object	データ フローの実行に使用されるエラー設定を続行します。 シンクが失敗した場合に処理を続行できるようにします。 型: boolean (または resultType ブール値を持つ式)
typeProperties.dataFlow	DataFlowReference	データ フローリファレンス。
typeProperties.integrationRuntime	IntegrationRuntimeReference	統合ランタイム参照。
typeProperties.queries	PowerQuerySinkMapping[]	Power Queryマッシュアップ クエリとシンク データセットのマッピングの一覧。
typeProperties.runConcurrently	object	データ フローの実行に使用される同時実行設定。 同じ保存順序のシンクを同時に処理できるようにします。 型: boolean (または resultType ブール値を持つ式)
typeProperties.sinks	<string,  PowerQuerySink>	(非推奨。クエリを使用してください)。 queryName にマップPower Queryアクティビティ シンクの一覧。
typeProperties.sourceStagingConcurrency	object	シンクに適用できるソースの並列ステージングの数を指定します。 型: integer (または resultType 整数を持つ式)
typeProperties.staging	DataFlowStagingInfo	データ フローの実行アクティビティのステージング情報。
typeProperties.traceLevel	object	データ フロー監視出力に使用されるトレース レベルの設定。 サポートされている値は、'coarse'、'fine'、および 'none' です。 型: string (または resultType 文字列を含む式)
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

ExecutionActivity

すべての実行アクティビティの基本クラス。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Execution	アクティビティの種類。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

Expression

式定義をAzure Data Factoryします。

名前	型	説明
type	enum: Expression	式の型。
value	string	式の値。

FailActivity

このアクティビティは、独自のスコープ内で失敗し、カスタム エラー メッセージとエラー コードを出力します。 エラー メッセージとコードは、文字列リテラルとして、または実行時に文字列に評価できる式として指定できます。 失敗アクティビティが含まれている場合、アクティビティ スコープはパイプライン全体または制御アクティビティ (foreach、switch、until など) にすることができます。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: Fail	アクティビティの種類。
typeProperties.errorCode	object	Fail アクティビティのエラーの種類を分類するエラー コード。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。
typeProperties.message	object	Fail アクティビティで表示されるエラー メッセージ。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

FilterActivity

条件に基づいて入力配列から結果をフィルター処理して返します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Filter	アクティビティの種類。
typeProperties.condition	Expression	入力のフィルター処理に使用する条件。
typeProperties.items	Expression	フィルターを適用する必要がある入力配列。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

Folder

このパイプラインが存在するフォルダー。 指定しない場合、パイプラインはルート レベルで表示されます。

名前	型	説明
name	string	このパイプラインが存在するフォルダーの名前。

ForEachActivity

このアクティビティは、コレクションを反復処理し、特定のアクティビティを実行するために使用されます。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: ForEach	アクティビティの種類。
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	を実行するアクティビティの一覧。
typeProperties.batchCount	integer	並列実行の数を制御するために使用するバッチの数 (IsSequential が false に設定されている場合)。
typeProperties.isSequential	boolean	ループを順番または並列で実行する必要がある場合 (最大 50)
typeProperties.items	Expression	反復処理するコレクション。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

GetMetadataActivity

データセットのメタデータを取得するアクティビティ

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: GetMetadata	アクティビティの種類。
typeProperties.dataset	DatasetReference	GetMetadata アクティビティ データセットリファレンス。
typeProperties.fieldList	object[]	データセットから取得するメタデータのフィールド。
typeProperties.formatSettings	FormatReadSettings	GetMetadata アクティビティの形式設定。
typeProperties.storeSettings	StoreReadSettings	GetMetadata アクティビティ ストアの設定。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

HDInsightActivityDebugInfoOption

使用する HDInsightActivityDebugInfoOption 設定。

名前	型	説明
Always	string
Failure	string
None	string

HDInsightHiveActivity

HDInsight Hive アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: HDInsightHive	アクティビティの種類。
typeProperties.arguments	object[]	HDInsightActivity に対してユーザーが指定した引数。
typeProperties.defines	object	ユーザーが Hive ジョブ要求の定義を指定できるようにします。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	[デバッグ情報] オプション。
typeProperties.queryTimeout	integer	クエリのタイムアウト値 (分単位)。 HDInsight クラスターが ESP を使用している場合に有効 (エンタープライズ セキュリティ パッケージ)
typeProperties.scriptLinkedService	LinkedServiceReference	リンクされたサービス 参照をスクリプト化します。
typeProperties.scriptPath	object	スクリプト パス。 型: string (または resultType 文字列を含む式)。
typeProperties.storageLinkedServices	LinkedServiceReference[]	ストレージのリンクされたサービス参照。
typeProperties.variables	object	hivevar 名前空間の下でユーザーが指定した引数。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

HDInsightMapReduceActivity

HDInsight MapReduce アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: HDInsightMapReduce	アクティビティの種類。
typeProperties.arguments	object[]	HDInsightActivity に対してユーザーが指定した引数。
typeProperties.className	object	クラス名。 型: string (または resultType 文字列を含む式)。
typeProperties.defines	object	MapReduce ジョブ要求の定義をユーザーが指定できるようにします。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	[デバッグ情報] オプション。
typeProperties.jarFilePath	object	Jar パス。 型: string (または resultType 文字列を含む式)。
typeProperties.jarLibs	object[]	Jar libs。
typeProperties.jarLinkedService	LinkedServiceReference	Jar のリンクされたサービス 参照。
typeProperties.storageLinkedServices	LinkedServiceReference[]	ストレージのリンクされたサービス参照。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

HDInsightPigActivity

HDInsight Pig アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: HDInsightPig	アクティビティの種類。
typeProperties.arguments	object	HDInsightActivity に対してユーザーが指定した引数。 型: 配列 (または resultType 配列を持つ式)。
typeProperties.defines	object	Pig ジョブ要求の定義をユーザーが指定できるようにします。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	[デバッグ情報] オプション。
typeProperties.scriptLinkedService	LinkedServiceReference	リンクされたサービス 参照をスクリプト化します。
typeProperties.scriptPath	object	スクリプト パス。 型: string (または resultType 文字列を含む式)。
typeProperties.storageLinkedServices	LinkedServiceReference[]	ストレージのリンクされたサービス参照。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

HDInsightSparkActivity

HDInsight Spark アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: HDInsightSpark	アクティビティの種類。
typeProperties.arguments	object[]	HDInsightSparkActivity に対するユーザー指定の引数。
typeProperties.className	string	アプリケーションの Java/Spark メイン クラス。
typeProperties.entryFilePath	object	実行するコード/パッケージのルート フォルダーへの相対パス。 型: string (または resultType 文字列を含む式)。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	[デバッグ情報] オプション。
typeProperties.proxyUser	object	ジョブを実行する偽装するユーザー。 型: string (または resultType 文字列を含む式)。
typeProperties.rootPath	object	すべてのジョブのファイルの 'sparkJobLinkedService' のルート パス。 型: string (または resultType 文字列を含む式)。
typeProperties.sparkConfig	object	Spark 構成プロパティ。
typeProperties.sparkJobLinkedService	LinkedServiceReference	エントリ ファイルと依存関係をアップロードし、ログを受信するためのストレージリンクサービス。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

HDInsightStreamingActivity

HDInsight ストリーミング アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: HDInsightStreaming	アクティビティの種類。
typeProperties.arguments	object[]	HDInsightActivity に対してユーザーが指定した引数。
typeProperties.combiner	object	コンバイナー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。
typeProperties.commandEnvironment	object[]	コマンド ライン環境の値。
typeProperties.defines	object	ユーザーがストリーミング ジョブ要求の定義を指定できるようにします。
typeProperties.fileLinkedService	LinkedServiceReference	ファイルが配置されているリンクされたサービス参照。
typeProperties.filePaths	object[]	ストリーミング ジョブ ファイルへのパス。 ディレクトリを指定できます。
typeProperties.getDebugInfo	HDInsightActivityDebugInfoOption	[デバッグ情報] オプション。
typeProperties.input	object	入力 BLOB パス。 型: string (または resultType 文字列を含む式)。
typeProperties.mapper	object	マッパー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。
typeProperties.output	object	出力 BLOB パス。 型: string (または resultType 文字列を含む式)。
typeProperties.reducer	object	Reducer 実行可能ファイル名。 型: string (または resultType 文字列を含む式)。
typeProperties.storageLinkedServices	LinkedServiceReference[]	ストレージのリンクされたサービス参照。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

IfConditionActivity

このアクティビティはブール式を評価し、式の結果に応じて、ifTrueActivities プロパティまたは ifFalseActivities プロパティのアクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: IfCondition	アクティビティの種類。
typeProperties.expression	Expression	ブール値に評価される式。 これは、実行されるアクティビティのブロック (ifTrueActivities または ifFalseActivities) を決定するために使用されます。
typeProperties.ifFalseActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	式が false に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティはアクションなしで終了します。
typeProperties.ifTrueActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	expression が true に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティはアクションなしで終了します。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

IntegrationRuntimeReference

統合ランタイム参照型。

名前	型	説明
parameters	object	統合ランタイムの引数。
referenceName	string	統合ランタイム名を参照します。
type	enum: IntegrationRuntimeReference	統合ランタイムの種類。

LinkedServiceReference

リンクされたサービス参照の種類。

名前	型	説明
parameters	object	LinkedService の引数。
referenceName	string	LinkedService 名を参照します。
type	Type	リンクされたサービス参照の種類。

LogLocationSettings

ログの場所の設定。

名前	型	説明
linkedServiceName	LinkedServiceReference	ログ ストレージのリンクされたサービス リファレンス。
path	object	アクティビティ実行の詳細なログを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。

LogSettings

ログ設定。

名前	型	説明
copyActivityLogSettings	CopyActivityLogSettings	コピー アクティビティ ログの設定を指定します。
enableCopyActivityLog	object	コピー アクティビティ ログを有効にするかどうかを指定します。 型: boolean (または resultType ブール値を持つ式)。
logLocationSettings	LogLocationSettings	ログを有効にする際に、お客様が指定する必要があるログの場所の設定。

LogStorageSettings

(非推奨。LogSettings) ログ ストレージ設定を使用してください。

名前	型	説明
enableReliableLogging	object	信頼できるログ記録を有効にするかどうかを指定します。 型: boolean (または resultType ブール値を持つ式)。
linkedServiceName	LinkedServiceReference	ログ ストレージのリンクされたサービス リファレンス。
logLevel	object	ログ レベル、サポート:情報、警告を取得または設定します。 型: string (または resultType 文字列を含む式)。
path	object	アクティビティ実行の詳細なログを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。

LookupActivity

ルックアップ アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Lookup	アクティビティの種類。
typeProperties.dataset	DatasetReference	ルックアップ アクティビティ データセットの参照。
typeProperties.firstRowOnly	object	最初の行を返すか、すべての行を返すか。 既定値は true です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.source	CopySource	コピー アクティビティ ソースと同じデータセット固有のソース プロパティ。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

NotebookParameter

Notebook パラメーター。

名前	型	説明
type	NotebookParameterType	Notebook パラメーターの種類。
value	object	Notebook パラメーターの値。 型: string (または resultType 文字列を含む式)。

NotebookParameterType

ノートブック パラメーターの種類。

名前	型	説明
bool	string
float	string
int	string
string	string

NotebookReferenceType

Synapse ノートブック参照の種類。

名前	型	説明
NotebookReference	string

ParameterSpecification

エンティティの 1 つのパラメーターの定義。

名前	型	説明
defaultValue	object	パラメーターの既定値。
type	ParameterType	パラメーターの型。

ParameterType

パラメーターの型。

名前	型	説明
Array	string
Bool	string
Float	string
Int	string
Object	string
SecureString	string
String	string

PipelineElapsedTimeMetricPolicy

パイプラインの ElapsedTime メトリック ポリシー。

名前	型	説明
duration	object	TimeSpan 値。その後、Azure 監視メトリックが発生します。

PipelinePolicy

パイプライン ポリシー。

名前	型	説明
elapsedTimeMetric	PipelineElapsedTimeMetricPolicy	パイプラインの ElapsedTime メトリック ポリシー。

PipelineReference

パイプライン参照型。

名前	型	説明
name	string	参照名。
referenceName	string	参照パイプライン名。
type	enum: PipelineReference	パイプライン参照型。

PipelineResource

パイプライン リソースの種類。

名前	型	説明
etag	string	Etag は、リソースの変更を識別します。
id	string	リソース識別子。
name	string	リソースの名前。
properties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	パイプライン内のアクティビティの一覧。
properties.annotations	object[]	パイプラインの記述に使用できるタグの一覧。
properties.concurrency	integer	パイプラインの同時実行の最大数。
properties.description	string	パイプラインの説明。
properties.folder	Folder	このパイプラインが存在するフォルダー。 指定しない場合、パイプラインはルート レベルで表示されます。
properties.parameters	<string,  ParameterSpecification>	パイプラインのパラメーターの一覧。
properties.policy	PipelinePolicy	パイプライン ポリシー。
properties.runDimensions	object	パイプラインによって出力されるディメンション。
properties.variables	<string,  VariableSpecification>	パイプラインの変数の一覧。
type	string	リソースの種類。

PowerQuerySink

Power Query シンク。

名前	型	説明
dataset	DatasetReference	データセット参照。
description	string	変換の説明。
flowlet	DataFlowReference	Flowlet リファレンス
linkedService	LinkedServiceReference	リンクされたサービス 参照。
name	string	変換名。
rejectedDataLinkedService	LinkedServiceReference	拒否されたデータのリンクされたサービス参照。
schemaLinkedService	LinkedServiceReference	スキーマのリンクされたサービス参照。
script	string	シンク スクリプト。

PowerQuerySinkMapping

Power Queryマッシュアップ クエリをシンク データセットにマップします。

名前	型	説明
dataflowSinks	PowerQuerySink[]	マッシュアップ クエリにマップされたシンクPower Query一覧。
queryName	string	マッシュアップ ドキュメント内のクエリPower Query名前。

RedirectIncompatibleRowSettings

互換性のない行設定をリダイレクトする

名前	型	説明
linkedServiceName	object	互換性のない行のリダイレクトに使用される Azure Storage、Storage SAS、または Azure Data Lake Store のリンクされたサービスの名前。 redirectIncompatibleRowSettings が指定されている場合は、指定する必要があります。 型: string (または resultType 文字列を含む式)。
path	object	リダイレクトの互換性のない行データを格納するためのパス。 型: string (または resultType 文字列を含む式)。

ScriptActivity

スクリプト アクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Script	アクティビティの種類。
typeProperties.logSettings	ScriptActivityTypeProperties.LogSettings	スクリプト アクティビティのログ設定。
typeProperties.scriptBlockExecutionTimeout	object	ScriptBlock の実行タイムアウト。 型: string (または resultType 文字列を含む式)、pattern: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).
typeProperties.scripts	ScriptActivityScriptBlock[]	スクリプト ブロックの配列。 型: 配列。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

ScriptActivityLogDestination

ログの宛先。 型: string。

名前	型	説明
ActivityOutput	string
ExternalStore	string

ScriptActivityParameter

スクリプト ブロックのパラメーター。

名前	型	説明
direction	ScriptActivityParameterDirection	パラメーターの方向。
name	object	パラメーターの名前。 型: string (または resultType 文字列を含む式)。
size	integer	出力方向パラメーターのサイズ。
type	ScriptActivityParameterType	パラメーターの型。
value	object	パラメーターの値。 型: string (または resultType 文字列を含む式)。

ScriptActivityParameterDirection

パラメーターの方向。

名前	型	説明
Input	string
InputOutput	string
Output	string

ScriptActivityParameterType

パラメーターの型。

名前	型	説明
Boolean	string
DateTime	string
DateTimeOffset	string
Decimal	string
Double	string
Guid	string
Int16	string
Int32	string
Int64	string
Single	string
String	string
Timespan	string

ScriptActivityScriptBlock

スクリプトのスクリプト ブロック。

名前	型	説明
parameters	ScriptActivityParameter[]	スクリプト パラメーターの配列。 型: 配列。
text	object	クエリ テキスト。 型: string (または resultType 文字列を含む式)。
type	ScriptType	クエリの種類。 型: string。

ScriptActivityTypeProperties.LogSettings

スクリプト アクティビティのログ設定。

名前	型	説明
logDestination	ScriptActivityLogDestination	ログの宛先。 型: string。
logLocationSettings	LogLocationSettings	ログを有効にする際に、お客様が指定する必要があるログの場所の設定。

ScriptType

クエリの型。 型: string。

名前	型	説明
NonQuery	string
Query	string

SecureInputOutputPolicy

セキュリティで保護された入力と出力をサポートするアクティビティの実行ポリシー。

名前	型	説明
secureInput	boolean	true に設定すると、アクティビティからの入力は安全と見なされ、監視に記録されません。
secureOutput	boolean	true に設定すると、アクティビティからの出力は安全と見なされ、監視に記録されません。

SecureString

セキュリティで保護された文字列定義をAzure Data Factoryします。 文字列値は、Get または List API の呼び出し中にアスタリスク '*' でマスクされます。

名前	型	説明
type	string: SecureString	シークレットの種類。
value	string	セキュリティで保護された文字列の値。

SetVariableActivity

変数の値を設定します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	SecureInputOutputPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: SetVariable	アクティビティの種類。
typeProperties.setSystemVariable	boolean	true に設定すると、パイプライン実行の戻り値が設定されます。
typeProperties.value	object	設定する値。 静的な値または式を指定できます。
typeProperties.variableName	string	値を設定する必要がある変数の名前。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

SkipErrorFile

エラー ファイルをスキップします。

名前	型	説明
dataInconsistency	object	他の同時書き込みによってソース/シンク ファイルが変更された場合はスキップします。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
fileMissing	object	コピー中に他のクライアントによってファイルが削除された場合はスキップします。 既定値は true です。 型: boolean (または resultType ブール値を持つ式)。

SparkConfigurationParametrizationReference

Spark 構成リファレンス。

名前	型	説明
referenceName	object	Spark 構成名を参照します。 型: string (または resultType 文字列を含む式)。
type	SparkConfigurationReferenceType	Spark 構成参照の種類。

SparkConfigurationReferenceType

Spark 構成参照の種類。

名前	型	説明
SparkConfigurationReference	string

SparkJobReferenceType

Synapse Spark ジョブ参照の種類。

名前	型	説明
SparkJobDefinitionReference	string

SqlServerStoredProcedureActivity

SQL ストアド プロシージャのアクティビティの種類。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: SqlServerStoredProcedure	アクティビティの種類。
typeProperties.storedProcedureName	object	ストアド プロシージャ名。 型: string (または resultType 文字列を含む式)。
typeProperties.storedProcedureParameters	object	ストアド プロシージャ パラメーターの値と型の設定。 例: "{Parameter1: {value: "1", type: "int"}}"
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

SSISAccessCredential

SSIS アクセス資格情報。

名前	型	説明
domain	object	Windows 認証のドメイン。 型: string (または resultType 文字列を含む式)。
password	SecretBase: AzureKeyVaultSecretReference SecureString	Windows 認証のパスワード。
userName	object	Windows 認証の UseName。 型: string (または resultType 文字列を含む式)。

SSISChildPackage

SSIS 埋め込み子パッケージ。

名前	型	説明
packageContent	object	埋め込み子パッケージのコンテンツ。 型: string (または resultType 文字列を含む式)。
packageLastModifiedDate	string	埋め込み子パッケージの最終変更日。
packageName	string	埋め込み子パッケージの名前。
packagePath	object	埋め込み子パッケージのパス。 型: string (または resultType 文字列を含む式)。

SSISExecutionCredential

SSIS パッケージの実行資格情報。

名前	型	説明
domain	object	Windows 認証のドメイン。 型: string (または resultType 文字列を含む式)。
password	SecureString	Windows 認証のパスワード。
userName	object	Windows 認証の UseName。 型: string (または resultType 文字列を含む式)。

SSISExecutionParameter

SSIS 実行パラメーター。

名前	型	説明
value	object	SSIS パッケージ実行パラメーター値。 型: string (または resultType 文字列を含む式)。

SSISLogLocation

SSIS パッケージの実行ログの場所

名前	型	説明
logPath	object	SSIS パッケージの実行ログ パス。 型: string (または resultType 文字列を含む式)。
type	SsisLogLocationType	SSIS ログの場所の種類。
typeProperties.accessCredential	SSISAccessCredential	パッケージ実行ログアクセス資格情報。
typeProperties.logRefreshInterval	object	ログを更新する間隔を指定します。 既定の間隔は 5 分です。 型: string (または resultType 文字列を含む式)、パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).

SsisLogLocationType

SSIS ログの場所の種類。

名前	型	説明
File	string

SSISPackageLocation

SSIS パッケージの場所。

名前	型	説明
packagePath	object	SSIS パッケージ パス。 型: string (または resultType 文字列を含む式)。
type	SsisPackageLocationType	SSIS パッケージの場所の種類。
typeProperties.accessCredential	SSISAccessCredential	パッケージ アクセス資格情報。
typeProperties.childPackages	SSISChildPackage[]	埋め込み子パッケージの一覧。
typeProperties.configurationAccessCredential	SSISAccessCredential	構成ファイルのアクセス資格情報。
typeProperties.configurationPath	object	パッケージ実行の構成ファイル。 型: string (または resultType 文字列を含む式)。
typeProperties.packageContent	object	埋め込みパッケージの内容。 型: string (または resultType 文字列を含む式)。
typeProperties.packageLastModifiedDate	string	埋め込みパッケージの最終変更日。
typeProperties.packageName	string	パッケージの名前です。
typeProperties.packagePassword	SecretBase: AzureKeyVaultSecretReference SecureString	パッケージのパスワード。

SsisPackageLocationType

SSIS パッケージの場所の種類。

名前	型	説明
File	string
InlinePackage	string
PackageStore	string
SSISDB	string

SSISPropertyOverride

SSIS プロパティのオーバーライド。

名前	型	説明
isSensitive	boolean	SSIS パッケージ プロパティのオーバーライド値が機密データであるかどうか。 値が true の場合、SSISDB で暗号化されます
value	object	SSIS パッケージ プロパティのオーバーライド値。 型: string (または resultType 文字列を含む式)。

StagingSettings

ステージング設定。

名前	型	説明
enableCompression	object	中間ステージングを使用してデータをコピーするときに圧縮を使用するかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
linkedServiceName	LinkedServiceReference	ステージングリンクされたサービスリファレンス。
path	object	中間データを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。

SwitchActivity

このアクティビティは式を評価し、equals プロパティで想定される式の評価に対応する cases プロパティでアクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: Switch	アクティビティの種類。
typeProperties.cases	SwitchCase[]	'on' プロパティの予期される値に対応するケースの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティは defaultActivities で提供されるアクティビティを実行します。
typeProperties.defaultActivities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	ケース条件が満たされない場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティはアクションなしで終了します。
typeProperties.on	Expression	文字列または整数に評価される式。 これは、実行される場合のアクティビティのブロックを決定するために使用されます。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

SwitchCase

を持つスイッチ ケースには、値と対応するアクティビティがあります。

名前	型	説明
activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	満たされたケース条件に対して実行するアクティビティの一覧。
value	string	'on' プロパティの式の結果を満たす値が必要です。

SynapseNotebookActivity

Synapse ノートブック アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: SynapseNotebook	アクティビティの種類。
typeProperties.conf	object	Spark 構成プロパティ。指定したノートブックの 'conf' をオーバーライドします。
typeProperties.configurationType	ConfigurationType	Spark 構成の型。
typeProperties.driverSize	object	セッションの指定した Spark プールに割り当てられたドライバーに使用するコアとメモリの数。これは、指定したノートブックの 'driverCores' と 'driverMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
typeProperties.executorSize	object	セッションの指定した Spark プールに割り当てられた Executor に使用されるコアとメモリの数。これは、指定したノートブックの 'ExecutorCores' と 'ExecutorMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
typeProperties.notebook	SynapseNotebookReference	Synapse ノートブック リファレンス。
typeProperties.numExecutors	object	このセッションで起動する Executor の数。これにより、指定したノートブックの 'numExecutors' がオーバーライドされます。 型: integer (または resultType 整数を持つ式)。
typeProperties.parameters	<string,  NotebookParameter>	ノートブック のパラメーター。
typeProperties.sparkConfig	object	Spark 構成プロパティ。
typeProperties.sparkPool	BigDataPoolParametrizationReference	ノートブックの実行に使用されるビッグ データ プールの名前。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	Spark ジョブの Spark 構成。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

SynapseNotebookReference

Synapse ノートブックの参照型。

名前	型	説明
referenceName	object	参照ノートブック名。 型: string (または resultType 文字列を含む式)。
type	NotebookReferenceType	Synapse ノートブックの参照型。

SynapseSparkJobDefinitionActivity

Spark ジョブ アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: SparkJob	アクティビティの種類。
typeProperties.args	SynapseSparkJobActivityTypeProperties.Args[]	SynapseSparkJobDefinitionActivity に対してユーザーが指定した引数。
typeProperties.className	object	指定した spark ジョブ定義の 'className' をオーバーライドする、メイン定義ファイル内の完全修飾識別子またはメイン クラス。 型: string (または resultType 文字列を含む式)。
typeProperties.conf	object	Spark 構成プロパティ。指定した Spark ジョブ定義の 'conf' をオーバーライドします。
typeProperties.configurationType	ConfigurationType	Spark 構成の型。
typeProperties.driverSize	object	ジョブの指定した Spark プールに割り当てられたドライバーに使用されるコアとメモリの数。これは、指定した Spark ジョブ定義の 'driverCores' と 'driverMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
typeProperties.executorSize	object	ジョブの指定した Spark プールに割り当てられた Executor に使用するコアとメモリの数。これは、指定した Spark ジョブ定義の 'ExecutorCores' と 'ExecutorMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
typeProperties.file	object	ジョブに使用されるメイン ファイル。これにより、指定した Spark ジョブ定義の 'file' がオーバーライドされます。 型: string (または resultType 文字列を含む式)。
typeProperties.files	object[]	(非推奨。pythonCodeReference と filesV2) メイン定義ファイル内の参照に使用される追加のファイルを使用してください。これにより、指定した Spark ジョブ定義の 'files' がオーバーライドされます。
typeProperties.filesV2	object[]	メイン定義ファイル内の参照に使用される追加のファイル。これにより、指定した Spark ジョブ定義の 'jars' と 'files' がオーバーライドされます。
typeProperties.numExecutors	object	このジョブに対して起動する Executor の数。これにより、指定した Spark ジョブ定義の 'numExecutors' がオーバーライドされます。 型: integer (または resultType 整数を持つ式)。
typeProperties.pythonCodeReference	object[]	メイン定義ファイルの参照に使用される追加の Python コード ファイル。これにより、指定した Spark ジョブ定義の 'pyFiles' がオーバーライドされます。
typeProperties.scanFolder	object	メイン定義ファイルのルート フォルダーからサブフォルダーをスキャンすると、これらのファイルが参照ファイルとして追加されます。 'jars'、'pyFiles'、'files' または 'archives' という名前のフォルダーがスキャンされ、フォルダー名では大文字と小文字が区別されます。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.sparkConfig	object	Spark 構成プロパティ。
typeProperties.sparkJob	SynapseSparkJobReference	Synapse Spark ジョブリファレンス。
typeProperties.targetBigDataPool	BigDataPoolParametrizationReference	Spark バッチ ジョブの実行に使用されるビッグ データ プールの名前。これにより、指定した Spark ジョブ定義の 'targetBigDataPool' がオーバーライドされます。
typeProperties.targetSparkConfiguration	SparkConfigurationParametrizationReference	Spark ジョブの Spark 構成。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

SynapseSparkJobReference

Synapse Spark ジョブ参照の種類。

名前	型	説明
referenceName	object	Spark ジョブ名を参照します。 resultType 文字列を含む式。
type	SparkJobReferenceType	Synapse Spark ジョブ参照の種類。

Type

リンクされたサービス参照の種類。

名前	型	説明
LinkedServiceReference	string

UntilActivity

このアクティビティは、指定されたブール式の結果が true またはタイムアウトになるまで、どちらか早い方に達するまで、内部アクティビティを実行します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: Until	アクティビティの種類。
typeProperties.activities	Activity[]: AppendVariableActivity[] AzureDataExplorerCommandActivity[] AzureFunctionActivity[] AzureMLBatchExecutionActivity[] AzureMLExecutePipelineActivity[] AzureMLUpdateResourceActivity[] ControlActivity[] CopyActivity[] CustomActivity[] DataLakeAnalyticsUSQLActivity[] DatabricksNotebookActivity[] DatabricksSparkJarActivity[] DatabricksSparkPythonActivity[] DeleteActivity[] ExecuteDataFlowActivity[] ExecutePipelineActivity[] ExecuteSSISPackageActivity[] ExecuteWranglingDataflowActivity[] ExecutionActivity[] FailActivity[] FilterActivity[] ForEachActivity[] GetMetadataActivity[] HDInsightHiveActivity[] HDInsightMapReduceActivity[] HDInsightPigActivity[] HDInsightSparkActivity[] HDInsightStreamingActivity[] IfConditionActivity[] LookupActivity[] ScriptActivity[] SetVariableActivity[] SqlServerStoredProcedureActivity[] SwitchActivity[] SynapseNotebookActivity[] SynapseSparkJobDefinitionActivity[] UntilActivity[] ValidationActivity[] WaitActivity[] WebActivity[] WebHookActivity[]	実行するアクティビティの一覧。
typeProperties.expression	Expression	ブール値に評価される式。 ループは、この式が true に評価されるまで続行されます
typeProperties.timeout	object	アクティビティの実行に関するタイムアウトを指定します。 値が指定されていない場合、TimeSpan.FromDays(7) の値 (既定値は 1 週間) を受け取ります。 型: string (または resultType 文字列を含む式)、パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

UserProperty

User プロパティ。

名前	型	説明
name	string	ユーザー プロパティ名。
value	object	ユーザー プロパティの値。 型: string (または resultType 文字列を含む式)。

ValidationActivity

このアクティビティは、外部リソースが存在することを確認します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: Validation	アクティビティの種類。
typeProperties.childItems	object	データセットがフォルダーを指している場合に使用できます。 true に設定した場合、フォルダーには少なくとも 1 つのファイルが必要です。 false に設定した場合、フォルダーは空である必要があります。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.dataset	DatasetReference	検証アクティビティ データセットリファレンス。
typeProperties.minimumSize	object	データセットがファイルを指している場合に使用できます。 ファイルのサイズは、指定した値以上である必要があります。 型: integer (または resultType 整数を持つ式)。
typeProperties.sleep	object	検証の試行間の遅延 (秒単位)。 値を指定しない場合は、既定値として 10 秒が使用されます。 型: integer (または resultType 整数を持つ式)。
typeProperties.timeout	object	アクティビティの実行に関するタイムアウトを指定します。 値が指定されていない場合、TimeSpan.FromDays(7) の値 (既定値は 1 週間) を受け取ります。 型: string (または resultType 文字列を含む式)、パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

VariableSpecification

パイプラインの 1 つの変数の定義。

名前	型	説明
defaultValue	object	変数の既定値。
type	VariableType	変数の型。

VariableType

変数の型。

名前	型	説明
Array	string
Bool	string
String	string

WaitActivity

このアクティビティは、指定された間隔でパイプラインの実行を中断します。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定で Active になります。
type	string: Wait	アクティビティの種類。
typeProperties.waitTimeInSeconds	object	秒単位の期間。 型: integer (または resultType 整数を持つ式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

WebActivity

Web アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
linkedServiceName	LinkedServiceReference	リンクされたサービス 参照。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	ActivityPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: WebActivity	アクティビティの種類。
typeProperties.authentication	WebActivityAuthentication	エンドポイントを呼び出すために使用される認証方法。
typeProperties.body	object	エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドに必要です。GET メソッドの Type: string (または resultType 文字列を含む式) には使用できません。
typeProperties.connectVia	IntegrationRuntimeReference	統合ランタイム参照。
typeProperties.datasets	DatasetReference[]	Web エンドポイントに渡されるデータセットの一覧。
typeProperties.disableCertValidation	boolean	true に設定すると、証明書の検証は無効になります。
typeProperties.headers	object	要求に送信されるヘッダーを表します。 たとえば、要求に種類と言語を設定する場合: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。
typeProperties.httpRequestTimeout	object	HTTP 要求が応答を取得する際のタイムアウト。 形式は TimeSpan (hh:mm:ss) です。 この値は、アクティビティのタイムアウトではなく、応答を取得するためのタイムアウトです。 既定値は 00:01:00 (1 分) です。 範囲は 1 から 10 分です
typeProperties.linkedServices	LinkedServiceReference[]	Web エンドポイントに渡されるリンクされたサービスの一覧。
typeProperties.method	WebActivityMethod	ターゲット エンドポイントの REST API メソッド。
typeProperties.turnOffAsync	boolean	HTTP 202 応答の応答ヘッダーで指定された場所での HTTP GET の呼び出しを無効にするオプション。 true に設定すると、応答ヘッダーで指定された http の場所で HTTP GET の呼び出しが停止されます。 false を設定すると、http 応答ヘッダーで指定された場所で HTTP GET 呼び出しが引き続き呼び出されます。
typeProperties.url	object	Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

WebActivityAuthentication

Web アクティビティの認証プロパティ。

名前	型	説明
credential	CredentialReference	認証情報を含む資格情報参照。
password	SecretBase: AzureKeyVaultSecretReference SecureString	ServicePrincipal に使用する場合の PFX ファイルまたは基本認証/シークレットのパスワード
pfx	SecretBase: AzureKeyVaultSecretReference SecureString	ServicePrincipal に使用する場合の PFX ファイルまたは証明書の Base64 でエンコードされたコンテンツ
resource	object	MSI 認証を使用するときに Azure 認証トークンが要求されるリソース。 型: string (または resultType 文字列を含む式)。
type	string	Web アクティビティ認証 (Basic/ClientCertificate/MSI/ServicePrincipal)
userTenant	object	ServicePrincipal 認証を使用するときに Azure 認証トークンが要求される TenantId。 型: string (または resultType 文字列を含む式)。
username	object	ServicePrincipal に使用する場合は、基本認証または ClientID の Web アクティビティ認証ユーザー名。 型: string (または resultType 文字列を含む式)。

WebActivityMethod

WebActivity でサポートされている HTTP メソッドの一覧。

名前	型	説明
DELETE	string
GET	string
POST	string
PUT	string

WebHookActivity

WebHook アクティビティ。

名前	型	説明
dependsOn	ActivityDependency[]	アクティビティは条件によって異なります。
description	string	アクティビティの説明。
name	string	アクティビティ名。
onInactiveMarkAs	ActivityOnInactiveMarkAs	状態が [非アクティブ] に設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブな場合に指定しない場合、状態は既定で Succeeded になります。
policy	SecureInputOutputPolicy	アクティビティ ポリシー。
state	ActivityState	アクティビティの状態。 これは省略可能なプロパティであり、指定されていない場合、状態は既定でアクティブになります。
type	string: WebHook	アクティビティの種類。
typeProperties.authentication	WebActivityAuthentication	エンドポイントを呼び出すために使用される認証方法。
typeProperties.body	object	エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドに必要です。GET メソッドの Type: string (または resultType 文字列を含む式) には使用できません。
typeProperties.headers	object	要求に送信されるヘッダーを表します。 たとえば、要求に種類と言語を設定する場合: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。
typeProperties.method	WebHookActivityMethod	ターゲット エンドポイントの REST API メソッド。
typeProperties.reportStatusOnCallBack	object	true に設定すると、コールバック要求本文の statusCode、出力、エラーがアクティビティによって使用されます。 アクティビティは、コールバック要求で statusCode >= 400 を設定することで失敗としてマークできます。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。
typeProperties.timeout	string	Webhook を呼び戻すタイムアウト。 値が指定されていない場合、既定値は 10 分です。 型: string。 パターン: ((\d+).)?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])).
typeProperties.url	object	WebHook アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。
userProperties	UserProperty[]	アクティビティ ユーザーのプロパティ。

WebHookActivityMethod

WebHook アクティビティでサポートされる HTTP メソッドの一覧。

名前	型	説明
POST	string