Stop-AzureRmDataFactoryV2PipelineRun

NAME Stop-AzureRmDataFactoryV2PipelineRun



SYNOPSIS

Stops a pieline run in a data factory.





SYNTAX

Stop-AzureRmDataFactoryV2PipelineRun [-DataFactory] <PSDataFactory> [-PipelineRunId] <String> [-DefaultProfile <IAzureContextContainer>]

[-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]



Stop-AzureRmDataFactoryV2PipelineRun [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineRunId] <String> [-DefaultProfile

<IAzureContextContainer>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]



Stop-AzureRmDataFactoryV2PipelineRun [-InputObject] <PSPipelineRun> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Stop-AzureRmDataFactoryV2PipelineRun cmdlet stops a pipeline run in a data factory specified with the pieline run ID.





PARAMETERS

-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



-InputObject <PSPipelineRun>

The Run ID of the pipeline.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

If specified the cmdlet write true in case operation succeeds.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PipelineRunId <String>

The Run ID of the pipeline.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

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.PSPipelineRun

System.String Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory





OUTPUTS

System.Boolean







NOTES









Example 1



PS C:\\> Stop-AzureRmDataFactoryV2PipelineRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineRunId

b9730a13-aa12-4926-a8b3-8e3a974ab0bd



Confirm

Are you sure you want to stop pipeline run 'b9730a13-aa12-4926-a8b3-8e3a974ab0bd' in data factory 'WikiADF'?

[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y



true



This command stops the pipeline run with id b9730a13-aa12-4926-a8b3-8e3a974ab0bd in the factory WikiADF.







RELATED LINKS

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