Remove-​Service​Fabric​Compose​Application

This cmdlet is for PREVIEW feature and is subject to change in the next release(s). There is no compatibility guarantee. Removes a Service Fabric compsoe application deployment. For guidance of Service Fabric compose application deployment, please refer to: Compose Application support in Service Fabric (https://docs.microsoft.com/azure/service-fabric/service-fabric-docker-compose)

Syntax

Remove-ServiceFabricComposeApplication
      [-ApplicationName] <Uri>
      [-Force]
      [-TimeoutSec <Int32>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-ServiceFabricComposeApplication cmdlet removes a compose application 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.

Examples

Example 1: Remove a compose application deployment

PS C:\> Remove-ServiceFabricComposeApplication -ApplicationName fabric:/mycomposedeployment -Force

This command removes the compose application deployment that has the application name: fabric:/mycomposedeployment. Because this command includes the Force parameter, the cmdlet does not prompt you for confirmation before it removes the compose application deployment.

Required Parameters

-ApplicationName

Specifies the Uniform Resource Identifier (URI) of a Service Fabric application. To get the names (URI) of the currently deployed compose applications, use Get-ServiceFabricComposeApplicationStatus. The cmdlet removes the compose application deployment that has the application name that you specify.

Type:Uri
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:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
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 application deployment is undetermined.

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

Inputs

System.Uri

This cmdlet accepts a URI that represents the name of a Service Fabric compose application deployment.

Outputs

System.Object

This cmdlet returns the status of the operation as a string.