Invoke-AzDataFactoryV2DataFlowDebugSessionCommand

  • Reference
Module:
Az.DataFactory

Invoke debug action in data flow debug session.

Syntax

Invoke-AzDataFactoryV2DataFlowDebugSessionCommand
      [-SessionId] <String>
      [-Command] <String>
      [-StreamName] <String>
      [[-RowLimit] <Int32>]
      [[-Expression] <String>]
      [[-Columns] <System.Collections.Generic.List`1[System.String]>]
      [-AsJob]
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzDataFactoryV2DataFlowDebugSessionCommand
      [-SessionId] <String>
      [-Command] <String>
      [-StreamName] <String>
      [[-RowLimit] <Int32>]
      [[-Expression] <String>]
      [[-Columns] <System.Collections.Generic.List`1[System.String]>]
      [-AsJob]
      [-DataFactory] <PSDataFactory>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzDataFactoryV2DataFlowDebugSessionCommand
      [-SessionId] <String>
      [-Command] <String>
      [-StreamName] <String>
      [[-RowLimit] <Int32>]
      [[-Expression] <String>]
      [[-Columns] <System.Collections.Generic.List`1[System.String]>]
      [-AsJob]
      [-ResourceId] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

This command executes data preview/stats preview/expression preview for different stream of data flow in debug session. 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

$result = Invoke-AzDataFactoryV2DataFlowDebugSessionCommand -ResourceGroupName adf -DataFactoryName WiKiADF -Command executePreviewQuery -SessionId fd76cd0d-8b37-4dc0-a370-3f9d43ac686d -StreamName source1 -RowLimit 100 -AsJob
$result

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
3      Long Running... AzureLongRun... Running       True            localhost            Invoke-AzDataFactoryV2...


(After 2 minutes)

$result

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
3      Long Running... AzureLongRun... Completed     True            localhost            Invoke-AzDataFactoryV2...

$output = ConvertFrom-Json($result.Output.Data)
$output.output

    {
      "schema": "output(ResourceAgencyNum as string, PublicName as string)" ,
      "data": [["4445679354", "Syrian Refugee Information", 1], ["44456793", "Syrian Refugee Information", 1]]
    }

This example invokes data preview command for debug session "fd76cd0d-8b37-4dc0-a370-3f9d43ac686d" in data factory "WiKiADF" and then convert the JSON output into readable string.

Parameters

-AsJob

Run cmdlet in the background

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

-Columns

The columns list for data flow statistics preview.

Type:List<T>[String]
Position:7
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Command

The data flow debug command. Optionals are executePreviewQuery, executeStatisticsQuery and executeExpressionQuery

Type:String
Position:3
Default value:None
Required:True
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

-Expression

The expression for data flow expression preview.

Type:String
Position:6
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

-RowLimit

The row limit for data flow data preview.

Type:Nullable<T>[Int32]
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionId

The data flow debug session ID.

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

-StreamName

The stream name of data flow for debugging.

Type:String
Position:4
Default value:None
Required:True
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

Inputs

String

PSDataFactory

Outputs

PSDataFlowDebugSessionCommandResult

Notes

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