Invoke-AzDataFactoryV2Pipeline

リファレンス

モジュール:: Az.DataFactory

パイプラインを呼び出して実行を開始します。

構文

Invoke-AzDataFactoryV2Pipeline
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-PipelineName] <String>
      [[-ParameterFile] <String>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-InputObject] <PSPipeline>
      [[-ParameterFile] <String>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-InputObject] <PSPipeline>
      [[-Parameter] <Hashtable>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-PipelineName] <String>
      [[-Parameter] <Hashtable>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Invoke-AzDataFactoryV2Pipeline コマンドは、指定されたパイプラインで実行を開始し、その実行の ID を返します。この GUID を Get-AzDataFactoryV2PipelineRun に渡すか、Get-AzDataFactoryV2ActivityRun をして、この実行に関する詳細を取得できます。

例

例 1: パイプラインを呼び出して実行を開始する

Invoke-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample"

867d9d9f-1efc-4fee-974d-d8e6320bfbcb

このコマンドは、"WikiADF" ファクトリで "DPWikisample" パイプラインの実行を開始します。

例 2

パイプラインを呼び出して実行を開始します。 (自動生成)

Invoke-AzDataFactoryV2Pipeline -DataFactoryName 'WikiADF' -Parameter <Hashtable> -PipelineName 'DPWikisample' -ResourceGroupName 'ADF'

パラメーター

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataFactoryName

データファクトリ名。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

データファクトリオブジェクト。

型:	PSPipeline
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-IsRecovery

回復モードフラグ。復旧モードが true に設定されている場合、指定された参照されるパイプラインの実行と、新しい実行が同じ groupId の下にグループ化されます。

型:	SwitchParameter
配置:	5
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Parameter

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

型:	Hashtable
配置:	3
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ParameterFile

パイプライン実行のパラメーターを含むファイルの名前。

型:	String
配置:	3
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PipelineName

パイプライン名。

型:	String
配置:	2
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ReferencePipelineRunId

再実行するパイプライン実行 ID。実行 ID を指定すると、指定した実行のパラメーターを使用して新しい実行が作成されます。

型:	String
配置:	4
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループ名。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-StartActivityName

復旧モードでは、再実行はこのアクティビティから開始されます。指定しない場合、すべてのアクティビティが実行されます。

型:	String
配置:	6
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-StartFromFailure

失敗したアクティビティフラグから再実行を開始します。復旧モードで指定した場合、再実行は失敗したアクティビティから開始されます。

型:	SwitchParameter
配置:	7
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行してもコマンドレットが実行されない場合の動作を示します。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSPipeline

String

Hashtable

出力