Microsoft Azure UpdateRuns API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UpdateRuns API
schemes:
- https
tags:
- name: UpdateRuns
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns
  : get:
      operationId: microsoftAzureUpdaterunsListbyfleet
      tags:
      - UpdateRuns
      description: List UpdateRun resources by Fleet
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/UpdateRunListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Lists the UpdateRun resources by fleet.:
          $ref: ./examples/UpdateRuns_ListByFleet.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}
  : get:
      operationId: microsoftAzureUpdaterunsGet
      tags:
      - UpdateRuns
      description: Get a UpdateRun
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/UpdateRun'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Gets an UpdateRun resource.:
          $ref: ./examples/UpdateRuns_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname
    put:
      operationId: microsoftAzureUpdaterunsCreateorupdate
      tags:
      - UpdateRuns
      description: Create a UpdateRun
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifMatch
      - name: If-None-Match
        in: header
        description: The request should only proceed if no entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifNoneMatch
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/UpdateRun'
      responses:
        '200':
          description: Resource 'UpdateRun' update operation succeeded
          schema:
            $ref: '#/definitions/UpdateRun'
        '201':
          description: Resource 'UpdateRun' create operation succeeded
          schema:
            $ref: '#/definitions/UpdateRun'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create an UpdateRun.:
          $ref: ./examples/UpdateRuns_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname
    delete:
      operationId: microsoftAzureUpdaterunsDelete
      tags:
      - UpdateRuns
      description: Delete a UpdateRun
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifMatch
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete an updateRun resource.:
          $ref: ./examples/UpdateRuns_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/skip
  : post:
      operationId: microsoftAzureUpdaterunsSkip
      tags:
      - UpdateRuns
      description: Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifMatch
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: body
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/SkipProperties'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/UpdateRun'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Skips one or more member/group/stage/afterStageWait(s) of an UpdateRun.:
          $ref: ./examples/UpdateRuns_Skip.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname Skip
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/start
  : post:
      operationId: microsoftAzureUpdaterunsStart
      tags:
      - UpdateRuns
      description: Starts an UpdateRun.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifMatch
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/UpdateRun'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Starts an UpdateRun.:
          $ref: ./examples/UpdateRuns_Start.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname Start
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/stop
  : post:
      operationId: microsoftAzureUpdaterunsStop
      tags:
      - UpdateRuns
      description: Stops an UpdateRun.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        type: string
        x-ms-client-name: ifMatch
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        type: string
        minLength: 1
        maxLength: 63
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      - name: updateRunName
        in: path
        description: The name of the UpdateRun resource.
        required: true
        type: string
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/UpdateRun'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Stops an UpdateRun.:
          $ref: ./examples/UpdateRuns_Stop.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerservice Fleets Fleetname Updateruns Updaterunname Stop
