Invoke-AzSynapsePipeline
パイプラインを呼び出して実行を開始します。
構文
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 |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
パイプラインの実行に関する情報。
型: | PSPipelineResource |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IsRecovery
回復モード フラグ。 復旧モードが true に設定されている場合、指定された参照されるパイプラインの実行と、新しい実行が同じ groupId の下にグループ化されます。
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameter
パイプライン実行のパラメーター。
型: | Hashtable |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ParameterFile
パイプライン実行のパラメーターを含むファイルの名前。
型: | String |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PipelineName
パイプライン名。
型: | String |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReferencePipelineRunId
再実行するパイプライン実行 ID。 実行 ID を指定すると、指定した実行のパラメーターを使用して新しい実行が作成されます。
型: | String |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartActivityName
復旧モードでは、再実行はこのアクティビティから開始されます。 指定しない場合、すべてのアクティビティが実行されます。
型: | String |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WorkspaceName
Synapse ワークスペースの名前。
型: | String |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
型: | PSSynapseWorkspace |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
入力
出力
Azure PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示