Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApplicationUpgradeDescription

Package version

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.

Hierarchy

  • ApplicationUpgradeDescription

Index

Properties

Optional applicationHealthPolicy

applicationHealthPolicy: ApplicationHealthPolicy

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

Optional forceRestart

forceRestart: undefined | false | true

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

Optional monitoringPolicy

monitoringPolicy: MonitoringPolicyDescription

Describes the parameters for monitoring an upgrade in Monitored mode.

name

name: string

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

Optional parameters

parameters: ApplicationParameter[]

List of application parameters with overridden values from their default values specified in the application manifest.

Optional rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.

Optional sortOrder

sortOrder: UpgradeSortOrder

Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.

targetApplicationTypeVersion

targetApplicationTypeVersion: string

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

upgradeKind

upgradeKind: UpgradeKind

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

Optional upgradeReplicaSetCheckTimeoutInSeconds

upgradeReplicaSetCheckTimeoutInSeconds: undefined | number

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

Generated using TypeDoc