你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 cmdlet 在使用管道运行 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

在后台运行 cmdlet

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

默认情况下，此 Cmdlet 不返回对象。如果指定了此开关，则如果成功，则返回 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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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