Microsoft.ContainerService (stable:2023-10-15)

2025/07/29 • 5 updated methods

UpdateRuns_ListByFleet (updated)
Description :  List UpdateRun resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_ListByFleet",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "status": [
                  {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "stages": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "groups": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ],
                            "members": {
                              "$properties": {
                                "status": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "NotStarted",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                        ],
                                        [
                                          "Running",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                        ],
                                        [
                                          "Stopping",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                        ],
                                        [
                                          "Stopped",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                        ],
                                        [
                                          "Skipped",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                        ],
                                        [
                                          "Failed",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                        ],
                                        [
                                          "Pending",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                        ],
                                        [
                                          "Completed",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "NotStarted",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                        ],
                                        [
                                          "Running",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                        ],
                                        [
                                          "Stopping",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                        ],
                                        [
                                          "Stopped",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                        ],
                                        [
                                          "Skipped",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                        ],
                                        [
                                          "Failed",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                        ],
                                        [
                                          "Completed",
                                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        },
                        "afterStageWaitStatus": [
                          {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The UpdateRun items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Get (updated)
Description :  Get a UpdateRun
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the UpdateRun resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_CreateOrUpdate (updated)
Description :  Create a UpdateRun
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the UpdateRun resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A multi-stage process to perform update operations across members of a Fleet. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Start (updated)
Description :  Starts an UpdateRun.
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_Start",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the UpdateRun resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Stop (updated)
Description :  Stops an UpdateRun.
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_Stop",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "status": [
              {
                "status": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Pending",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ],
                      "old": [
                        [
                          "NotStarted",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                        ],
                        [
                          "Running",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                        ],
                        [
                          "Stopping",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                        ],
                        [
                          "Stopped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                        ],
                        [
                          "Skipped",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                        ],
                        [
                          "Failed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                        ],
                        [
                          "Completed",
                          "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "stages": {
                  "$properties": {
                    "status": [
                      {
                        "#name": "state",
                        "Enum": {
                          "new": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Pending",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ],
                          "old": [
                            [
                              "NotStarted",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                            ],
                            [
                              "Running",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                            ],
                            [
                              "Stopping",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                            ],
                            [
                              "Stopped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                            ],
                            [
                              "Skipped",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                            ],
                            [
                              "Failed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                            ],
                            [
                              "Completed",
                              "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                            ]
                          ]
                        }
                      }
                    ],
                    "groups": {
                      "$properties": {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ],
                        "members": {
                          "$properties": {
                            "status": [
                              {
                                "#name": "state",
                                "Enum": {
                                  "new": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Pending",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ],
                                  "old": [
                                    [
                                      "NotStarted",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                    ],
                                    [
                                      "Running",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                    ],
                                    [
                                      "Stopping",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                    ],
                                    [
                                      "Stopped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                    ],
                                    [
                                      "Skipped",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                    ],
                                    [
                                      "Failed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                    ],
                                    [
                                      "Completed",
                                      "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                    ]
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      }
                    },
                    "afterStageWaitStatus": [
                      {
                        "status": [
                          {
                            "#name": "state",
                            "Enum": {
                              "new": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Pending",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ],
                              "old": [
                                [
                                  "NotStarted",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started."
                                ],
                                [
                                  "Running",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running."
                                ],
                                [
                                  "Stopping",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped."
                                ],
                                [
                                  "Stopped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped."
                                ],
                                [
                                  "Skipped",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped."
                                ],
                                [
                                  "Failed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed."
                                ],
                                [
                                  "Completed",
                                  "The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed."
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the UpdateRun resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. ,
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
Latest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. ,
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. ,
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running. ,
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped. ,
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped. ,
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped. ,
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed. ,
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending. ,
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}