Start-AzSynapseDataFlowDebugSession

Module:

Az.Synapse

Starts a Synapse Analytics data flow debug session in Synapse Workspace.

Syntax

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

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

Description

This long running command starts a data flow debug session for the upcoming debug commands. This command can attach with an integration runtime definition to configure the size/type of debug session cluster. The PowerShell command sequence for data flow debug workflow should be:

1. Start-AzSynapseDataFlowDebugSession
2. Add-AzSynapseDataFlowDebugSessionPackage
3. Invoke-AzSynapseDataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file)
4. Stop-AzSynapseDataFlowDebugSession

Examples

Example 1

Start-AzSynapseDataFlowDebugSession -WorkspaceName ContosoWorkspace

This command starts an Azure Synapse Analytics data flow debug session.

Example 2

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

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

This command starts an Azure Synapse Analytics data flow debug session through pipeline.

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-IntegrationRuntimeFile

The JSON file path.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

Outputs

PSCreateDataFlowDebugSessionResponse