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
 

Suspend-AzureDataFactoryPipeline

Suspend-AzureDataFactoryPipeline

microsoft.azure.commands.datafactories.dll

Synopsis

Suspends a pipeline in Data Factory.

Syntax

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

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

Detailed Description

The Suspend-AzureDataFactoryPipeline cmdlet suspends a pipeline in Azure Data Factory. You can resume the pipeline by using the Resume-AzureDataFactoryPipeline cmdlet.

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 suspends a pipeline that belongs to 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 suspends a pipeline that belongs to 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 suspends 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 suspend.

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 suspends a pipeline that belongs to 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: Suspend a pipeline

This command suspends the pipeline named DPWikiSample in the data factory named WikiADF. The command returns a value of $True.

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

Get-AzureDataFactoryPipeline
New-AzureDataFactoryPipeline
Remove-AzureDataFactoryPipeline
Resume-AzureDataFactoryPipeline
Set-AzureDataFactoryPipelineActivePeriod