Stop-AzSynapsePipelineRun
停止工作區中的管線執行。
語法
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>] Description
Stop-AzSynapsePipelineRun Cmdlet 會停止使用管線執行標識符指定的工作區中的管線執行。
範例
範例 1
Stop-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd此命令會停止工作區 ContosoWorkspace 中標識符為 b9730a13-aa12-4926-a8b3-8e3a974ab0bd 的管線執行。
範例 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Stop-AzSynapsePipelineRun -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd此命令會停止在工作區中透過管線執行標識符為 b9730a13-aa12-4926-a8b3-8e3a974ab0bd 的管線執行。
範例 3
$pipelineRun = Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId b9730a13-aa12-4926-a8b3-8e3a974ab0bd
$pipelineRun | Stop-AzSynapsePipelineRun此命令會停止在工作區中透過管線執行標識符為 b9730a13-aa12-4926-a8b3-8e3a974ab0bd 的管線執行。
參數
-AsJob
在背景執行 Cmdlet
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
| 類型: | SwitchParameter |
| 別名: | cf |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
| 類型: | IAzureContextContainer |
| 別名: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-InputObject
管線執行的相關信息。
| 類型: | PSPipelineRun |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-PassThru
此 Cmdlet 預設不會傳回 物件。 如果指定此參數，如果成功，則會傳回 true。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-PipelineRunId
管線執行標識碼。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。
| 類型: | SwitchParameter |
| 別名: | wi |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-WorkspaceName
Synapse 工作區的名稱。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-WorkspaceObject
工作區輸入物件，通常是透過管線傳遞。
| 類型: | PSSynapseWorkspace |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |