ApplicationUpgradeDescription Class
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.
All required parameters must be populated in order to send to Azure.
- Inheritance
-
ApplicationUpgradeDescription
Constructor
ApplicationUpgradeDescription(*, name: str, target_application_type_version: str, parameters=None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: Optional[int] = None, force_restart: Optional[bool] = None, sort_order='Default', monitoring_policy=None, application_health_policy=None, instance_close_delay_duration_in_seconds: Optional[int] = None, managed_application_identity=None, **kwargs)Parameters
- target_application_type_version
- str
Required. The target application type version (found in the application manifest) for the application upgrade.
- parameters
- list[ApplicationParameter]
List of application parameters with overridden values from their default values specified in the application manifest.
- 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
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_replica_set_check_timeout_in_seconds
- <xref:long>
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).
- 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).
- sort_order
- str or UpgradeSortOrder
Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: "Default" .
- monitoring_policy
- MonitoringPolicyDescription
Describes the parameters for monitoring an upgrade in Monitored mode.
- application_health_policy
- ApplicationHealthPolicy
Defines a health policy used to evaluate the health of an application or one of its children entities.
- instance_close_delay_duration_in_seconds
- <xref:long>
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. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.
- managed_application_identity
- ManagedApplicationIdentityDescription
Managed application identity description.
Feedback
Submit and view feedback for