update_runs

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

Overview

Name	update_runs
Type	Resource
Id	azure_stack.azure_stack_hci.update_runs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes Update Run Properties.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes Update Run Properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, updateName, updateRunName		Get the Update run for a specified update
list	select	subscriptionId, resourceGroupName, clusterName, updateName		List all Update runs for a specified update
put	replace	subscriptionId, resourceGroupName, clusterName, updateName, updateRunName		Put Update runs for a specified update
delete	delete	subscriptionId, resourceGroupName, clusterName, updateName, updateRunName		Delete specified 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
clusterName	string	The name of the cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
updateName	string	The name of the Update
updateRunName	string	The name of the Update Run

SELECT examples

get

Get the Update run for a specified update

SELECT
location,
properties
FROM azure_stack.azure_stack_hci.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND updateName = '{{ updateName }}' -- required
AND updateRunName = '{{ updateRunName }}' -- required
;

list

List all Update runs for a specified update

SELECT
location,
properties
FROM azure_stack.azure_stack_hci.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND updateName = '{{ updateName }}' -- required
;

REPLACE examples

put

Put Update runs for a specified update

REPLACE azure_stack.azure_stack_hci.update_runs
SET 
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND updateName = '{{ updateName }}' --required
AND updateRunName = '{{ updateRunName }}' --required
RETURNING
location,
properties;

DELETE examples

delete

Delete specified Update Run

DELETE FROM azure_stack.azure_stack_hci.update_runs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND updateName = '{{ updateName }}' --required
AND updateRunName = '{{ updateRunName }}' --required
;