ApplicationUpgradeProgressInfo Class

Describes the parameters for an application upgrade.

Inheritance

Model

ApplicationUpgradeProgressInfo

Constructor

ApplicationUpgradeProgressInfo(*, name: Optional[str] = None, type_name: Optional[str] = None, target_application_type_version: Optional[str] = None, upgrade_domains=None, upgrade_units=None, upgrade_state=None, next_upgrade_domain: Optional[str] = None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds: Optional[str] = None, upgrade_domain_duration_in_milliseconds: Optional[str] = None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, current_upgrade_units_progress=None, start_timestamp_utc: Optional[str] = None, failure_timestamp_utc: Optional[str] = None, failure_reason=None, upgrade_domain_progress_at_failure=None, upgrade_status_details: Optional[str] = None, is_node_by_node: bool = False, **kwargs)

Parameters

name

str

Required

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

type_name

str

Required

The application type name as defined in the application manifest.

target_application_type_version

str

Required

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

upgrade_domains

list[UpgradeDomainInfo]

Required

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

upgrade_units

list[UpgradeUnitInfo]

Required

List of upgrade units and their statuses.

upgrade_state

str or UpgradeState

Required

The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

next_upgrade_domain

str

Required

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

rolling_upgrade_mode

str or UpgradeMode

Required

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred'. Default value: "UnmonitoredAuto" .

upgrade_description

ApplicationUpgradeDescription

Required

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.

upgrade_duration_in_milliseconds

str

Required

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

upgrade_domain_duration_in_milliseconds

str

Required

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

unhealthy_evaluations

list[HealthEvaluationWrapper]

Required

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

current_upgrade_domain_progress

CurrentUpgradeDomainProgressInfo

Required

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

current_upgrade_units_progress

CurrentUpgradeUnitsProgressInfo

Required

Information about the current in-progress upgrade units.

start_timestamp_utc

str

Required

The estimated UTC datetime when the upgrade started.

failure_timestamp_utc

str

Required

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

failure_reason

str or FailureReason

Required

The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

upgrade_domain_progress_at_failure

FailureUpgradeDomainProgressInfo

Required

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

upgrade_status_details

str

Required

Additional detailed information about the status of the pending upgrade.

is_node_by_node

bool

Required

Indicates whether this upgrade is node-by-node. Default value: False .