Pipelines - Create Or Update

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

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

URI パラメーター

Name In Required Type Description
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 のバージョン。

要求ヘッダー

Name Required Type Description
If-Match
  • string

パイプライン エンティティの ETag。 更新にのみ指定する必要があります。既存のエンティティと一致する必要があります。無条件更新の場合は * を指定できます。

要求本文

Name Type Description
properties.activities Activity[]:

パイプライン内のアクティビティの一覧。

properties.annotations
  • object[]

パイプラインの記述に使用できるタグの一覧。

properties.concurrency
  • integer

パイプラインの同時実行の最大数。

properties.description
  • string

パイプラインの説明。

properties.folder

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

properties.parameters

パイプラインのパラメーターの一覧。

properties.policy

パイプライン ポリシー。

properties.runDimensions
  • object

パイプラインによって出力されるディメンション。

properties.variables

パイプラインの変数の一覧。

応答

Name Type Description
200 OK

OK です。

Other Status Codes

サービスから受信したAzure Data Factory応答。

セキュリティ

azure_auth

OAuth2 Flow を Azure Active Directory します。

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

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

Pipelines_Create
Pipelines_Update

Pipelines_Create

Sample Request

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

Sample Response

Date: Sat, 16 Jun 2018 00:37:41 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
x-ms-correlation-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline",
  "name": "examplePipeline",
  "type": "Microsoft.DataFactory/factories/pipelines",
  "properties": {
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      },
      "JobId": {
        "type": "String"
      }
    },
    "variables": {
      "TestVariableArray": {
        "type": "Array"
      }
    },
    "runDimensions": {
      "JobId": {
        "value": "@pipeline().parameters.JobId",
        "type": "Expression"
      }
    }
  },
  "etag": "0a0069d4-0000-0000-0000-5b245bd50000"
}

Pipelines_Update

Sample Request

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

Sample Response

Date: Sat, 16 Jun 2018 00:37:43 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1191
x-ms-request-id: 91a763b0-d944-493f-83fc-e989c8b6e122
x-ms-correlation-request-id: 91a763b0-d944-493f-83fc-e989c8b6e122
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline",
  "name": "examplePipeline",
  "type": "Microsoft.DataFactory/factories/pipelines",
  "properties": {
    "description": "Example description",
    "activities": [
      {
        "type": "ForEach",
        "typeProperties": {
          "isSequential": true,
          "items": {
            "value": "@pipeline().parameters.OutputBlobNameList",
            "type": "Expression"
          },
          "activities": [
            {
              "type": "Copy",
              "typeProperties": {
                "source": {
                  "type": "BlobSource"
                },
                "sink": {
                  "type": "BlobSink"
                },
                "dataIntegrationUnits": 32
              },
              "inputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": "examplecontainer.csv"
                  },
                  "type": "DatasetReference"
                }
              ],
              "outputs": [
                {
                  "referenceName": "exampleDataset",
                  "parameters": {
                    "MyFolderPath": "examplecontainer",
                    "MyFileName": {
                      "value": "@item()",
                      "type": "Expression"
                    }
                  },
                  "type": "DatasetReference"
                }
              ],
              "name": "ExampleCopyActivity"
            }
          ]
        },
        "name": "ExampleForeachActivity"
      }
    ],
    "parameters": {
      "OutputBlobNameList": {
        "type": "Array"
      }
    }
  },
  "etag": "0a006cd4-0000-0000-0000-5b245bd60000"
}

定義

ActivityDependency

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

ActivityPolicy

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

AppendVariableActivity

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

AzureDataExplorerCommandActivity

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

AzureFunctionActivity

Azure 関数アクティビティ。

AzureFunctionActivityMethod

AzureFunctionActivity によってサポートされる HTTP メソッドの一覧。

AzureKeyVaultSecretReference

Azure Key Vault シークレットの参照です。

AzureMLBatchExecutionActivity

Azure ML Batch Execution アクティビティ。

AzureMLExecutePipelineActivity

Azure ML Execute Pipeline アクティビティ。

AzureMLUpdateResourceActivity

Azure MLリソース管理アクティビティの更新。

AzureMLWebServiceFile

Azure ML WebService の入力/出力ファイル

CloudError

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

Compute

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

ControlActivity

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

CopyActivity

コピー アクティビティ。

CopyActivityLogSettings

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

CredentialReference

資格情報の参照の種類。

CustomActivity

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

CustomActivityReferenceObject

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

DatabricksNotebookActivity

DatabricksNotebook アクティビティ。

DatabricksSparkJarActivity

DatabricksSparkJar アクティビティ。

DatabricksSparkPythonActivity

DatabricksSparkPython アクティビティ。

DataFlowReference

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

DataFlowStagingInfo

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

DataLakeAnalyticsUSQLActivity

Data Lake Analytics U-SQL アクティビティ。

DatasetReference

データセット参照型。

DeleteActivity

削除アクティビティ。

ExecuteDataFlowActivity

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

ExecutePipelineActivity

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

ExecuteSSISPackageActivity

SSIS パッケージの実行アクティビティ。

ExecuteWranglingDataflowActivity

Power Query アクティビティを実行します。

ExecutionActivity

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

Expression

式の定義を Azure Data Factory します。

FailActivity

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

FilterActivity

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

Folder

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

ForEachActivity

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

GetMetadataActivity

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

HDInsightActivityDebugInfoOption

使用する HDInsightActivityDebugInfoOption 設定。

HDInsightHiveActivity

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

HDInsightMapReduceActivity

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

HDInsightPigActivity

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

HDInsightSparkActivity

HDInsight Spark アクティビティ。

HDInsightStreamingActivity

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

IfConditionActivity

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

IntegrationRuntimeReference

統合ランタイム参照型。

LinkedServiceReference

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

LogLocationSettings

ログの場所の設定。

LogSettings

ログ設定。

LogStorageSettings

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

LookupActivity

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

ParameterSpecification

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

ParameterType

パラメーターの型。

PipelineElapsedTimeMetricPolicy

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

PipelinePolicy

パイプライン ポリシー。

PipelineReference

パイプライン参照の種類。

PipelineResource

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

PowerQuerySink

Power query sink。

PowerQuerySinkMapping

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

RedirectIncompatibleRowSettings

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

SecureString

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

