Remove-ServiceFabricComposeDeployment
PREVIEW. Removes a Service Fabric compose deployment.
Syntax
Default (Default)
Remove-ServiceFabricComposeDeployment
[-DeploymentName] <String>
[-Force]
[-TimeoutSec <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet is in PREVIEW and is subject to change in the next release(s). There is no compatibility guarantee.
The Remove-ServiceFabricComposeDeployment cmdlet removes a compose deployment from Service Fabric.
Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.
For guidance of Service Fabric compose deployment, please refer to: Compose Deployment support in Service Fabric.
Examples
Example 1: Remove a compose deployment
PS C:\> Remove-ServiceFabricComposeDeployment -DeploymentName mydeployment -Force
This command removes the compose deployment that has the deployment name: mydeployment. Because this command includes the Force parameter, the cmdlet does not prompt you for confirmation before it removes the compose deployment.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DeploymentName
Specifies the name of compose deployment. To get the name of the currently compose deployment, use Get-ServiceFabricComposeDeploymentStatus. The cmdlet removes the compose deployment that has the deployment name that you specify.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TimeoutSec
Specifies the time-out period, in seconds, for the operation. If the operation times out, the state of the compose deployment is undetermined.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.