ComposeDeploymentUpgradeProgressInfo Class

Describes the parameters for a compose deployment upgrade.

Inheritance

Model

ComposeDeploymentUpgradeProgressInfo

Constructor

ComposeDeploymentUpgradeProgressInfo(*, deployment_name: Optional[str] = None, application_name: Optional[str] = None, upgrade_state=None, upgrade_status_details: Optional[str] = None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', force_restart: Optional[bool] = None, upgrade_replica_set_check_timeout_in_seconds: Optional[int] = None, monitoring_policy=None, application_health_policy=None, target_application_type_version: Optional[str] = None, upgrade_duration: Optional[str] = None, current_upgrade_domain_duration: Optional[str] = None, application_unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc: Optional[str] = None, failure_timestamp_utc: Optional[str] = None, failure_reason=None, upgrade_domain_progress_at_failure=None, application_upgrade_status_details: Optional[str] = None, **kwargs)

Parameters

deployment_name

str

Required

The name of the target deployment.

application_name

str

Required

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

upgrade_state

str or ComposeDeploymentUpgradeState

Required

The state of the compose deployment upgrade. Possible values include: 'Invalid', 'ProvisioningTarget', 'RollingForwardInProgress', 'RollingForwardPending', 'UnprovisioningCurrent', 'RollingForwardCompleted', 'RollingBackInProgress', 'UnprovisioningTarget', 'RollingBackCompleted', 'Failed'

upgrade_status_details

str

Required

Additional detailed information about the status of the pending upgrade.

upgrade_kind

str or UpgradeKind

Required

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: "Rolling" .

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" .

force_restart

bool

Required

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

upgrade_replica_set_check_timeout_in_seconds

<xref:long>

Required

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).

monitoring_policy

MonitoringPolicyDescription

Required

Describes the parameters for monitoring an upgrade in Monitored mode.

application_health_policy

ApplicationHealthPolicy

Required

Defines a health policy used to evaluate the health of an application or one of its children entities.

target_application_type_version

str

Required

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

upgrade_duration

str

Required

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.

current_upgrade_domain_duration

str

Required

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.

application_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.

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.

application_upgrade_status_details

str

Required

Additional details of application upgrade including failure message.