Start-AzSynapseDataFlowDebugSession

Module:

Az.Synapse Module

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

Syntax

StartByName (Default)

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

StartByObject

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IntegrationRuntimeFile

The JSON file path.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	File

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

StartByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseWorkspace
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

StartByObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

Outputs

PSCreateDataFlowDebugSessionResponse