SetVariableActivity

変数の値を設定します。

SkipErrorFile

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

SqlServerStoredProcedureActivity

SQL アクティビティの種類を指定します。

SSISAccessCredential

SSIS アクセス資格情報。

SSISChildPackage

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

SSISExecutionCredential

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

SSISExecutionParameter

SSIS 実行パラメーター。

SSISLogLocation

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

SsisLogLocationType

SSIS ログの場所の種類。

SSISPackageLocation

SSIS パッケージの場所。

SsisPackageLocationType

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

SSISPropertyOverride

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

StagingSettings

ステージング設定。

StoredProcedureParameter

SQL ストアド プロシージャ パラメーター。

StoredProcedureParameterType

ストアドプロシージャパラメーターの型。

SwitchActivity

このアクティビティは、式を評価し、equals プロパティに必要な式の評価に対応する "ケース" プロパティでアクティビティを実行します。

SwitchCase

の Switch ケースには、値と対応するアクティビティがあります。

UntilActivity

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

UserProperty

User プロパティ。

ValidationActivity

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

VariableSpecification

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

VariableType

変数の型。

WaitActivity

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

WebActivity

Web アクティビティ。

WebActivityAuthentication

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

WebActivityMethod

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

WebHookActivity

WebHook アクティビティ。

WebHookActivityMethod

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

ActivityDependency

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

Name Type Description
activity
  • string

アクティビティ名。

dependencyConditions
  • string[]

依存関係の Match-Condition。

ActivityPolicy

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

Name Type Description
retry
  • object

通常の再試行回数の上限。 既定値は 0 です。 型: 整数 (または、resultType 整数を含む式)、最小値: 0。

retryIntervalInSeconds
  • integer

各再試行の間隔 (秒単位)。 既定値は30秒です。

secureInput
  • boolean

True に設定すると、アクティビティからの入力はセキュリティで保護されたものと見なされ、監視には記録されません。

secureOutput
  • boolean

True に設定すると、アクティビティからの出力は安全と見なされ、監視には記録されません。

timeout
  • object

