Suspend-SCACServiceDeployment
Suspend-SCACServiceDeployment
Suspends the specified service deployment.
Syntax
Parameter Set: Default
Suspend-SCACServiceDeployment [-ServiceDeployment] <ACServiceDeployment> [[-RunAsynchronously]] [ <CommonParameters>]
Detailed Description
The Suspend-SCACServiceDeployment cmdlet suspends the specified service deployment. To resume a service deployment, use the Resume-SCACServiceDeployment cmdlet.
Parameters
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceDeployment<ACServiceDeployment>
Specifies a service deployment object. To get a service deployment object, use the Get-SCACServiceDeployment cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.SystemCenter.CloudManager.PowerShell.ACServiceDeployment, System.Management.Automation.SwitchParameter
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.SystemCenter.CloudManager.PowerShell.ACServiceDeployment
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
The first command gets the cloud system object named CloudSystem01 and stores the object in the $CloudSystem variable.
The second command gets the cloud object for the cloud system stored in $CloudSystem and stores the cloud object in the $Cloud variable.
The third command gets all service deployment objects for the cloud stored in $Cloud and stores the objects in the $SvcDeployment array.
The last command suspends the first service deployment stored in $SvcDeployment, and runs the command asynchronously so that control returns to the command shell immediately, before the command stops running.
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name "CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud -CloudSystem $CloudSystem
PS C:\> $SvcDeployment = @(Get-SCACServiceDeployment -Cloud $Cloud)
PS C:\> Suspend-SCACServiceDeployment -ServiceDeployment $SvcDeployment[0] -RunAsynchronously