次の方法で共有

Invoke-AzSynapseDataFlowDebugSessionCommand

  • リファレンス
モジュール:
Az.Synapse

データ フロー デバッグ セッションでデバッグ アクションを呼び出します。

構文

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

例

例 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

バックグラウンドでコマンドレットを実行する

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Column

データ フロー統計プレビューの列リスト。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Command

データ フロー デバッグ コマンド。 省略可能なオプションは、executePreviewQuery、executeStatisticsQuery、および executeExpressionQuery です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expression

データ フロー式プレビューの式。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RowLimit

データ フロー データ プレビューの行制限。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionId

Synapse データ フロー デバッグ セッションの識別子。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StreamName

デバッグ用のデータ フローのストリーム名。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Synapse ワークスペースの名前。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

PSSynapseWorkspace

出力

PSDataFlowDebugCommandResponse