Get-AzureRmDataFactoryV2ActivityRun

NAME Get-AzureRmDataFactoryV2ActivityRun



SYNOPSIS

Gets information about activity runs for a pipeline run.





SYNTAX

Get-AzureRmDataFactoryV2ActivityRun [-DataFactory] <PSDataFactory> [-PipelineRunId] <String> [-RunStartedAfter] <DateTime> [-RunStartedBefore]

<DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>] [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]



Get-AzureRmDataFactoryV2ActivityRun [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineRunId] <String> [-RunStartedAfter]

<DateTime> [-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>] [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmDataFactoryV2ActivityRun cmdlet gets information about runs in Azure Data Factory for the specified pipeline run that happened in

the given timeframe. Additionally, you can specify filters for activity name, linked service name that executed the run, and the status of the run.





PARAMETERS

-ActivityName <String>

The name of the activity.



Required? false

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DataFactory <PSDataFactory>

The data factory object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-DataFactoryName <String>

The data factory name.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LinkedServiceName <String>

The linked service name.



Required? false

Position? 6

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PipelineRunId <String>

The Run ID of the pipeline.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

The resource group name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RunStartedAfter <DateTime>

The time at or after which the pipeline run started to execute.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RunStartedBefore <DateTime>

The time at or before which the pipeline run started to execute.



Required? true

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Status <String>

The status of the pipeline run.



Required? false

Position? 5

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory

System.String





OUTPUTS

System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun, Microsoft.Azure.Commands.DataFactoryV2,

Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]

Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun





NOTES









Example 1: Get all activity runs for a pipeline run



PS C:\\> Get-AzureRmDataFactoryV2ActivityRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId

"f288712d-fb08-4cb8-96ef-82d3b9b30621" -RunStartedAfter "2017-09-01" -RunStartedBefore "2017-09-30"



ResourceGroupName : ADF

DataFactoryName : WikiADF

ActivityName : MyWebActivity

PipelineRunId : f288712d-fb08-4cb8-96ef-82d3b9b30621

PipelineName : DPWikisample

Input : {method, url, headers, body...}

Output : {operationstatus}

LinkedServiceName :

ActivityRunStart : 9/14/2017 12:20:57 AM

ActivityRunEnd : 9/14/2017 12:21:00 AM

DurationInMs : 2768

Status : Succeeded

Error : {errorCode, message, failureType, target}



This command gets details about all activity runs in the pipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between

"2017-09-01" and "2017-09-30".







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ctivityrun

Invoke-AzureRmDataFactoryV2Pipeline

Get-AzureRmDataFactoryV2PipelineRun