你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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
在后台运行 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
有关管道运行的信息。
类型: | PSPipelineResource |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-IsRecovery
恢复模式标志。 如果恢复模式设置为 true,则指定的引用管道运行,并将新运行分组到同一 groupId 下。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Parameter
管道运行的参数。
类型: | Hashtable |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ParameterFile
包含管道运行参数的文件的名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PipelineName
管道名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-ReferencePipelineRunId
用于重新运行的管道运行 ID。 如果指定了运行 ID,则指定的运行的参数将用于创建新运行。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-StartActivityName
在恢复模式下,重新运行将从此活动开始。 如果未指定,则所有活动都将运行。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | 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 |