Suspend-​Azure​Rm​Data​Factory​Pipeline

Suspends a pipeline in Azure Data Factory.

Syntax

Suspend-AzureRmDataFactoryPipeline
       [-DataFactory] <PSDataFactory>
       [-Name] <String>
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]
Suspend-AzureRmDataFactoryPipeline
       [-ResourceGroupName] <String>
       [-DataFactoryName] <String>
       [-Name] <String>
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Description

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

Examples

Example 1: Suspend a pipeline

PS C:\>Suspend-AzureRmDataFactoryPipeline -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

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

Required Parameters

-DataFactory

Specifies a PSDataFactory object. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.

Type:PSDataFactory
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DataFactoryName

Specifies the name of a data factory. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the pipeline to suspend.

Type:String
Aliases:PipelineName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of an Azure resource group. This cmdlet suspends a pipeline that belongs to the group that this parameter specifies.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.Boolean

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, data, factories