Suspend-CMPhasedDeployment

Reference

Module:: ConfigurationManager

Use this cmdlet to suspend the specified phased deployment.

Syntax

Suspend-CMPhasedDeployment
       [-Force]
       -InputObject <IResultObject>
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-CMPhasedDeployment
       [-Force]
       -Id <String>
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-CMPhasedDeployment
       [-Force]
       -Name <String>
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Use this cmdlet to suspend the specified phased deployment.

Examples

Example 1: Suspend the deployment by name

This example suspends the phased deployment that you specify by name.

Suspend-CMPhasedDeployment -Name "myPhasedDeploymentName"

Example 2: Force suspend the deployment by piped object

This example force suspends the phased deployment that you pipe on the command line.

$myPhasedDeployment | Suspend-CMPhasedDeployment -Force

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Force suspend the phased deployment.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior. It's not recommended. You can't combine it with DisableWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specify the ID of the phased deployment to suspend. The ID is a GUID format.

Type:	String
Aliases:	PhasedDeploymentId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specify an object for the phased deployment to suspend.

Type:	IResultObject
Aliases:	PhasedDeployment
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specify the name of the phased deployment to suspend.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object