update_runs

Creates, updates, deletes, gets or lists a update_runs resource.

Overview

Name	update_runs
Type	Resource
Id	azure.container_service_fleet.update_runs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoUpgradeProfileId	string	AutoUpgradeProfileId is the id of an auto upgrade profile resource.
eTag	string	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.
managedClusterUpdate	object	The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. Required.
provisioningState	string	The provisioning state of the UpdateRun resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	object	The status of the UpdateRun.
strategy	object	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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategyId	string	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.

list_by_fleet

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoUpgradeProfileId	string	AutoUpgradeProfileId is the id of an auto upgrade profile resource.
eTag	string	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.
managedClusterUpdate	object	The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. Required.
provisioningState	string	The provisioning state of the UpdateRun resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	object	The status of the UpdateRun.
strategy	object	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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategyId	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, fleet_name, update_run_name, subscription_id		Get a UpdateRun.
list_by_fleet	select	resource_group_name, fleet_name, subscription_id	$top, $skipToken	List UpdateRun resources by Fleet.
create_or_update	insert	resource_group_name, fleet_name, update_run_name, subscription_id		Create a UpdateRun.
create_or_update	replace	resource_group_name, fleet_name, update_run_name, subscription_id		Create a UpdateRun.
delete	delete	resource_group_name, fleet_name, update_run_name, subscription_id		Delete a UpdateRun.
start	exec	resource_group_name, fleet_name, update_run_name, subscription_id		Starts an UpdateRun.
stop	exec	resource_group_name, fleet_name, update_run_name, subscription_id		Stops an UpdateRun.
skip	exec	resource_group_name, fleet_name, update_run_name, subscription_id, targets		Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fleet_name	string	The name of the Fleet resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
update_run_name	string	The name of the UpdateRun resource. Required.
$skipToken	string	The page-continuation token to use with a paged version of this API. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

Get a UpdateRun.

SELECT
id,
name,
autoUpgradeProfileId,
eTag,
managedClusterUpdate,
provisioningState,
status,
strategy,
systemData,
type,
updateStrategyId
FROM azure.container_service_fleet.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND update_run_name = '{{ update_run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_fleet

List UpdateRun resources by Fleet.

SELECT
id,
name,
autoUpgradeProfileId,
eTag,
managedClusterUpdate,
provisioningState,
status,
strategy,
systemData,
type,
updateStrategyId
FROM azure.container_service_fleet.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a UpdateRun.

INSERT INTO azure.container_service_fleet.update_runs (
properties,
resource_group_name,
fleet_name,
update_run_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ update_run_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: update_runs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the update_runs resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the update_runs resource.
  - name: update_run_name
    value: "{{ update_run_name }}"
    description: Required parameter for the update_runs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the update_runs resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      updateStrategyId: "{{ updateStrategyId }}"
      strategy:
        stages:
          - name: "{{ name }}"
            groups: "{{ groups }}"
            afterStageWaitInSeconds: {{ afterStageWaitInSeconds }}
            maxConcurrency: "{{ maxConcurrency }}"
            beforeGates: "{{ beforeGates }}"
            afterGates: "{{ afterGates }}"
      managedClusterUpdate:
        upgrade:
          type: "{{ type }}"
          kubernetesVersion: "{{ kubernetesVersion }}"
        nodeImageSelection:
          type: "{{ type }}"
          customNodeImageVersions:
            - version: "{{ version }}"
      status:
        status:
          startTime: "{{ startTime }}"
          completedTime: "{{ completedTime }}"
          state: "{{ state }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
        stages:
          - status:
              startTime: "{{ startTime }}"
              completedTime: "{{ completedTime }}"
              state: "{{ state }}"
              error:
                code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            name: "{{ name }}"
            maxConcurrency: {{ maxConcurrency }}
            groups: "{{ groups }}"
            beforeGates: "{{ beforeGates }}"
            afterGates: "{{ afterGates }}"
            afterStageWaitStatus:
              status:
                startTime: "{{ startTime }}"
                completedTime: "{{ completedTime }}"
                state: "{{ state }}"
                error: "{{ error }}"
              waitDurationInSeconds: {{ waitDurationInSeconds }}
        nodeImageSelection:
          selectedNodeImageVersions:
            - version: "{{ version }}"
      autoUpgradeProfileId: "{{ autoUpgradeProfileId }}"

REPLACE examples

create_or_update

Create a UpdateRun.

REPLACE azure.container_service_fleet.update_runs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND update_run_name = '{{ update_run_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

DELETE examples

delete

Delete a UpdateRun.

DELETE FROM azure.container_service_fleet.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND update_run_name = '{{ update_run_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts an UpdateRun.

EXEC azure.container_service_fleet.update_runs.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@fleet_name='{{ fleet_name }}' --required, 
@update_run_name='{{ update_run_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops an UpdateRun.

EXEC azure.container_service_fleet.update_runs.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@fleet_name='{{ fleet_name }}' --required, 
@update_run_name='{{ update_run_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

skip

Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.

EXEC azure.container_service_fleet.update_runs.skip 
@resource_group_name='{{ resource_group_name }}' --required, 
@fleet_name='{{ fleet_name }}' --required, 
@update_run_name='{{ update_run_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"targets": "{{ targets }}"
}'
;