次の方法で共有

Add-AzSynapseDataFlowDebugSessionPackage

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

データ フロー リソースとその依存関係を特定のデータ フロー デバッグ セッションに追加します。

構文

Add-AzSynapseDataFlowDebugSessionPackage
   -WorkspaceName <String>
   -PackageFile <String>
   [-SessionId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzSynapseDataFlowDebugSessionPackage
   -WorkspaceObject <PSSynapseWorkspace>
   -PackageFile <String>
   [-SessionId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

このコマンドは、データ フロー リソースとその依存関係を特定のデバッグ セッションにアタッチします。 データ フロー デバッグ ワークフローの PowerShell コマンド シーケンスは次のようになります。

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

例

例 1

Add-AzSynapseDataFlowDebugSessionPackage -WorkspaceName ContosoWorkspace -PackageFile "D:\dataflowps\addpackage.json" -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc

Synapse ワークスペース "ContosoWorkspace" の下のデバッグ セッション "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" にデータ フロー パッケージを追加します。 Pakcage ファイルには、データ フロー デバッグ リソース、データセット デバッグ リソースの一覧、リンクされたサービス デバッグ リソースの一覧、デバッグ設定、セッション ID が含まれています。 [-SessionId] パラメーターは省略可能です。指定すると、パッケージ ファイル内の既存の sessionId プロパティが置き換えられます。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Add-AzSynapseDataFlowDebugSessionPackage -PackageFile "D:\dataflowps\addpackage.json" -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc

パイプラインを介して Synapse ワークスペース "ContosoWorkspace" の下のデバッグ セッション "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" にデータ フロー パッケージを追加します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-PackageFile

JSON ファイルのパス。

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

-SessionId

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る: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

出力

PSAddDataFlowToDebugSessionResponse