Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureDataFactoryPipeline

Remove-AzureDataFactoryPipeline

microsoft.azure.commands.datafactories.dll

Synopsis

Removes a pipeline from Data Factory.

Syntax

Remove-AzureDataFactoryPipeline [-ResourceGroupName] [-DataFactoryName] [-Name] [-Force] [<CommonParameters>]

Remove-AzureDataFactoryPipeline [-DataFactory] [-Name] [-Force] [<CommonParameters>]

Detailed Description

The Remove-AzureDataFactoryPipeline cmdlet removes a pipeline from Azure Data Factory.

You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.

Parameters

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet removes a pipeline from the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet removes a pipeline from the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Indicates that this cmdlet removes a pipeline without prompting you for confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the name of the pipeline to remove.

Aliases

PipelineName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet removes a pipeline from the group that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

System.Boolean

Notes

None

Examples

Example 1: Remove a pipeline

This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. The command returns a value of $True.

                    PS C:\> Remove-AzureDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF"
                    Confirm
                    Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'?
                    [Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y
                    True
                

Get-AzureDataFactoryPipeline
New-AzureDataFactoryPipeline
Resume-AzureDataFactoryPipeline
Set-AzureDataFactoryPipelineActivePeriod
Suspend-AzureDataFactoryPipeline