Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Compose Deployment

Gets details for the latest upgrade performed on this Service Fabric compose deployment.

Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.

get/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress

Path parameters

deploymentNamestring required

The identity of the deployment.

Query parameters

api-version'6.0-preview' required

The version of the API. This parameter is required and its value must be '"6.0-preview'.

timeoutinteger

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Response

Details about the compose deployment upgrade.

DeploymentNamestring

The name of the target deployment.

ApplicationNamestring

The name of the target application, including the 'fabric:' URI scheme.

UpgradeState'Invalid' | 'ProvisioningTarget' | 'RollingForwardInProgress' | 'RollingForwardPending' | 'UnprovisioningCurrent' | 'RollingForwardCompleted' | 'RollingBackInProgress' | 'UnprovisioningTarget' | 'RollingBackCompleted' | 'Failed'

The state of the compose deployment upgrade.

UpgradeStatusDetailsstring

Additional detailed information about the status of the pending upgrade.

UpgradeKind'Invalid' | 'Rolling'

The kind of upgrade out of the following possible values.

RollingUpgradeMode'Invalid' | 'UnmonitoredAuto' | 'UnmonitoredManual' | 'Monitored' | 'UnmonitoredDeferred'

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.

ForceRestartboolean

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

UpgradeReplicaSetCheckTimeoutInSecondsinteger

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

TargetApplicationTypeVersionstring

The target application type version (found in the application manifest) for the application upgrade.

UpgradeDurationstring

The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

CurrentUpgradeDomainDurationstring

The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

StartTimestampUtcstring

The estimated UTC datetime when the upgrade started.

FailureTimestampUtcstring

The estimated UTC datetime when the upgrade failed and FailureAction was executed.

FailureReason'None' | 'Interrupted' | 'HealthCheck' | 'UpgradeDomainTimeout' | 'OverallUpgradeTimeout'

The cause of an upgrade failure that resulted in FailureAction being executed.

ApplicationUpgradeStatusDetailsstring

Additional details of application upgrade including failure message.