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

Invoke-AzSynapsePipeline

调用管道以为其启动运行。

语法

NewByName (默认值)

Invoke-AzSynapsePipeline
    -WorkspaceName <String>
    -PipelineName <String>
    [-Parameter <Hashtable>]
    [-ParameterFile <String>]
    [-ReferencePipelineRunId <String>]
    [-IsRecovery]
    [-StartActivityName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByInputObject

Invoke-AzSynapsePipeline
    -InputObject <PSPipelineResource>
    [-Parameter <Hashtable>]
    [-ParameterFile <String>]
    [-ReferencePipelineRunId <String>]
    [-IsRecovery]
    [-StartActivityName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByObject

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-AzSynapsePipelineRunGet-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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

有关管道运行的信息。

参数属性

类型:PSPipelineResource
默认值:None
支持通配符:False
不显示:False

参数集

NewByInputObject
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IsRecovery

恢复模式标志。 如果恢复模式设置为 true,则指定的引用管道运行,并将新运行分组到同一 groupId 下。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Parameter

管道运行的参数。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ParameterFile

包含管道运行参数的文件的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PipelineName

管道名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

NewByName
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
NewByObject
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReferencePipelineRunId

用于重新运行的管道运行 ID。 如果指定了运行 ID,则指定的运行的参数将用于创建新运行。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-StartActivityName

在恢复模式下,重新运行将从此活动开始。 如果未指定,则所有活动都将运行。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WorkspaceName

Synapse 工作区的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

NewByName
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WorkspaceObject

工作区输入对象,通常通过管道传递。

参数属性

类型:PSSynapseWorkspace
默认值:None
支持通配符:False
不显示:False

参数集

NewByObject
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PSPipelineResource

PSSynapseWorkspace

输出

PSCreateRunResponse