definitions:
  FleetUpdateStrategyResourceId:
    type: string
    format: arm-id
    description: A type definition that refers the id to an Azure Resource Manager resource.
    x-ms-arm-id-details:
      allowedResources:
      - type: Microsoft.ContainerService/fleets/updateStrategies
  UpdateStatus:
    type: object
    description: The status for an operation or group of operations.
    properties:
      startTime:
        type: string
        format: date-time
        description: The time the operation or group was started.
        readOnly: true
      completedTime:
        type: string
        format: date-time
        description: The time the operation or group was completed.
        readOnly: true
      state:
        $ref: '#/definitions/UpdateState'
        description: The State of the operation or group.
        readOnly: true
      error:
        $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail
        description: The error details when a failure is encountered.
        readOnly: true
  WaitStatus:
    type: object
    description: The status of the wait duration.
    properties:
      status:
        $ref: '#/definitions/UpdateStatus'
        description: The status of the wait duration.
        readOnly: true
      waitDurationInSeconds:
        type: integer
        format: int32
        description: The wait duration configured in seconds.
        readOnly: true
  UpdateRunProvisioningState:
    type: string
    description: The provisioning state of the UpdateRun resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    x-ms-enum:
      name: UpdateRunProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
    readOnly: true
  NodeImageSelectionType:
    type: string
    description: The node image upgrade type.
    enum:
    - Latest
    - Consistent
    x-ms-enum:
      name: NodeImageSelectionType
      modelAsString: true
      values:
      - name: Latest
        value: Latest
        description: 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.
      - name: Consistent
        value: Consistent
        description: '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''.'
  ManagedClusterUpgradeType:
    type: string
    description: The type of upgrade to perform when targeting ManagedClusters.
    enum:
    - Full
    - NodeImageOnly
    - ControlPlaneOnly
    x-ms-enum:
      name: ManagedClusterUpgradeType
      modelAsString: true
      values:
      - name: Full
        value: Full
        description: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.
      - name: NodeImageOnly
        value: NodeImageOnly
        description: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set.
      - name: ControlPlaneOnly
        value: ControlPlaneOnly
        description: ControlPlaneOnly upgrades only targets the KubernetesVersion of the ManagedClusters and will not be applied to the AgentPool. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.
  MemberUpdateStatus:
    type: object
    description: The status of a member update operation.
    properties:
      status:
        $ref: '#/definitions/UpdateStatus'
        description: The status of the MemberUpdate operation.
        readOnly: true
      name:
        type: string
        description: The name of the FleetMember.
        readOnly: true
      clusterResourceId:
        type: string
        description: The Azure resource id of the target Kubernetes cluster.
        readOnly: true
      operationId:
        type: string
        description: The operation resource id of the latest attempt to perform the operation.
        readOnly: true
      message:
        type: string
        description: The status message after processing the member update operation.
        readOnly: true
  TargetType:
    type: string
    description: The target type of a skip request.
    enum:
    - Member
    - Group
    - Stage
    - AfterStageWait
    x-ms-enum:
      name: TargetType
      modelAsString: true
      values:
      - name: Member
        value: Member
        description: Skip the update of a member.
      - name: Group
        value: Group
        description: Skip the update of a group.
      - name: Stage
        value: Stage
        description: Skip the update of an entire stage including the after stage wait.
      - name: AfterStageWait
        value: AfterStageWait
        description: Skip the update of the after stage wait of a certain stage.
  UpdateState:
    type: string
    description: The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.
    enum:
    - NotStarted
    - Running
    - Stopping
    - Stopped
    - Skipped
    - Failed
    - Completed
    x-ms-enum:
      name: UpdateState
      modelAsString: true
      values:
      - name: NotStarted
        value: NotStarted
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started.
      - name: Running
        value: Running
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running.
      - name: Stopping
        value: Stopping
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped.
      - name: Stopped
        value: Stopped
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped.
      - name: Skipped
        value: Skipped
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped.
      - name: Failed
        value: Failed
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed.
      - name: Completed
        value: Completed
        description: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed.
  UpdateStageStatus:
    type: object
    description: The status of a UpdateStage.
    properties:
      status:
        $ref: '#/definitions/UpdateStatus'
        description: The status of the UpdateStage.
        readOnly: true
      name:
        type: string
        description: The name of the UpdateStage.
        readOnly: true
      groups:
        type: array
        description: The list of groups to be updated as part of this UpdateStage.
        items:
          $ref: '#/definitions/UpdateGroupStatus'
        readOnly: true
        x-ms-identifiers:
        - name
      afterStageWaitStatus:
        $ref: '#/definitions/WaitStatus'
        description: The status of the wait period configured on the UpdateStage.
        readOnly: true
  UpdateGroup:
    type: object
    description: A group to be updated.
    properties:
      name:
        type: string
        description: 'Name of the group.

          It must match a group name of an existing fleet member. '
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
    required:
    - name
  UpdateRunStatus:
    type: object
    description: The status of a UpdateRun.
    properties:
      status:
        $ref: '#/definitions/UpdateStatus'
        description: The status of the UpdateRun.
        readOnly: true
      stages:
        type: array
        description: The stages composing an update run. Stages are run sequentially withing an UpdateRun.
        items:
          $ref: '#/definitions/UpdateStageStatus'
        readOnly: true
        x-ms-identifiers:
        - name
      nodeImageSelection:
        $ref: '#/definitions/NodeImageSelectionStatus'
        description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`.
        readOnly: true
  UpdateRun:
    type: object
    description: A multi-stage process to perform update operations across members of a Fleet.
    properties:
      properties:
        $ref: '#/definitions/UpdateRunProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      eTag:
        type: string
        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.
        readOnly: true
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  SkipTarget:
    type: object
    description: The definition of a single skip request.
    properties:
      type:
        $ref: '#/definitions/TargetType'
        description: The skip target type.
      name:
        type: string
        description: "The skip target's name. \nTo skip a member/group/stage, use the member/group/stage's name;\nTp skip an after stage wait, use the parent stage's name."
    required:
    - type
    - name
  SkipProperties:
    type: object
    description: The properties of a skip operation containing multiple skip requests.
    properties:
      targets:
        type: array
        description: The targets to skip.
        items:
          $ref: '#/definitions/SkipTarget'
        x-ms-identifiers:
        - type
        - name
    required:
    - targets
  NodeImageSelection:
    type: object
    description: The node image upgrade to be applied to the target nodes in update run.
    properties:
      type:
        $ref: '#/definitions/NodeImageSelectionType'
        description: The node image upgrade type.
        x-ms-mutability:
        - read
        - create
    required:
    - type
  NodeImageSelectionStatus:
    type: object
    description: The node image upgrade specs for the update run.
    properties:
      selectedNodeImageVersions:
        type: array
        description: The image versions to upgrade the nodes to.
        items:
          $ref: '#/definitions/NodeImageVersion'
        readOnly: true
        x-ms-identifiers:
        - version
  UpdateStage:
    type: object
    description: Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage.
    properties:
      name:
        type: string
        description: The name of the stage. Must be unique within the UpdateRun.
        minLength: 1
        maxLength: 50
        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      groups:
        type: array
        description: 'Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.'
        items:
          $ref: '#/definitions/UpdateGroup'
        x-ms-identifiers:
        - name
      afterStageWaitInSeconds:
        type: integer
        format: int32
        description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified.
    required:
    - name
  UpdateRunProperties:
    type: object
    description: The properties of the UpdateRun.
    properties:
      provisioningState:
        $ref: '#/definitions/UpdateRunProvisioningState'
        description: The provisioning state of the UpdateRun resource.
        readOnly: true
      updateStrategyId:
        $ref: '#/definitions/FleetUpdateStrategyResourceId'
        description: "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field. \nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate.\nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun."
      strategy:
        $ref: '#/definitions/UpdateRunStrategy'
        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.'
      managedClusterUpdate:
        $ref: '#/definitions/ManagedClusterUpdate'
        description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started.
      status:
        $ref: '#/definitions/UpdateRunStatus'
        description: The status of the UpdateRun.
        readOnly: true
    required:
    - managedClusterUpdate
  KubernetesVersion:
    type: string
  ManagedClusterUpgradeSpec:
    type: object
    description: The upgrade to apply to a ManagedCluster.
    properties:
      type:
        $ref: '#/definitions/ManagedClusterUpgradeType'
        description: ManagedClusterUpgradeType is the type of upgrade to be applied.
      kubernetesVersion:
        $ref: '#/definitions/KubernetesVersion'
        description: The Kubernetes version to upgrade the member clusters to.
    required:
    - type
  UpdateGroupStatus:
    type: object
    description: The status of a UpdateGroup.
    properties:
      status:
        $ref: '#/definitions/UpdateStatus'
        description: The status of the UpdateGroup.
        readOnly: true
      name:
        type: string
        description: The name of the UpdateGroup.
        readOnly: true
      members:
        type: array
        description: The list of member this UpdateGroup updates.
        items:
          $ref: '#/definitions/MemberUpdateStatus'
        readOnly: true
        x-ms-identifiers:
        - name
  NodeImageVersion:
    type: object
    description: The node upgrade image version.
    properties:
      version:
        type: string
        description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13').
        readOnly: true
  UpdateRunStrategy:
    type: object
    description: 'Defines the update sequence of the clusters via stages and groups.


      Stages within a run are executed sequentially one after another.

      Groups within a stage are executed in parallel.

      Member clusters within a group are updated sequen

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-updateruns-api-openapi.yml