update_runs

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

Overview

Name	update_runs
Type	Resource
Id	azure.fleet.update_runs

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
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.
properties	object	The resource-specific properties for this resource.

list_by_fleet

Azure operation completed successfully.

Name	Datatype	Description
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.
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, fleetName, updateRunName		Get a UpdateRun
list_by_fleet	select	subscriptionId, resourceGroupName, fleetName		List UpdateRun resources by Fleet
create_or_update	insert	subscriptionId, resourceGroupName, fleetName, updateRunName	If-Match, If-None-Match	Create a UpdateRun
delete	delete	subscriptionId, resourceGroupName, fleetName, updateRunName	If-Match	Delete a UpdateRun
skip	exec	subscriptionId, resourceGroupName, fleetName, updateRunName, targets	If-Match	Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.
start	exec	subscriptionId, resourceGroupName, fleetName, updateRunName	If-Match	Starts an UpdateRun.
stop	exec	subscriptionId, resourceGroupName, fleetName, updateRunName	If-Match	Stops an UpdateRun.

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
fleetName	string	The name of the Fleet resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
updateRunName	string	The name of the UpdateRun resource.
If-Match	string	The request should only proceed if an entity matches this string.
If-None-Match	string	The request should only proceed if no entity matches this string.

SELECT examples

get

Get a UpdateRun

SELECT
eTag,
properties
FROM azure.fleet.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fleetName = '{{ fleetName }}' -- required
AND updateRunName = '{{ updateRunName }}' -- required
;

list_by_fleet

List UpdateRun resources by Fleet

SELECT
eTag,
properties
FROM azure.fleet.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fleetName = '{{ fleetName }}' -- required
;

INSERT examples

create_or_update

Create a UpdateRun

INSERT INTO azure.fleet.update_runs (
data__properties,
subscriptionId,
resourceGroupName,
fleetName,
updateRunName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fleetName }}',
'{{ updateRunName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
eTag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: update_runs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the update_runs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the update_runs resource.
    - name: fleetName
      value: string
      description: Required parameter for the update_runs resource.
    - name: updateRunName
      value: string
      description: Required parameter for the update_runs resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: If-Match
      value: string
      description: The request should only proceed if an entity matches this string.
    - name: If-None-Match
      value: string
      description: The request should only proceed if no entity matches this string.

DELETE examples

delete

Delete a UpdateRun

DELETE FROM azure.fleet.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
AND updateRunName = '{{ updateRunName }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

skip

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

EXEC azure.fleet.update_runs.skip 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@fleetName='{{ fleetName }}' --required, 
@updateRunName='{{ updateRunName }}' --required, 
@If-Match='{{ If-Match }}' 
@@json=
'{
"targets": "{{ targets }}"
}'
;

start

Starts an UpdateRun.

EXEC azure.fleet.update_runs.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@fleetName='{{ fleetName }}' --required, 
@updateRunName='{{ updateRunName }}' --required, 
@If-Match='{{ If-Match }}'
;

stop

Stops an UpdateRun.

EXEC azure.fleet.update_runs.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@fleetName='{{ fleetName }}' --required, 
@updateRunName='{{ updateRunName }}' --required, 
@If-Match='{{ If-Match }}'
;