Start-AzDataFactoryV2DataFlowDebugSession

Module:

Az.DataFactory

Starts a data flow debug session in Azure Data Factory

Syntax

Start-AzDataFactoryV2DataFlowDebugSession
     [[-IntegrationRuntimeFile] <String>]
     [-AsJob]
     [-ResourceGroupName] <String>
     [-DataFactoryName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzDataFactoryV2DataFlowDebugSession
     [[-IntegrationRuntimeFile] <String>]
     [-AsJob]
     [-DataFactory] <PSDataFactory>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzDataFactoryV2DataFlowDebugSession
     [[-IntegrationRuntimeFile] <String>]
     [-AsJob]
     [-ResourceId] <String>
     [-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-AzDataFactoryV2DataFlowDebugSession
2. Add-AzDataFactoryV2DataFlowDebugSessionPackage
3. Invoke-AzDataFactoryV2DataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file)
4. Stop-AzDataFactoryV2DataFlowDebugSession

Examples

Example 1

$job = Start-AzDataFactoryV2DataFlowDebugSession -ResourceGroupName adf -DataFactoryName jikma0601sea -AsJob
$job 

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Long Running... AzureLongRun... Running       True            localhost            Start-AzDataFactoryV2D...

(After 5 minutes)

$job

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Long Running... AzureLongRun... Completed     True            localhost            Start-AzDataFactoryV2D...


$job.Output

SessionId                            Status
---------                            ------
550effe4-93a3-485c-8525-eaf25259efbd Succeeded

Starts a debug session with AsJob flag.

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

-DataFactory

The data factory object.

Type:	PSDataFactory
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DataFactoryName

The data factory name.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

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

-ResourceId

The Azure resource ID.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
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

Inputs

String

PSDataFactory

Outputs

PSDataFlowDebugSession

Notes

Keywords: azure, azurerm, arm, resource, management, manager, data, factories

Related Links

• Get-AzDataFactoryV2DataFlowDebugSession
• Add-AzDataFactoryV2DataFlowDebugSessionPackage
• Invoke-AzDataFactoryV2DataFlowDebugSessionCommand
• Stop-AzDataFactoryV2DataFlowDebugSession