ApplicationUpgradePolicy interface

Describes the policy for a monitored application upgrade.

Properties

applicationHealthPolicy

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

forceRestart

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

recreateApplication

Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss.

rollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade

upgradeMode

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

upgradeReplicaSetCheckTimeout

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

Property Details

applicationHealthPolicy

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

applicationHealthPolicy?: ArmApplicationHealthPolicy

Property Value

forceRestart

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

forceRestart?: boolean

Property Value

boolean

recreateApplication

Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss.

recreateApplication?: boolean

Property Value

boolean

rollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade

rollingUpgradeMonitoringPolicy?: ArmRollingUpgradeMonitoringPolicy

Property Value

upgradeMode

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

upgradeMode?: string

Property Value

string

upgradeReplicaSetCheckTimeout

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

upgradeReplicaSetCheckTimeout?: string

Property Value

string