Share via

Microsoft.ContainerService fleets/updateStrategies 2024-05-02-preview

Bicep resource definition

The fleets/updateStrategies 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/updateStrategies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerService/fleets/updateStrategies@2024-05-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    strategy: {
      stages: [
        {
          afterStageWaitInSeconds: int
          groups: [
            {
              name: 'string'
            }
          ]
          name: 'string'
        }
      ]
    }
  }
}

Property Values

Microsoft.ContainerService/fleets/updateStrategies

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (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. FleetUpdateStrategyProperties

FleetUpdateStrategyProperties

Name Description Value
strategy Defines the update sequence of the clusters. UpdateRunStrategy (required)

UpdateGroup

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

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (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

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

ARM template resource definition

The fleets/updateStrategies 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/updateStrategies resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerService/fleets/updateStrategies",
  "apiVersion": "2024-05-02-preview",
  "name": "string",
  "properties": {
    "strategy": {
      "stages": [
        {
          "afterStageWaitInSeconds": "int",
          "groups": [
            {
              "name": "string"
            }
          ],
          "name": "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.ContainerService/fleets/updateStrategies

Name Description Value
apiVersion The api version '2024-05-02-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
properties The resource-specific properties for this resource. FleetUpdateStrategyProperties
type The resource type 'Microsoft.ContainerService/fleets/updateStrategies'

FleetUpdateStrategyProperties

Name Description Value
strategy Defines the update sequence of the clusters. UpdateRunStrategy (required)

UpdateGroup

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

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (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

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

Usage Examples

Terraform (AzAPI provider) resource definition

The fleets/updateStrategies 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/updateStrategies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerService/fleets/updateStrategies@2024-05-02-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      strategy = {
        stages = [
          {
            afterStageWaitInSeconds = int
            groups = [
              {
                name = "string"
              }
            ]
            name = "string"
          }
        ]
      }
    }
  }
}

Property Values

Microsoft.ContainerService/fleets/updateStrategies

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (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. FleetUpdateStrategyProperties
type The resource type "Microsoft.ContainerService/fleets/updateStrategies@2024-05-02-preview"

FleetUpdateStrategyProperties

Name Description Value
strategy Defines the update sequence of the clusters. UpdateRunStrategy (required)

UpdateGroup

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

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (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

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