Get-AzureRmDataFactoryV2ActivityRun
Gets information about activity runs for a pipeline run.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmDataFactoryV2ActivityRun
[-PipelineRunId] <String>
[-RunStartedAfter] <DateTime>
[-RunStartedBefore] <DateTime>
[[-ActivityName] <String>]
[[-Status] <String>]
[[-LinkedServiceName] <String>]
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmDataFactoryV2ActivityRun
[-PipelineRunId] <String>
[-RunStartedAfter] <DateTime>
[-RunStartedBefore] <DateTime>
[[-ActivityName] <String>]
[[-Status] <String>]
[[-LinkedServiceName] <String>]
[-DataFactory] <PSDataFactory>
[-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.
Examples
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".
Parameters
-ActivityName
The name of the activity.
| Type: | String |
| Position: | 4 |
| 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: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LinkedServiceName
The linked service name.
| Type: | String |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PipelineRunId
The Run ID of the pipeline.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| 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 |
-RunStartedAfter
The time at or after which the pipeline run started to execute.
| Type: | DateTime |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunStartedBefore
The time at or before which the pipeline run started to execute.
| Type: | DateTime |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
The status of the pipeline run.
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Parameters: DataFactory (ByValue)