アクティビティの実行に関するタイムアウトを指定します。 既定のタイムアウトは7日です。 Type: string (resultType 文字列を含む式)、pattern: ((\d +) . )? (\ d\d):(60 |([0-5] [0-9]):(60 |([0-5] [0-9])。

AppendVariableActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • AppendVariable

アクティビティの種類。

typeProperties.value
  • object

追加する値。 静的な値または式である可能性があります

typeProperties.variableName
  • string

値を追加する必要がある変数の名前。

userProperties

アクティビティのユーザープロパティ。

AzureDataExplorerCommandActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • AzureDataExplorerCommand

アクティビティの種類。

typeProperties.command
  • object

次のコマンド構文に従Azure Data Explorerコントロール コマンド。 型: string (または resultType 文字列を含む式)。

typeProperties.commandTimeout
  • object

制御コマンドのタイムアウト。 型: string (または resultType 文字列を含む式)、パターン: ((\d+) . )?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)

userProperties

アクティビティ ユーザーのプロパティ。

AzureFunctionActivity

Azure 関数アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:

アクティビティの種類。

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

ターゲット エンドポイントの Rest API メソッド。

userProperties

アクティビティ ユーザーのプロパティ。

AzureFunctionActivityMethod

AzureFunctionActivity によってサポートされる HTTP メソッドの一覧。

Name Type Description
DELETE
  • string
GET
  • string
HEAD
  • string
OPTIONS
  • string
POST
  • string
PUT
  • string
TRACE
  • string

AzureKeyVaultSecretReference

Azure Key Vault シークレットの参照です。

Name Type Description
secretName
  • object

Azure Key Vault 内のシークレットの名前。 Type: string (または resultType 文字列を含む式)。

secretVersion
  • object

Azure Key Vault 内のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 Type: string (または resultType 文字列を含む式)。

store

Azure Key Vault のリンクされたサービス参照です。

type string:
  • AzureKeyVaultSecret

シークレットの種類。

AzureMLBatchExecutionActivity

Azure ML Batch Execution アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • AzureMLBatchExecution

アクティビティの種類。

typeProperties.globalParameters
  • object

Azure ML Batch Execution Service エンドポイントに渡されるキーと値のペア。 キーは、公開済みの Azure ML Web サービスで定義されている、Web サービスのパラメーターの名前と一致する必要があります。 値は、Azure の GlobalParameters プロパティでバッチ実行要求ML渡されます。

typeProperties.webServiceInputs

キーと値のペア。Azure ML エンドポイントの Web サービス入力の名前を、入力 BLOB の場所を指定する AzureMLWebServiceFile オブジェクトにマッピングします。 この情報は、Azure の WebServiceInputs プロパティでバッチ実行要求ML渡されます。

typeProperties.webServiceOutputs

キーと値のペア。Azure ML エンドポイントの Web サービス出力の名前を、出力 BLOB の場所を指定する AzureMLWebServiceFile オブジェクトにマッピングします。 この情報は、Azure の WebServiceOutputs プロパティでバッチ実行要求ML渡されます。

userProperties

アクティビティ ユーザーのプロパティ。

AzureMLExecutePipelineActivity

Azure ML Execute Pipeline アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • AzureMLExecutePipeline

アクティビティの種類。

typeProperties.continueOnStepFailure
  • object

ステップが失敗した場合に PipelineRun で他のステップの実行を続行するかどうか。 この情報は、発行されたパイプライン実行要求の continueOnStepFailure プロパティで渡されます。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.dataPathAssignments
  • object

再トレーニングを行わずにデータ パスの割り当てを変更するために使用されるディクショナリ。 値は、発行されたパイプライン実行要求の dataPathAssignments プロパティで渡されます。 型: キーと値のペアを持つオブジェクト (または resultType オブジェクトを含む式)。

typeProperties.experimentName
  • object

パイプライン実行の実行履歴実験名。 この情報は、発行されたパイプライン実行要求の ExperimentName プロパティで渡されます。 型: string (または resultType 文字列を含む式)。

typeProperties.mlParentRunId
  • object

親 Azure ML Service パイプライン実行 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

アクティビティ ユーザーのプロパティ。

AzureMLUpdateResourceActivity

Azure MLリソース管理アクティビティの更新。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • AzureMLUpdateResource

アクティビティの種類。

typeProperties.trainedModelFilePath
  • object

更新操作によってアップロードされる .ilearner ファイルを表す trainedModelLinkedService の相対ファイル パス。 型: string (または resultType 文字列を含む式)。

typeProperties.trainedModelLinkedServiceName

更新操作Azure Storageアップロードされる .ilearner ファイルを保持するリンクされたサービスの名前。

typeProperties.trainedModelName
  • object

更新する Web サービス実験のトレーニング済みモデル モジュールの名前。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

AzureMLWebServiceFile

Azure ML WebService の入力/出力ファイル

Name Type Description
filePath
  • object

LinkedService によって指定された Azure Blob Storage 内のコンテナー名を含む相対ファイルパス。 Type: string (または resultType 文字列を含む式)。

linkedServiceName

Azure ML WebService 入力/出力ファイルが配置されている Azure Storage LinkedService への参照。

CloudError

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

Name Type Description
error.code
  • string

エラー コード。

error.details

追加のエラーの詳細を含む配列。

error.message
  • string

エラー メッセージ。

error.target
  • string

エラーに関連付けられた要求のプロパティ名/パス。

Compute

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

Name Type Description
computeType
  • object

データ フロー ジョブを実行するクラスターのコンピューティングの種類。 指定できる値は、'General'、'MemoryOptimized'、'ComputeOptimized' です。 型: string (または resultType 文字列を含む式)

coreCount
  • object

データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 型: 整数 (または resultType 整数を含む式)

ControlActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Container

アクティビティの種類。

userProperties

アクティビティ ユーザーのプロパティ。

CopyActivity

コピー アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

inputs

アクティビティの入力の一覧。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

outputs

アクティビティの出力の一覧。

policy

アクティビティ ポリシー。

type string:
  • Copy

アクティビティの種類。

typeProperties.dataIntegrationUnits
  • object

このデータ移動を実行するために使用できるデータ統合単位の最大数。 型: 整数 (または resultType 整数を含む式)、最小: 0。

typeProperties.enableSkipIncompatibleRow
  • object

互換性のない行をスキップするかどうか。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.enableStaging
  • object

中間ステージングを使用してデータをコピーするかどうかを指定します。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.logSettings

ログを有効にするときに、お客様が提供する必要があるログ設定。

typeProperties.logStorageSettings

(非推奨になりました。 LogSettings) セッション ログを有効にする際に、お客様が指定する必要があるログ ストレージ設定を使用してください。

typeProperties.parallelCopies
  • object

データ ストアのオーバーロードを回避するために、ソースまたはシンクで開いた同時セッションの最大数。 型: 整数 (または resultType 整数を含む式)、最小: 0。

typeProperties.preserve
  • object[]

ルールを保持します。

typeProperties.preserveRules
  • object[]

規則を保持します。

typeProperties.redirectIncompatibleRowSettings

EnableSkipIncompatibleRow が true の場合は、互換性のない行設定をリダイレクトします。

typeProperties.sink
  • CopySink

Copy アクティビティシンク。

typeProperties.skipErrorFile

データ整合性のフォールト トレランスを指定します。

typeProperties.source
  • CopySource

Copy アクティビティソース。

typeProperties.stagingSettings

EnableStaging が true の場合の中間ステージング設定を指定します。

typeProperties.translator
  • object

Copy アクティビティトランスレーター。 指定しない場合は、表形式変換ツールが使用されます。

typeProperties.validateDataConsistency
  • object

データ整合性の検証を有効にするかどうか。 型: ブール値 (または resultType ブール値を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

CopyActivityLogSettings

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

Name Type Description
enableReliableLogging
  • object

信頼できるログ記録を有効にするかどうかを指定します。 型: boolean (または resultType ブール値を含む式)。

logLevel
  • object

ログレベル、サポート: 情報、警告を取得または設定します。 Type: string (または resultType 文字列を含む式)。

CredentialReference

資格情報の参照の種類。

Name Type Description
referenceName
  • string

参照資格情報の名前。

type enum:

資格情報の参照の種類。

CustomActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • Custom

アクティビティの種類。

typeProperties.autoUserSpecification
  • object

ユーザーの昇格レベルとスコープ。既定値は nonadmin タスクです。 型: string (または resultType double を含む式)。

typeProperties.command
  • object

カスタム アクティビティ Type のコマンド: string (または resultType 文字列を含む式)。

typeProperties.extendedProperties
  • object

ユーザー定義のプロパティ バッグ。 使用できるキーまたは値に制限はありません。 ユーザーが指定したカスタム アクティビティは、定義されたコンテンツを使用および解釈する責任を負います。

typeProperties.folderPath
  • object

リソース ファイルのフォルダー パス: 文字列 (または resultType 文字列を含む式)。

typeProperties.referenceObjects

参照オブジェクト

typeProperties.resourceLinkedService

リソースのリンクされたサービスリファレンス。

typeProperties.retentionTimeInDays
  • object

カスタム アクティビティ用に送信するファイルのリテンション期間。 型: double (または resultType double を持つ式)。

userProperties

アクティビティ ユーザーのプロパティ。

CustomActivityReferenceObject

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

Name Type Description
datasets

データセット参照。

linkedServices

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

DatabricksNotebookActivity

DatabricksNotebook アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • DatabricksNotebook

アクティビティの種類。

typeProperties.baseParameters
  • object

このジョブの実行ごとに使用される基本パラメーター。ノートブックが指定されていないパラメーターを受け取る場合は、ノートブックの既定値が使用されます。

typeProperties.libraries
  • object[]

ジョブを実行するクラスターにインストールされるライブラリのリスト。

typeProperties.notebookPath
  • object

Databricks ワークスペースで実行するノートブックの絶対パスです。 このパスはスラッシュで始まる必要があります。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

DatabricksSparkJarActivity

DatabricksSparkJar アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • DatabricksSparkJar

アクティビティの種類。

typeProperties.libraries
  • object[]

ジョブを実行するクラスターにインストールされるライブラリのリスト。

typeProperties.mainClassName
  • object

実行される main メソッドを含むクラスのフル ネーム。 このクラスは、ライブラリとして提供される JAR に含まれている必要があります。 型: string (または resultType 文字列を含む式)。

typeProperties.parameters
  • object[]

main メソッドに渡されるパラメーター。

userProperties

アクティビティ ユーザーのプロパティ。

DatabricksSparkPythonActivity

DatabricksSparkPython アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • DatabricksSparkPython

アクティビティの種類。

typeProperties.libraries
  • object[]

ジョブを実行するクラスターにインストールされるライブラリのリスト。

typeProperties.parameters
  • object[]

Python ファイルに渡されるコマンド ライン パラメーター。

typeProperties.pythonFile
  • object

実行される Python ファイルの URI。 DBFS パスがサポートされています。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

DataFlowReference

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

Name Type Description
datasetParameters
  • object

データセットからデータフローパラメーターを参照します。

parameters
  • object

データ フローのパラメーター

referenceName
  • string

参照データフロー名。

type enum:

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

DataFlowStagingInfo

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

Name Type Description
folderPath
  • object

ステージング blob のフォルダーパス。 Type: string (resultType 文字列を含む式)

linkedService

ステージングのリンクされたサービス参照です。

DataLakeAnalyticsUSQLActivity

Data Lake Analytics U-SQL アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • DataLakeAnalyticsU-SQL

アクティビティの種類。

typeProperties.compilationMode
  • object

U-SQL のコンパイル モード。 Semantic、Full、SingleBox のいずれかの値を指定する必要があります。 型: string (または resultType 文字列を含む式)。

typeProperties.degreeOfParallelism
  • object

ジョブを実行するために同時に使用される最大ノード数。 既定値は 1 です。 型: 整数 (または resultType 整数を含む式)、最小: 1。

typeProperties.parameters
  • object

ジョブ要求U-SQLパラメーター。

typeProperties.priority
  • object

キューされているすべてのジョブのうち、先に実行するジョブを決定します。 数値が小さいほど、優先度は高くなります。 既定値は 1,000 です。 型: 整数 (または resultType 整数を含む式)、最小: 1。

typeProperties.runtimeVersion
  • object

使用する U-SQL エンジンのランタイム バージョン。 型: string (または resultType 文字列を含む式)。

typeProperties.scriptLinkedService

リンクされたサービス参照のスクリプトを作成します。

typeProperties.scriptPath
  • object

このスクリプトを含むフォルダーへの大文字と小文字U-SQLパス。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

DatasetReference

データセット参照型。

Name Type Description
parameters
  • object

データセットの引数。

referenceName
  • string

参照データセット名。

type enum:

データセット参照型。

DeleteActivity

削除アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • Delete

アクティビティの種類。

typeProperties.dataset

アクティビティ データセット参照を削除します。

typeProperties.enableLogging
  • object

削除アクティビティの実行の詳細なログを記録するかどうか。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.logStorageSettings

enableLogging が true の場合に、お客様が指定する必要があるログ ストレージ設定。

typeProperties.maxConcurrentConnections
  • integer

データ ソースを同時に接続するための最大同時接続数。

typeProperties.recursive
  • object

true の場合、現在のフォルダー パスにあるファイルまたはサブフォルダーは再帰的に削除されます。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.storeSettings
  • StoreReadSettings

アクティビティ ストアの設定を削除します。

userProperties

アクティビティ ユーザーのプロパティ。

ExecuteDataFlowActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

linkedServiceName

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

name
  • string

アクティビティ名。

policy

アクティビティポリシー。

type string:
  • ExecuteDataFlow

アクティビティの種類。

typeProperties.compute

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

typeProperties.continueOnError
  • object

データ フローの実行に使用されるエラー設定を続行します。 シンクが失敗した場合に処理を続行できます。 型: ブール値 (または resultType ブール値を含む式)

typeProperties.dataFlow

データ フローリファレンス。

typeProperties.integrationRuntime

統合ランタイム参照。

typeProperties.runConcurrently
  • object

データ フローの実行に使用される同時実行設定。 同じ保存順序のシンクを同時に処理できます。 型: ブール値 (または resultType ブール値を含む式)

typeProperties.staging

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

typeProperties.traceLevel
  • object

データ フロー監視出力に使用されるトレース レベル設定。 サポートされる値は、'coarse'、'fine'、および 'none' です。 型: string (または resultType 文字列を含む式)

userProperties

アクティビティのユーザープロパティ。

ExecutePipelineActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • ExecutePipeline

アクティビティの種類。

typeProperties.parameters
  • object

パイプラインのパラメーター。

typeProperties.pipeline

パイプライン参照。

typeProperties.waitOnCompletion
  • boolean

依存パイプラインの実行が完了するまでアクティビティの実行を待機するかどうかを定義します。 既定値は false です。

userProperties

アクティビティのユーザープロパティ。

ExecuteSSISPackageActivity

SSIS パッケージの実行アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • ExecuteSSISPackage

アクティビティの種類。

typeProperties.connectVia

統合ランタイム参照。

typeProperties.environmentPath
  • object

SSIS パッケージを実行する環境パス。 型: string (または resultType 文字列を含む式)。

typeProperties.executionCredential

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

typeProperties.logLocation

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

typeProperties.loggingLevel
  • object

SSIS パッケージの実行のログ 記録レベル。 型: string (または resultType 文字列を含む式)。

typeProperties.packageConnectionManagers
  • object

SSIS パッケージを実行するパッケージ レベルの接続マネージャー。

typeProperties.packageLocation

SSIS パッケージの場所。

typeProperties.packageParameters

SSIS パッケージを実行するパッケージ レベルのパラメーター。

typeProperties.projectConnectionManagers
  • object

SSIS パッケージを実行するプロジェクト レベルの接続マネージャー。

typeProperties.projectParameters

SSIS パッケージを実行するプロジェクト レベルのパラメーター。

typeProperties.propertyOverrides

プロパティは、 をオーバーライドして SSIS パッケージを実行します。

typeProperties.runtime
  • object

SSIS パッケージを実行するランタイムを指定します。 値は "x86" または "x64" である必要があります。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

ExecuteWranglingDataflowActivity

Power Query アクティビティを実行します。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • ExecuteWranglingDataflow

アクティビティの種類。

typeProperties.compute

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

typeProperties.continueOnError
  • object

データ フローの実行に使用されるエラー設定を続行します。 シンクが失敗した場合に処理を続行できます。 型: ブール値 (または resultType ブール値を含む式)

typeProperties.dataFlow

データ フローリファレンス。

typeProperties.integrationRuntime

統合ランタイム参照。

typeProperties.queries

シンク データセットへのPower Queryクエリのマッピングの一覧。

typeProperties.runConcurrently
  • object

データ フローの実行に使用される同時実行設定。 同じ保存順序のシンクを同時に処理できます。 型: ブール値 (または resultType ブール値を含む式)

typeProperties.sinks

(非推奨になりました。 クエリを使用してください)。 queryName Power Queryマップされたアクティビティ シンクの一覧。

typeProperties.staging

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

typeProperties.traceLevel
  • object

データ フロー監視出力に使用されるトレース レベル設定。 サポートされる値は、'coarse'、'fine'、および 'none' です。 型: string (または resultType 文字列を含む式)

userProperties

アクティビティ ユーザーのプロパティ。

ExecutionActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • Execution

アクティビティの種類。

userProperties

アクティビティ ユーザーのプロパティ。

Expression

式の定義を Azure Data Factory します。

Name Type Description
type enum:

式の型。

value
  • string

式の値。

FailActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Fail

アクティビティの種類。

typeProperties.errorCode
  • object

Fail アクティビティのエラーの種類を分類するエラー コード。 実行時に空でない/空の文字列に評価される動的なコンテンツにすることができます。 Type: string (または resultType 文字列を含む式)。

typeProperties.message
  • object

Fail アクティビティで表示されるエラー メッセージ。 実行時に空でない/空の文字列に評価される動的なコンテンツにすることができます。 Type: string (または resultType 文字列を含む式)。

userProperties

アクティビティのユーザープロパティ。

FilterActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Filter

アクティビティの種類。

typeProperties.condition

入力のフィルター処理に使用する条件。

typeProperties.items

フィルターを適用する必要がある入力配列。

userProperties

アクティビティのユーザープロパティ。

Folder

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

Name Type Description
name
  • string

このパイプラインが含まれるフォルダーの名前。

ForEachActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • ForEach

アクティビティの種類。

typeProperties.activities Activity[]:

実行するアクティビティの一覧。

typeProperties.batchCount
  • integer

並列実行の数を制御するために使用するバッチの数 (IsSequential が false に設定されている場合)。

typeProperties.isSequential
  • boolean

ループを順番に実行するか、並列で実行するか (最大 50)

typeProperties.items

反復処理するコレクション。

userProperties

アクティビティのユーザープロパティ。

GetMetadataActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • GetMetadata

アクティビティの種類。

typeProperties.dataset

GetMetadata アクティビティ データセットリファレンス。

typeProperties.fieldList
  • object[]

データセットから取得するメタデータのフィールド。

typeProperties.formatSettings
  • FormatReadSettings

GetMetadata アクティビティ形式の設定。

typeProperties.storeSettings
  • StoreReadSettings

GetMetadata アクティビティ ストアの設定。

userProperties

アクティビティ ユーザーのプロパティ。

HDInsightActivityDebugInfoOption

使用する HDInsightActivityDebugInfoOption 設定。

Name Type Description
Always
  • string
Failure
  • string
None
  • string

HDInsightHiveActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • HDInsightHive

アクティビティの種類。

typeProperties.arguments
  • object[]

HDInsightActivity に対してユーザーが指定した引数。

typeProperties.defines
  • object

ユーザーが Hive ジョブ要求の定義を指定できます。

typeProperties.getDebugInfo

[デバッグ情報] オプション。

typeProperties.queryTimeout
  • integer

クエリのタイムアウト値 (分単位)。 HDInsight クラスターが ESP を使用している場合に有効 (Enterprise セキュリティ パッケージ)

typeProperties.scriptLinkedService

リンクされたサービス参照のスクリプトを作成します。

typeProperties.scriptPath
  • object

スクリプト パス。 型: string (または resultType 文字列を含む式)。

typeProperties.storageLinkedServices

Storageサービス参照を作成します。

typeProperties.variables
  • object[]

hivevar 名前空間の下でユーザーが指定した引数。

userProperties

アクティビティ ユーザーのプロパティ。

HDInsightMapReduceActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • HDInsightMapReduce

アクティビティの種類。

typeProperties.arguments
  • object[]

HDInsightActivity に対してユーザーが指定した引数。

typeProperties.className
  • object

クラス名。 型: string (または resultType 文字列を含む式)。

typeProperties.defines
  • object

ユーザーがジョブ要求の定義をMapReduceできます。

typeProperties.getDebugInfo

[デバッグ情報] オプション。

typeProperties.jarFilePath
  • object

Jar パス。 型: string (または resultType 文字列を含む式)。

typeProperties.jarLibs
  • object[]

Jar ライブラリ。

typeProperties.jarLinkedService

Jar のリンクされたサービスリファレンス。

typeProperties.storageLinkedServices

Storageサービス参照を作成します。

userProperties

アクティビティ ユーザーのプロパティ。

HDInsightPigActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • HDInsightPig

アクティビティの種類。

typeProperties.arguments
  • object

HDInsightActivity に対してユーザーが指定した引数。 型: 配列 (または resultType 配列を含む式)。

typeProperties.defines
  • object

ユーザーが Pig ジョブ要求の定義を指定できます。

typeProperties.getDebugInfo

[デバッグ情報] オプション。

typeProperties.scriptLinkedService

リンクされたサービス参照のスクリプトを作成します。

typeProperties.scriptPath
  • object

スクリプト パス。 型: string (または resultType 文字列を含む式)。

typeProperties.storageLinkedServices

Storageサービス参照を作成します。

userProperties

アクティビティ ユーザーのプロパティ。

HDInsightSparkActivity

HDInsight Spark アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • HDInsightSpark

アクティビティの種類。

typeProperties.arguments
  • object[]

HDInsightSparkActivity に対するユーザー指定の引数。

typeProperties.className
  • string

アプリケーションの Java/Spark メイン クラス。

typeProperties.entryFilePath
  • object

実行するコード/パッケージのルート フォルダーへの相対パス。 型: string (または resultType 文字列を含む式)。

typeProperties.getDebugInfo

[デバッグ情報] オプション。

typeProperties.proxyUser
  • object

ジョブを実行する権限を借用するユーザー。 型: string (または resultType 文字列を含む式)。

typeProperties.rootPath
  • object

すべてのジョブのファイルの 'sparkJobLinkedService' のルート パス。 型: string (または resultType 文字列を含む式)。

typeProperties.sparkConfig
  • object

Spark 構成プロパティ。

typeProperties.sparkJobLinkedService

エントリ ファイルと依存関係をアップロードし、ログを受信するストレージのリンクされたサービス。

userProperties

アクティビティ ユーザーのプロパティ。

HDInsightStreamingActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • HDInsightStreaming

アクティビティの種類。

typeProperties.arguments
  • object[]

HDInsightActivity に対してユーザーが指定した引数。

typeProperties.combiner
  • object

コンバイナー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。

typeProperties.commandEnvironment
  • object[]

コマンド ライン環境の値。

typeProperties.defines
  • object

ユーザーがストリーミング ジョブ要求の定義を指定できます。

typeProperties.fileLinkedService

ファイルが含まれるリンクされたサービス参照。

typeProperties.filePaths
  • object[]

ストリーミング ジョブ ファイルへのパス。 ディレクトリを指定できます。

typeProperties.getDebugInfo

[デバッグ情報] オプション。

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

Storageサービス参照を作成します。

userProperties

アクティビティ ユーザーのプロパティ。

IfConditionActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • IfCondition

アクティビティの種類。

typeProperties.expression

ブール型に評価される式。 これは、実行されるアクティビティ (ifTrueActivities または ifFalseActivities) のブロックを決定するために使用されます。

typeProperties.ifFalseActivities Activity[]:

式が false に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティは何も操作せずに終了します。

typeProperties.ifTrueActivities Activity[]:

式が true に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティは何も操作せずに終了します。

userProperties

アクティビティのユーザープロパティ。

IntegrationRuntimeReference

統合ランタイム参照型。

Name Type Description
parameters
  • object

統合ランタイムの引数。

referenceName
  • string

参照統合ランタイム名。

type enum:

統合ランタイムの種類。

LinkedServiceReference

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

Name Type Description
parameters
  • object

LinkedService の引数。

referenceName
  • string

参照 LinkedService 名。

type enum:

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

LogLocationSettings

ログの場所の設定。

Name Type Description
linkedServiceName

ログストレージのリンクされたサービスの参照。

path
  • object

アクティビティ実行の詳細ログを格納するためのストレージへのパス。 Type: string (または resultType 文字列を含む式)。

LogSettings

ログ設定。

Name Type Description
copyActivityLogSettings

コピー アクティビティ ログの設定を指定します。

enableCopyActivityLog
  • object

コピー アクティビティ ログを有効にするかどうかを指定します。 型: ブール値 (または resultType ブール値を含む式)。

logLocationSettings

ログを有効にするときに、お客様が指定する必要があるログの場所の設定。

LogStorageSettings

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

Name Type Description
enableReliableLogging
  • object

信頼できるログ記録を有効にするかどうかを指定します。 型: ブール値 (または resultType ブール値を含む式)。

linkedServiceName

ログ ストレージのリンクされたサービスリファレンス。

logLevel
  • object

ログ レベル、サポート:情報、警告を取得または設定します。 型: string (または resultType 文字列を含む式)。

path
  • object

アクティビティ実行の詳細なログを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。

LookupActivity

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

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • Lookup

アクティビティの種類。

typeProperties.dataset

ルックアップ アクティビティ データセットの参照。

typeProperties.firstRowOnly
  • object

最初の行またはすべての行を返すかどうか。 既定値は true です。 型: ブール値 (または resultType ブール値を含む式)。

typeProperties.source
  • CopySource

コピー アクティビティのソースと同じ、データセット固有のソース プロパティ。

userProperties

アクティビティ ユーザーのプロパティ。

ParameterSpecification

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

Name Type Description
defaultValue
  • object

パラメーターの既定値。

type

パラメーターの型。

ParameterType

パラメーターの型。

Name Type Description
Array
  • string
Bool
  • string
Float
  • string
Int
  • string
Object
  • string
SecureString
  • string
String
  • string

PipelineElapsedTimeMetricPolicy

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

Name Type Description
duration
  • object

TimeSpan 値。この値を過ぎると、Azure 監視メトリックが発生します。

PipelinePolicy

パイプライン ポリシー。

Name Type Description
elapsedTimeMetric

Pipeline ElapsedTime メトリック ポリシー。

PipelineReference

パイプライン参照の種類。

Name Type Description
name
  • string

参照名。

referenceName
  • string

参照パイプライン名。

type enum:

パイプライン参照の種類。

PipelineResource

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

Name Type Description
etag
  • string

Etag は、リソースの変更を識別します。

id
  • string

リソース識別子。

name
  • string

リソースの名前。

properties.activities Activity[]:

パイプライン内のアクティビティの一覧。

properties.annotations
  • object[]

パイプラインの記述に使用できるタグの一覧。

properties.concurrency
  • integer

パイプラインの同時実行の最大数。

properties.description
  • string

パイプラインの説明。

properties.folder

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

properties.parameters

パイプラインのパラメーターの一覧。

properties.policy

パイプライン ポリシー。

properties.runDimensions
  • object

パイプラインによって出力されるディメンション。

properties.variables

パイプラインの変数の一覧。

type
  • string

リソースの種類。

PowerQuerySink

Power query sink。

Name Type Description
dataset

データセットの参照。

description
  • string

変換の説明。

flowlet

Flowlet リファレンス

linkedService

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

name
  • string

変換名。

schemaLinkedService

スキーマのリンクされたサービス参照。

script
  • string

シンクスクリプト。

PowerQuerySinkMapping

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

Name Type Description
dataflowSinks

Power Query マッシュアップクエリにマップされているシンクの一覧。

queryName
  • string

Power Query マッシュアップドキュメント内のクエリの名前。

RedirectIncompatibleRowSettings

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

Name Type Description
linkedServiceName
  • object

互換性のない行Azure Storageリダイレクト Storage Azure Storage SAS、または Azure Data Lake Storeサービスの名前。 redirectIncompatibleRowSettings が指定されている場合は、指定する必要があります。 型: string (または resultType 文字列を含む式)。

path
  • object

リダイレクト互換性のない行データを格納するためのパス。 型: string (または resultType 文字列を含む式)。

SecureString

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

Name Type Description
type string:

シークレットの種類。

value
  • string

セキュリティで保護された文字列の値。

SetVariableActivity

変数の値を設定します。

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • SetVariable

アクティビティの種類。

typeProperties.value
  • object

設定する値。 静的な値または式である可能性があります

typeProperties.variableName
  • string

値を設定する必要がある変数の名前。

userProperties

アクティビティのユーザープロパティ。

SkipErrorFile

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

Name Type Description
dataInconsistency
  • object

ソース/シンク ファイルが他の同時書き込みによって変更された場合はスキップします。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

fileMissing
  • object

コピー中に他のクライアントによってファイルが削除された場合はスキップします。 既定値は true です。 型: ブール値 (または resultType ブール値を含む式)。

SqlServerStoredProcedureActivity

SQL アクティビティの種類を指定します。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:
  • SqlServerStoredProcedure

アクティビティの種類。

typeProperties.storedProcedureName
  • object

ストアド プロシージャ名。 型: string (または resultType 文字列を含む式)。

typeProperties.storedProcedureParameters

ストアド プロシージャ パラメーターの値と型の設定。 例: "{Parameter1: {value: "1", type: "int"}}"

userProperties

アクティビティ ユーザーのプロパティ。

SSISAccessCredential

SSIS アクセス資格情報。

Name Type Description
domain
  • object

Windows 認証のドメイン。

password SecretBase:

Windows 認証のパスワード。

userName
  • object

Windows 認証用の UseName。

SSISChildPackage

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

Name Type Description
packageContent
  • object

埋め込み子パッケージのコンテンツ。 Type: string (または resultType 文字列を含む式)。

packageLastModifiedDate
  • string

埋め込み子パッケージの最終更新日。

packageName
  • string

埋め込まれた子パッケージの名前。

packagePath
  • object

埋め込み子パッケージのパス。 Type: string (または resultType 文字列を含む式)。

SSISExecutionCredential

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

Name Type Description
domain
  • object

Windows 認証のドメイン。

password

Windows 認証のパスワード。

userName
  • object

Windows 認証には UseName を使用します。

SSISExecutionParameter

SSIS 実行パラメーター。

Name Type Description
value
  • object

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

SSISLogLocation

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

Name Type Description
logPath
  • object

SSIS パッケージの実行ログ パス。 型: string (または resultType 文字列を含む式)。

type

SSIS ログの場所の種類。

typeProperties.accessCredential

パッケージ実行ログのアクセス資格情報。

typeProperties.logRefreshInterval
  • object

ログを更新する間隔を指定します。 既定の間隔は 5 分です。 型: string (または resultType 文字列を含む式)、パターン: ((\d+) . )?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

SsisLogLocationType

SSIS ログの場所の種類。

Name Type Description
File
  • string

SSISPackageLocation

SSIS パッケージの場所。

Name Type Description
packagePath
  • object

SSIS パッケージパス。 型: string (または resultType 文字列を含む式)。

type

SSIS パッケージの場所の型。

typeProperties.accessCredential

パッケージ アクセス資格情報。

typeProperties.childPackages

埋め込み子パッケージの一覧。

typeProperties.configurationAccessCredential

構成ファイルのアクセス資格情報。

typeProperties.configurationPath
  • object

パッケージ実行の構成ファイル。 型: string (または resultType 文字列を含む式)。

typeProperties.packageContent
  • object

埋め込みパッケージのコンテンツ。 型: string (または resultType 文字列を含む式)。

typeProperties.packageLastModifiedDate
  • string

埋め込みパッケージの最終変更日。

typeProperties.packageName
  • string

パッケージの名前です。

typeProperties.packagePassword SecretBase:

パッケージのパスワード。

SsisPackageLocationType

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

Name Type Description
File
  • string
InlinePackage
  • string
PackageStore
  • string
SSISDB
  • string

SSISPropertyOverride

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

Name Type Description
isSensitive
  • boolean

SSIS パッケージ プロパティのオーバーライド値が機密データかどうか。 値が true の場合、SSISDB で暗号化されます

value
  • object

SSIS パッケージ プロパティのオーバーライド値。 型: string (または resultType 文字列を含む式)。

StagingSettings

ステージング設定。

Name Type Description
enableCompression
  • object

中間ステージングを使用してデータをコピーするときに圧縮を使用するかどうかを指定します。 既定値は false です。 型: ブール値 (または resultType ブール値を含む式)。

linkedServiceName

ステージングのリンクされたサービス参照。

path
  • object

中間データを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。

StoredProcedureParameter

SQL ストアド プロシージャ パラメーター。

Name Type Description
type

ストアド プロシージャ パラメーターの型。

value
  • object

ストアド プロシージャのパラメーター値。 型: string (または resultType 文字列を含む式)。

StoredProcedureParameterType

ストアドプロシージャパラメーターの型。

Name Type Description
Boolean
  • string
Date
  • string
Decimal
  • string
Guid
  • string
Int
  • string
Int64
  • string
String
  • string

SwitchActivity

このアクティビティは、式を評価し、equals プロパティに必要な式の評価に対応する "ケース" プロパティでアクティビティを実行します。

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Switch

アクティビティの種類。

typeProperties.cases

' On ' プロパティの予期される値に対応するケースの一覧。 これは省略可能なプロパティであり、指定されていない場合、defaultActivities に含まれるアクティビティが実行されます。

typeProperties.defaultActivities Activity[]:

Case 条件が満たされていない場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定されていない場合、アクティビティは何も操作せずに終了します。

typeProperties.on

文字列または整数に評価される式。 これは、実行されるアクティビティのブロックを決定するために使用されます。

userProperties

アクティビティのユーザープロパティ。

SwitchCase

の Switch ケースには、値と対応するアクティビティがあります。

Name Type Description
activities Activity[]:

Case 条件が満たされた場合に実行するアクティビティの一覧。

value
  • string

' On ' プロパティの式の結果を満たす値が必要です。

UntilActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Until

アクティビティの種類。

typeProperties.activities Activity[]:

実行するアクティビティの一覧。

typeProperties.expression

ブール型に評価される式。 この式が true に評価されるまで、ループは続行されます。

typeProperties.timeout
  • object

アクティビティの実行に関するタイムアウトを指定します。 値が指定されていない場合は、TimeSpan. FromDays (7) の値が使用されます。これは、既定では1週間です。 Type: string (resultType 文字列を含む式)、pattern: ((\d +) . )? (\ d\d):(60 |([0-5] [0-9]):(60 |([0-5] [0-9])。 Type: string (resultType 文字列を含む式)、pattern: ((\d +) . )? (\ d\d):(60 |([0-5] [0-9]):(60 |([0-5] [0-9])。

userProperties

アクティビティのユーザープロパティ。

UserProperty

User プロパティ。

Name Type Description
name
  • string

ユーザープロパティ名。

value
  • object

ユーザープロパティの値。 Type: string (または resultType 文字列を含む式)。

ValidationActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Validation

アクティビティの種類。

typeProperties.childItems
  • object

データセットがフォルダーを指している場合に使用できます。 True に設定した場合、フォルダーには少なくとも1つのファイルが必要です。 False に設定した場合、フォルダーは空にする必要があります。 型: boolean (または resultType ブール値を含む式)。

typeProperties.dataset

検証アクティビティデータセット参照。

typeProperties.minimumSize
  • object

データセットがファイルを指している場合に使用できます。 ファイルのサイズは、指定された値以上である必要があります。 型: 整数 (または resultType 整数を含む式)。

typeProperties.sleep
  • object

検証の試行間の遅延 (秒単位)。 値が指定されていない場合、既定値として10秒が使用されます。 型: 整数 (または resultType 整数を含む式)。

typeProperties.timeout
  • object

アクティビティの実行に関するタイムアウトを指定します。 値が指定されていない場合は、TimeSpan. FromDays (7) の値が使用されます。これは、既定では1週間です。 Type: string (resultType 文字列を含む式)、pattern: ((\d +) . )? (\ d\d):(60 |([0-5] [0-9]):(60 |([0-5] [0-9])。

userProperties

アクティビティのユーザープロパティ。

VariableSpecification

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

Name Type Description
defaultValue
  • object

変数の既定値。

type

変数の型。

VariableType

変数の型。

Name Type Description
Array
  • string
Bool
  • string
String
  • string

WaitActivity

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

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • Wait

アクティビティの種類。

typeProperties.waitTimeInSeconds
  • object

継続時間 (秒)。

userProperties

アクティビティのユーザープロパティ。

WebActivity

Web アクティビティ。

Name Type Description
dependsOn

アクティビティは条件によって異なります。

description
  • string

アクティビティの説明。

linkedServiceName

リンクされたサービスリファレンス。

name
  • string

アクティビティ名。

policy

アクティビティ ポリシー。

type string:

アクティビティの種類。

typeProperties.authentication

エンドポイントを呼び出すために使用される認証方法。

typeProperties.body
  • object

エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドには必須です。GET メソッド Type: string (または resultType 文字列を含む式) には使用されません。

typeProperties.connectVia

統合ランタイム参照。

typeProperties.datasets

Web エンドポイントに渡されるデータセットの一覧。

typeProperties.headers
  • object

要求に送信されるヘッダーを表します。 たとえば、要求に種類と言語を設定する場合: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。

typeProperties.linkedServices

Web エンドポイントに渡されるリンクされたサービスの一覧。

typeProperties.method

ターゲット エンドポイントの Rest API メソッド。

typeProperties.url
  • object

Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。

userProperties

アクティビティ ユーザーのプロパティ。

WebActivityAuthentication

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

Name Type Description
credential

認証情報を含む資格情報の参照。

password SecretBase:

PFX ファイルのパスワードまたは基本認証/ServicePrincipal に使用する場合のシークレット

pfx SecretBase:

ServicePrincipal に使用する場合の PFX ファイルまたは証明書の Base64 でエンコードされたコンテンツ

resource
  • object

MSI 認証を使用するときに Azure 認証トークンが要求されるリソース。 型: string (または resultType 文字列を含む式)。

type
  • string

Web アクティビティ認証 (Basic/ClientCertificate/MSI/ServicePrincipal)

userTenant
  • object

ServicePrincipal 認証を使用するときに Azure 認証トークンが要求される TenantId。 Type: string (または resultType 文字列を含む式)。

username
  • object

基本認証の Web アクティビティ認証ユーザー名、または ServicePrincipal に使用する場合は ClientID。 型: string (または resultType 文字列を含む式)。

WebActivityMethod

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

Name Type Description
DELETE
  • string
GET
  • string
POST
  • string
PUT
  • string

WebHookActivity

WebHook アクティビティ。

Name Type Description
dependsOn

アクティビティは条件に依存します。

description
  • string

アクティビティの説明。

name
  • string

アクティビティ名。

type string:
  • WebHook

アクティビティの種類。

typeProperties.authentication

エンドポイントを呼び出すために使用される認証方法。

typeProperties.body
  • object

エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須ですが、GET メソッド Type: string (または resultType 文字列を含む式) では使用できません。

typeProperties.headers
  • object

要求に送信されるヘッダーを表します。 たとえば、要求に種類と言語を設定する場合: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 Type: string (または resultType 文字列を含む式)。

typeProperties.method

ターゲットエンドポイントの Rest API メソッド。

typeProperties.reportStatusOnCallBack
  • object

True に設定すると、コールバック要求本文の statusCode、output、および error がアクティビティによって使用されます。 このアクティビティは、コールバック要求で statusCode >= 400 を設定することによって、失敗としてマークできます。 既定値は false です。 型: boolean (または resultType ブール値を含む式)。

typeProperties.timeout
  • string

Webhook をコールバックする必要があるタイムアウト。 値が指定されていない場合は、既定で10分に設定されます。 型: string。 Pattern: ((\d +) . )? (\ d\d):(60 |([0-5] [0-9]):(60 |([0-5] [0-9])。

typeProperties.url
  • object

WebHook アクティビティのターゲットエンドポイントとパス。 Type: string (または resultType 文字列を含む式)。

userProperties

アクティビティのユーザープロパティ。

WebHookActivityMethod

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

Name Type Description
POST
  • string