Share via

Microsoft.ContainerService fleets/updateRuns 2023-03-15-preview

  • Article

Bicep resource definition

The fleets/updateRuns resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets/updateRuns resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerService/fleets/updateRuns@2023-03-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    managedClusterUpdate: {
      upgrade: {
        kubernetesVersion: 'string'
        type: 'string'
      }
    }
    strategy: {
      stages: [
        {
          afterStageWaitInSeconds: int
          groups: [
            {
              name: 'string'
            }
          ]
          name: 'string'
        }
      ]
    }
  }
}

Property values

fleets/updateRuns

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: fleets
properties The resource-specific properties for this resource. UpdateRunProperties

UpdateRunProperties

Name Description Value
managedClusterUpdate The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ManagedClusterUpdate (required)
strategy 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.
 UpdateRunStrategy

ManagedClusterUpdate

Name Description Value
upgrade The upgrade to apply to the ManagedClusters. ManagedClusterUpgradeSpec (required)

ManagedClusterUpgradeSpec

Name Description Value
kubernetesVersion The Kubernetes version to upgrade the member clusters to. string
type ManagedClusterUpgradeType is the type of upgrade to be applied. 'Full'
'NodeImageOnly' (required)

UpdateRunStrategy

Name Description Value
stages The list of stages that compose this update run. Min size: 1. UpdateStage[] (required)

UpdateStage

Name Description Value
afterStageWaitInSeconds The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. int
groups Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. UpdateGroup[]
name The name of the stage. Must be unique within the UpdateRun. string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

UpdateGroup

Name Description Value
name Name of the group.
It must match a group name of an existing fleet member.
 string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

ARM template resource definition

The fleets/updateRuns resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets/updateRuns resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerService/fleets/updateRuns",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "properties": {
    "managedClusterUpdate": {
      "upgrade": {
        "kubernetesVersion": "string",
        "type": "string"
      }
    },
    "strategy": {
      "stages": [
        {
          "afterStageWaitInSeconds": "int",
          "groups": [
            {
              "name": "string"
            }
          ],
          "name": "string"
        }
      ]
    }
  }
}

Property values

fleets/updateRuns

Name Description Value
type The resource type 'Microsoft.ContainerService/fleets/updateRuns'
apiVersion The resource api version '2023-03-15-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The resource-specific properties for this resource. UpdateRunProperties

UpdateRunProperties

Name Description Value
managedClusterUpdate The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ManagedClusterUpdate (required)
strategy 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.
 UpdateRunStrategy

ManagedClusterUpdate

Name Description Value
upgrade The upgrade to apply to the ManagedClusters. ManagedClusterUpgradeSpec (required)

ManagedClusterUpgradeSpec

Name Description Value
kubernetesVersion The Kubernetes version to upgrade the member clusters to. string
type ManagedClusterUpgradeType is the type of upgrade to be applied. 'Full'
'NodeImageOnly' (required)

UpdateRunStrategy

Name Description Value
stages The list of stages that compose this update run. Min size: 1. UpdateStage[] (required)

UpdateStage

Name Description Value
afterStageWaitInSeconds The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. int
groups Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. UpdateGroup[]
name The name of the stage. Must be unique within the UpdateRun. string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

UpdateGroup

Name Description Value
name Name of the group.
It must match a group name of an existing fleet member.
 string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Terraform (AzAPI provider) resource definition

The fleets/updateRuns resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets/updateRuns resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerService/fleets/updateRuns@2023-03-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      managedClusterUpdate = {
        upgrade = {
          kubernetesVersion = "string"
          type = "string"
        }
      }
      strategy = {
        stages = [
          {
            afterStageWaitInSeconds = int
            groups = [
              {
                name = "string"
              }
            ]
            name = "string"
          }
        ]
      }
    }
  })
}

Property values

fleets/updateRuns

Name Description Value
type The resource type "Microsoft.ContainerService/fleets/updateRuns@2023-03-15-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: fleets
properties The resource-specific properties for this resource. UpdateRunProperties

UpdateRunProperties

Name Description Value
managedClusterUpdate The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ManagedClusterUpdate (required)
strategy 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.
 UpdateRunStrategy

ManagedClusterUpdate

Name Description Value
upgrade The upgrade to apply to the ManagedClusters. ManagedClusterUpgradeSpec (required)

ManagedClusterUpgradeSpec

Name Description Value
kubernetesVersion The Kubernetes version to upgrade the member clusters to. string
type ManagedClusterUpgradeType is the type of upgrade to be applied. "Full"
"NodeImageOnly" (required)

UpdateRunStrategy

Name Description Value
stages The list of stages that compose this update run. Min size: 1. UpdateStage[] (required)

UpdateStage

Name Description Value
afterStageWaitInSeconds The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. int
groups Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. UpdateGroup[]
name The name of the stage. Must be unique within the UpdateRun. string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

UpdateGroup

Name Description Value
name Name of the group.
It must match a group name of an existing fleet member.
 string (required)

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$