Share via

AutoUpgradeProfileProperties interface

Package:
@azure/arm-containerservicefleet

The properties of the AutoUpgradeProfile.

Properties

autoUpgradeProfileStatus

The status of the auto upgrade profile.
channel

Configures how auto-upgrade will be run.
disabled

If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
longTermSupport

If upgrade channel is not TargetKubernetesVersion, this field must be False. If set to True: Fleet auto upgrade will continue generate update runs for patches of minor versions earlier than N-2 (where N is the latest supported minor version) if those minor versions support Long-Term Support (LTS). By default, this is set to False. For more information on AKS LTS, please see https://learn.microsoft.com/en-us/azure/aks/long-term-support
nodeImageSelection

The node image upgrade to be applied to the target clusters in auto upgrade.
provisioningState

The provisioning state of the AutoUpgradeProfile resource.
targetKubernetesVersion

This is the target Kubernetes version for auto-upgrade. The format must be {major version}.{minor version}. For example, "1.30". By default, this is empty. If upgrade channel is set to TargetKubernetesVersion, this field must not be empty. If upgrade channel is Rapid, Stable or NodeImage, this field must be empty.
updateStrategyId

The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.

Property Details

autoUpgradeProfileStatus

The status of the auto upgrade profile.

autoUpgradeProfileStatus?: AutoUpgradeProfileStatus

Property Value

AutoUpgradeProfileStatus

channel

Configures how auto-upgrade will be run.

channel: string

Property Value

string

disabled

If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.

disabled?: boolean

Property Value

boolean

longTermSupport

If upgrade channel is not TargetKubernetesVersion, this field must be False. If set to True: Fleet auto upgrade will continue generate update runs for patches of minor versions earlier than N-2 (where N is the latest supported minor version) if those minor versions support Long-Term Support (LTS). By default, this is set to False. For more information on AKS LTS, please see https://learn.microsoft.com/en-us/azure/aks/long-term-support

longTermSupport?: boolean

Property Value

boolean

nodeImageSelection

The node image upgrade to be applied to the target clusters in auto upgrade.

nodeImageSelection?: AutoUpgradeNodeImageSelection

Property Value

AutoUpgradeNodeImageSelection

provisioningState

The provisioning state of the AutoUpgradeProfile resource.

provisioningState?: string

Property Value

string

targetKubernetesVersion

This is the target Kubernetes version for auto-upgrade. The format must be {major version}.{minor version}. For example, "1.30". By default, this is empty. If upgrade channel is set to TargetKubernetesVersion, this field must not be empty. If upgrade channel is Rapid, Stable or NodeImage, this field must be empty.

targetKubernetesVersion?: string

Property Value

string

updateStrategyId

The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.

updateStrategyId?: string

Property Value

string