Get-​Service​Fabric​Compose​Application​Status

This cmdlet is for PREVIEW feature and is subject to change in the next release(s). There is no compatibility guarantee. Gets all or a specific compose application deployment status in the Service Fabric cluster. 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

Get-ServiceFabricComposeApplicationStatus
   [[-ApplicationName] <Uri>]
   [-MaxResults <Int64>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

The Get-ServiceFabricComposeApplicationStatus cmdlet gets all or a specific compose application deployment status in the Service Fabric cluster.

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: Get all the compose application deployment status

PS C:\> Get-ServiceFabricComposeApplicationStatus

This command gets all the compose application deployment status in the cluster.

Example 2: Get the compose application deployment status by name

PS C:\> Get-ServiceFabricComposeApplicationStatus -ApplicationName fabric:/MyCompose

This command gets the specific compose application deployment status with application name fabric:/MyCompose.

Optional Parameters

-ApplicationName

Specifies the Uniform Resource Identifier (URI) of a Service Fabric application. The cmdlet gets the compose application deployment status that has the specified URI. If you do not specify this parameter, this cmdlet gets all the compose application deployment status in the cluster.

Type:Uri
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MaxResults

The maximum number of results to be returned. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the cmdlet will return with no upper bound.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

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

Inputs

System.Uri

A URI that represents the name of the Service Fabric compose application deployment used as filter for the request.

Outputs

System.Object

This cmdlet returns Microsoft.ServiceFabric.Preview.Client.Query.ComposeApplicationStatusResultItem objects that represent requested compose application deployments.