Invoke-AzSynapseDataFlowDebugSessionCommand

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>]

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

$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 出力を読み取り可能な文字列に変換します。

$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" のデータ プレビュー コマンドを呼び出します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。