次の方法で共有

Stop-AzSynapsePipelineRun

  • リファレンス
モジュール:
Az.Synapse

ワークスペースでのパイプラインの実行を停止します。

構文

Stop-AzSynapsePipelineRun
    -WorkspaceName <String>
    -PipelineRunId <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzSynapsePipelineRun
    -WorkspaceObject <PSSynapseWorkspace>
    -PipelineRunId <String>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzSynapsePipelineRun
    -InputObject <PSPipelineRun>
    [-PassThru]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Stop-AzSynapsePipelineRun コマンドレットは、パイプライン実行 ID で指定されたワークスペースでパイプラインの実行を停止します。

例

例 1

Stop-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd

このコマンドは、ワークスペース ContosoWorkspace の id b9730a13-aa12-4926-a8b3-8e3a974ab0bd でパイプラインの実行を停止します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Stop-AzSynapsePipelineRun -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd

このコマンドは、パイプライン経由でワークスペース ContosoWorkspace 内の id b9730a13-aa12-4926-a8b3-8e3a974ab0bd でパイプラインの実行を停止します。

例 3

$pipelineRun = Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd
$pipelineRun | Stop-AzSynapsePipelineRun

このコマンドは、パイプライン経由でワークスペース ContosoWorkspace 内の id b9730a13-aa12-4926-a8b3-8e3a974ab0bd でパイプラインの実行を停止します。

パラメーター

-AsJob

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:PSPipelineRun
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

このコマンドレットは、既定ではオブジェクトを返しません。 このスイッチを指定すると、成功した場合は true が返されます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PipelineRunId

パイプライン実行の識別子。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

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

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

PSSynapseWorkspace

PSPipelineRun

出力

Boolean