ApplicationUpgradeProgressInfo

  • Article

Describes the parameters for an application upgrade.

Properties

Name Type Required
Name string No
TypeName string No
TargetApplicationTypeVersion string No
UpgradeDomains array of UpgradeDomainInfo No
UpgradeUnits array of UpgradeUnitInfo No
UpgradeState string (enum) No
NextUpgradeDomain string No
RollingUpgradeMode string (enum) No
UpgradeDescription ApplicationUpgradeDescription No
UpgradeDurationInMilliseconds string No
UpgradeDomainDurationInMilliseconds string No
UnhealthyEvaluations array of HealthEvaluationWrapper No
CurrentUpgradeDomainProgress CurrentUpgradeDomainProgressInfo No
CurrentUpgradeUnitsProgress CurrentUpgradeUnitsProgressInfo No
StartTimestampUtc string No
FailureTimestampUtc string No
FailureReason string (enum) No
UpgradeDomainProgressAtFailure FailureUpgradeDomainProgressInfo No
UpgradeStatusDetails string No
IsNodeByNode boolean No

Name

Type: string
Required: No

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

TypeName

Type: string
Required: No

The application type name as defined in the application manifest.

TargetApplicationTypeVersion

Type: string
Required: No

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

UpgradeDomains

Type: array of UpgradeDomainInfo
Required: No

List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.

UpgradeUnits

Type: array of UpgradeUnitInfo
Required: No

List of upgrade units and their statuses.

UpgradeState

Type: string (enum)
Required: No

The state of the upgrade domain.

Possible values are:

  • Invalid - Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • RollingBackInProgress - The upgrade is rolling back to the previous version but is not complete yet. The value is 1
  • RollingBackCompleted - The upgrade has finished rolling back. The value is 2
  • RollingForwardPending - The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
  • RollingForwardInProgress - The upgrade is rolling forward to the target version but is not complete yet. The value is 4
  • RollingForwardCompleted - The upgrade has finished rolling forward. The value is 5
  • Failed - The upgrade has failed and is unable to execute FailureAction. The value is 6

NextUpgradeDomain

Type: string
Required: No

The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.

RollingUpgradeMode

Type: string (enum)
Required: No
Default: UnmonitoredAuto

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

Possible values are:

  • Invalid - Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • UnmonitoredAuto - The upgrade will proceed automatically without performing any health monitoring. The value is 1
  • UnmonitoredManual - The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
  • Monitored - The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
  • UnmonitoredDeferred - Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4

UpgradeDescription

Type: ApplicationUpgradeDescription
Required: No

Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

UpgradeDurationInMilliseconds

Type: string
Required: No

The estimated total amount of time spent processing the overall upgrade.

UpgradeDomainDurationInMilliseconds

Type: string
Required: No

The estimated total amount of time spent processing the current upgrade domain.

UnhealthyEvaluations

Type: array of HealthEvaluationWrapper
Required: No

List of health evaluations that resulted in the current aggregated health state.

CurrentUpgradeDomainProgress

Type: CurrentUpgradeDomainProgressInfo
Required: No

Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.

CurrentUpgradeUnitsProgress

Type: CurrentUpgradeUnitsProgressInfo
Required: No

Information about the current in-progress upgrade units.

StartTimestampUtc

Type: string
Required: No

The estimated UTC datetime when the upgrade started.

FailureTimestampUtc

Type: string
Required: No

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

FailureReason

Type: string (enum)
Required: No

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

Possible values are:

  • None - Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero.
  • Interrupted - There was an external request to roll back the upgrade. The value is 1
  • HealthCheck - The upgrade failed due to health policy violations. The value is 2
  • UpgradeDomainTimeout - An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3
  • OverallUpgradeTimeout - The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4

UpgradeDomainProgressAtFailure

Type: FailureUpgradeDomainProgressInfo
Required: No

Information about the upgrade domain progress at the time of upgrade failure.

UpgradeStatusDetails

Type: string
Required: No

Additional detailed information about the status of the pending upgrade.

IsNodeByNode

Type: boolean
Required: No
Default: false

Indicates whether this upgrade is node-by-node.