update_runs

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

Overview

Name	update_runs
Type	Resource
Id	azure_stack.update_admin.update_runs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Region location of resource.
properties	object	Properties of a update run.
tags	object	List of key-value pairs.
type	string	Type of resource.

list

Name	Datatype	Description
id	string	URI of the resource.
name	string	Name of the resource.
location	string	Region location of resource.
properties	object	Properties of a update run.
tags	object	List of key-value pairs.
type	string	Type of resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, updateLocation, updateName, runName		Get an instance of update run using the ID.
list	select	subscriptionId, resourceGroupName, updateLocation, updateName		Get the list of update runs.
rerun	exec	subscriptionId, resourceGroupName, updateLocation, updateName, runName		Resume a failed update.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
runName	string	Update run identifier.
subscriptionId	string	The ID of the target subscription.
updateLocation	string	The name of the update location.
updateName	string	Name of the update.

SELECT examples

get

Get an instance of update run using the ID.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.update_admin.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND updateLocation = '{{ updateLocation }}' -- required
AND updateName = '{{ updateName }}' -- required
AND runName = '{{ runName }}' -- required
;

list

Get the list of update runs.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.update_admin.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND updateLocation = '{{ updateLocation }}' -- required
AND updateName = '{{ updateName }}' -- required
;

Lifecycle Methods

rerun

Resume a failed update.

EXEC azure_stack.update_admin.update_runs.rerun 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@updateLocation='{{ updateLocation }}' --required, 
@updateName='{{ updateName }}' --required, 
@runName='{{ runName }}' --required
;