Share via

Remove-ServiceFabricComposeDeployment

  • Reference
Module:
ServiceFabric

PREVIEW. Removes a Service Fabric compose deployment.

Syntax

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Required: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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Object