Get-AzureRmDataFactoryV2PipelineRun
Gets information about pipeline runs.
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-AzureRmDataFactoryV2PipelineRun
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-PipelineRunId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2PipelineRun
[-DataFactory] <PSDataFactory>
[-PipelineRunId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2PipelineRun
[-DataFactory] <PSDataFactory>
[-LastUpdatedAfter] <DateTime>
[-LastUpdatedBefore] <DateTime>
[[-PipelineName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2PipelineRun
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-LastUpdatedAfter] <DateTime>
[-LastUpdatedBefore] <DateTime>
[[-PipelineName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmDataFactoryV2PipelineRun command returns information about runs for the specified pipeline. If PipelineRunId is specified, it shows details for the run with that ID. If the PipelineRunId is not specified, then it shows information about all runs for the specified pipeline that happened between the values of LastUpdatedAfter and LastUpdatedBefore.
Examples
Example 1: Get information for a pipline run
PS C:\> Get-AzureRmDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId "61eb095a-fe23-4591-8a97-fade6c65ca72"
ResourceGroupName : ADF
DataFactoryName : WikiADF
RunId : 61eb095a-fe23-4591-8a97-fade6c65ca72
PipelineName : DPWikisample
LastUpdated : 9/14/2017 12:21:02 AM
Parameters : {[url, http://adfsamplewebapi.azurewebsites.net/api/execute/sample]}
RunStart : 9/14/2017 12:20:54 AM
RunEnd : 9/14/2017 12:21:02 AM
DurationInMs : 8246
Status : Succeeded
Message :
This command gets details about the pipeline run with ID "61eb095a-fe23-4591-8a97-fade6c65ca72".
Parameters
-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 |
-LastUpdatedAfter
The time at or after which the pipeline run was updated in ISO8601 format.
Type: | DateTime |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LastUpdatedBefore
The time at or before which the pipeline run was updated in ISO8601 format.
Type: | DateTime |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PipelineName
The pipeline name.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PipelineRunId
The Run ID of the pipeline.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Inputs
Parameters: DataFactory (ByValue)