Share via


Get-ServiceFabricComposeDeploymentUpgrade

This cmdlet is in PREVIEW and is subject to change in the next release(s). There is no compatibility guarantee. Gets the status of a Service Fabric compose deployment upgrade.

Syntax

Default (Default)

Get-ServiceFabricComposeDeploymentUpgrade
    [-DeploymentName] <String>
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Get-ServiceFabricComposeDeploymentUpgrade cmdlet gets the status of a Service Fabric compose deployment upgrade.

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 compose deployment upgrade status

PS C:\> Get-ServiceFabricComposeDeploymentUpgrade -Deployment mydeployment

This command gets the status of the compose deployment upgrade for the specified compose deployment.

Parameters

-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

-TimeoutSec

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

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

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.

Inputs

System.String

Outputs

System.Object