次の方法で共有

Start-AzSynapseDataFlowDebugSession

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

Synapse ワークスペースで Synapse Analytics データ フロー デバッグ セッションを開始します。

構文

Start-AzSynapseDataFlowDebugSession
     -WorkspaceName <String>
     [-IntegrationRuntimeFile <String>]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzSynapseDataFlowDebugSession
     -WorkspaceObject <PSSynapseWorkspace>
     [-IntegrationRuntimeFile <String>]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

この実行時間の長いコマンドは、今後のデバッグ コマンドのデータ フロー デバッグ セッションを開始します。 このコマンドを統合ランタイム定義にアタッチして、デバッグ セッション クラスターのサイズ/種類を構成できます。 データ フロー デバッグ ワークフローの PowerShell コマンド シーケンスは次のようになります。

  1. Start-AzSynapseDataFlowDebugSession
  2. Add-AzSynapseDataFlowDebugSessionPackage
  3. Invoke-AzSynapseDataFlowDebugSessionCommand (さまざまなコマンド/ターゲットに対してこの手順を繰り返すか、パッケージ ファイルを変更するために手順 2 から 3 を繰り返します)
  4. Stop-AzSynapseDataFlowDebugSession

例

例 1

Start-AzSynapseDataFlowDebugSession -WorkspaceName ContosoWorkspace

このコマンドは、Azure Synapse Analytics データ フローデバッグ セッションを開始します。

例 2

$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace -ResourceGroupName GroupName  
$result = $ws | Start-AzSynapseDataFlowDebugSession  
$result

SessionId
---------
b75f917c-1a5e-432e-a1b9-ec6aabb1f546

このコマンドは、パイプラインを介して Azure Synapse Analytics データ フローデバッグ セッションを開始します。

パラメーター

-AsJob

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-IntegrationRuntimeFile

JSON ファイルのパス。

Type:String
Aliases:File
Position:Named
Default value:None
Required:False
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

出力

PSCreateDataFlowDebugSessionResponse