Share via

Get-ServiceFabricComposeDeploymentStatus

  • Reference
Module:
ServiceFabric

PREVIEW. Gets all or a specific compose deployment status in the Service Fabric cluster.

Syntax

Get-ServiceFabricComposeDeploymentStatus
   [[-DeploymentName] <String>]
   [-MaxResults <Int64>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

This cmdlet is in PREVIEW and is subject to change in the next release(s). There is no compatibility guarantee.

The Get-ServiceFabricComposeDeploymentStatus cmdlet gets all or a specific compose deployment status in the Service Fabric cluster. For guidance of Service Fabric compose deployment, please refer to: Compose Deployment support in 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: Get all the compose deployment status

PS C:\> Get-ServiceFabricComposeDeploymentStatus

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

Example 2: Get the compose deployment status by name

PS C:\> Get-ServiceFabricComposeDeploymentStatus -DeploymentName mydeployment

This command gets the specific compose deployment status with deployment name: mydeployment.

Parameters

-DeploymentName

Specifies the name of compose deployment. The cmdlet gets the compose deployment status that has the specified deployment name. If you do not specify this parameter, this cmdlet gets all the compose deployment status in the cluster.

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

Inputs

System.String

Outputs

System.Object