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

Invoke-AzSynapseDataFlowDebugSessionCommand

在数据流调试会话中调用调试作。

语法

InvokeByName (默认值)

Invoke-AzSynapseDataFlowDebugSessionCommand
    -WorkspaceName <String>
    -SessionId <String>
    -Command <String>
    -StreamName <String>
    [-RowLimit <Int32>]
    [-Expression <String>]
    [-Column <System.Collections.Generic.List`1[System.String]>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InvokeByObject

Invoke-AzSynapseDataFlowDebugSessionCommand
    -WorkspaceObject <PSSynapseWorkspace>
    -SessionId <String>
    -Command <String>
    -StreamName <String>
    [-RowLimit <Int32>]
    [-Expression <String>]
    [-Column <System.Collections.Generic.List`1[System.String]>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

此命令针对调试会话中数据流的不同流执行数据预览/统计信息预览/表达式预览。 数据流调试工作流的 PowerShell 命令序列应为:

Start-AzSynapseDataFlowDebugSession Add-AzSynapseDataFlowDebugSessionPackage Invoke-AzSynapseDataFlowDebugSessionCommand(针对不同的命令/目标重复此步骤,或重复步骤 2-3 以更改包文件)Stop-AzSynapseDataFlowDebugSession

示例

示例 1

$result = Invoke-AzSynapseDataFlowDebugSessionCommand -WorkspaceName ContosoWorkspace -Command executePreviewQuery -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc -StreamName source1 -RowLimit 100 -AsJob
$result | Format-Table -wrap

Id     Name                       PSJobTypeName          State         HasMoreData     Location         Command
--     ----                       -------------          -----         -----------     --------         -------
1      Long Running Operation     AzureLongRunningJob`1  Completed     True            localhost        Invoke-AzSynapseDataFlowDebugSessionCommand
       for 'Invoke-AzSynapseD
       ataFlowDebugSessionCommand'

$output = ConvertFrom-Json($result.Output.Data)
$output.output

    {
      "schema": "output(ResourceAgencyNum as string, PublicName as string)" ,
      "data": [["4445679354", "Syrian Refugee Information", 1], ["44456793", "Syrian Refugee Information", 1]]
    }

此示例在 Synapse 工作区“ContosoWorkspace”中调用调试会话“3afb278e-ac5f-469f-a0b6-2f04c3ab59bc”的数据预览命令,然后将 JSON 输出转换为可读字符串。

示例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Invoke-AzSynapseDataFlowDebugSessionCommand -Command executePreviewQuery -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc -StreamName source1 -RowLimit 100

此示例通过管道调用 Synapse 工作区“ContosoWorkspace”中调试会话“3afb278e-ac5f-469f-a0b6-2f04c3ab59bc”的数据预览命令。

参数

-AsJob

在后台运行 cmdlet

参数属性

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

参数集

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

-Column

数据流统计信息预览的列列表。

参数属性

类型:

List<T>[String]

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

参数集

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

-Command

数据流调试命令。 可选项为 executePreviewQuery、executeStatisticsQuery 和 executeExpressionQuery。

参数属性

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

参数集

(All)
Position:Named
必需:True
来自管道的值: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

-Expression

数据流表达式预览的表达式。

参数属性

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

参数集

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

-RowLimit

数据流数据预览的行限制。

参数属性

类型:

Nullable<T>[Int32]

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

参数集

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

-SessionId

Synapse 数据流调试会话的标识符。

参数属性

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

参数集

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

-StreamName

用于调试的数据流的流名称。

参数属性

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

参数集

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

-WhatIf

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

参数属性

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

参数集

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

-WorkspaceName

Synapse 工作区的名称。

参数属性

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

参数集

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

-WorkspaceObject

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

参数属性

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

参数集

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

CommonParameters

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

输入

PSSynapseWorkspace

输出

PSDataFlowDebugCommandResponse