Share via


IUpdateRunProperties Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.UpdateRunPropertiesTypeConverter))]
public interface IUpdateRunProperties : Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.IJsonSerializable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.UpdateRunPropertiesTypeConverter))>]
type IUpdateRunProperties = interface
    interface IJsonSerializable
Public Interface IUpdateRunProperties
Implements IJsonSerializable
Derived
Attributes
Implements

Properties

AdditionalInfo

The error additional info.

Code

The error code.

Detail

The error details.

Message

The error message.

NodeImageSelectionSelectedNodeImageVersion

The image versions to upgrade the nodes to.

NodeImageSelectionType

The node image upgrade type.

ProvisioningState

The provisioning state of the UpdateRun resource.

StatusCompletedTime

The time the operation or group was completed.

StatusStage

The stages composing an update run. Stages are run sequentially withing an UpdateRun.

StatusStartTime

The time the operation or group was started.

StatusState

The State of the operation or group.

StrategyStage

The list of stages that compose this update run. Min size: 1.

Target

The error target.

UpdateStrategyId

The resource id of the FleetUpdateStrategy resource to reference. When creating a new run, there are three ways to define a strategy for the run:

  1. Define a new strategy in place: Set the "strategy" field.
  2. Use an existing strategy: Set the "updateStrategyId" field. (since 2023-08-15-preview)
  3. Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. (since 2023-08-15-preview) Setting both "updateStrategyId" and "strategy" is invalid. UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun.
UpgradeKubernetesVersion

The Kubernetes version to upgrade the member clusters to.

UpgradeType

The upgrade type. Full requires the KubernetesVersion property to be set. NodeImageOnly requires the KubernetesVersion property not to be set.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to