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

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Column

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

型:	List<T>[String]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Command

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Expression

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RowLimit

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

型:	Nullable<T>[Int32]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SessionId

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StreamName

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceName

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceObject

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

型:	PSSynapseWorkspace
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

PSSynapseWorkspace

出力

PSDataFlowDebugCommandResponse

次の方法で共有