Invoke-AzSynapsePipeline

モジュール:

Az.Synapse

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

構文

Invoke-AzSynapsePipeline
      -WorkspaceName <String>
      -PipelineName <String>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzSynapsePipeline
      -InputObject <PSPipelineResource>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzSynapsePipeline
      -WorkspaceObject <PSSynapseWorkspace>
      -PipelineName <String>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

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

例

例 1

Invoke-AzSynapsePipeline -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline

このコマンドは、ワークスペース ContosoWorkspace で ContosoPipeline というパイプラインの実行を開始します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Invoke-AzSynapsePipeline -PipelineName ContosoPipeline

このコマンドは、ワークスペース ContosoWorkspace 内の ContosoPipeline というパイプラインの実行をパイプライン経由で開始します。

例 3

$pipeline = Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline
$pipeline | Invoke-AzSynapsePipeline

このコマンドは、ワークスペース ContosoWorkspace 内の ContosoPipeline というパイプラインの実行をパイプライン経由で開始します。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

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

-Confirm

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

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

-DefaultProfile

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

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

-InputObject

パイプラインの実行に関する情報。

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

-IsRecovery

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

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

-Parameter

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

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

-ParameterFile

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

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

-PipelineName

パイプライン名。

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

-ReferencePipelineRunId

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

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

-StartActivityName

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

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

-WorkspaceName

Synapse ワークスペースの名前。

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

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

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

入力

PSPipelineResource

PSSynapseWorkspace

出力

PSCreateRunResponse