Share via

RuntimeRollingUpgradeUpdateMonitoringPolicy interface

Package:
@azure/arm-servicefabricmanagedclusters

Describes the parameters for updating a rolling upgrade of application or cluster.

Properties

failureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode
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).
healthCheckRetryTimeoutInMilliseconds

The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. 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.
healthCheckStableDurationInMilliseconds

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next 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.
healthCheckWaitDurationInMilliseconds

The amount of time to wait after completing an upgrade domain before applying health policies. 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.
instanceCloseDelayDurationInSeconds

Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description.
replicaSetCheckTimeoutInMilliseconds

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

The mode used to monitor health during a rolling upgrade.
upgradeDomainTimeoutInMilliseconds

The amount of time each upgrade domain has to complete before FailureAction is executed. 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.
upgradeTimeoutInMilliseconds

The amount of time the overall upgrade has to complete before FailureAction is executed. 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.

Property Details

failureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode

failureAction?: string

Property Value

string

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

healthCheckRetryTimeoutInMilliseconds

The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. 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.

healthCheckRetryTimeoutInMilliseconds?: string

Property Value

string

healthCheckStableDurationInMilliseconds

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next 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.

healthCheckStableDurationInMilliseconds?: string

Property Value

string

healthCheckWaitDurationInMilliseconds

The amount of time to wait after completing an upgrade domain before applying health policies. 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.

healthCheckWaitDurationInMilliseconds?: string

Property Value

string

instanceCloseDelayDurationInSeconds

Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description.

instanceCloseDelayDurationInSeconds?: number

Property Value

number

replicaSetCheckTimeoutInMilliseconds

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

replicaSetCheckTimeoutInMilliseconds?: number

Property Value

number

rollingUpgradeMode

The mode used to monitor health during a rolling upgrade.

rollingUpgradeMode: string

Property Value

string

upgradeDomainTimeoutInMilliseconds

The amount of time each upgrade domain has to complete before FailureAction is executed. 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.

upgradeDomainTimeoutInMilliseconds?: string

Property Value

string

upgradeTimeoutInMilliseconds

The amount of time the overall upgrade has to complete before FailureAction is executed. 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.

upgradeTimeoutInMilliseconds?: string

Property Value

string