ClusterUpgradePolicy Class

Describes the policy used when upgrading the cluster.

All required parameters must be populated in order to send to Azure.

Constructor

ClusterUpgradePolicy(*, upgrade_replica_set_check_timeout: str, health_check_wait_duration: str, health_check_stable_duration: str, health_check_retry_timeout: str, upgrade_timeout: str, upgrade_domain_timeout: str, health_policy: _models.ClusterHealthPolicy, force_restart: bool | None = None, delta_health_policy: _models.ClusterUpgradeDeltaHealthPolicy | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
force_restart	bool 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	str 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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_wait_duration	str The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_stable_duration	str The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_retry_timeout	str The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
upgrade_timeout	str The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
upgrade_domain_timeout	str The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_policy	ClusterHealthPolicy The cluster health policy used when upgrading the cluster. Required.
delta_health_policy	ClusterUpgradeDeltaHealthPolicy The cluster delta health policy used when upgrading the cluster.

Variables

Name	Description
force_restart	bool 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	str 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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_wait_duration	str The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_stable_duration	str The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_check_retry_timeout	str The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
upgrade_timeout	str The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
upgrade_domain_timeout	str The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. Required.
health_policy	ClusterHealthPolicy The cluster health policy used when upgrading the cluster. Required.
delta_health_policy	ClusterUpgradeDeltaHealthPolicy The cluster delta health policy used when upgrading the cluster.