updates

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

Overview

Name	updates
Type	Resource
Id	azure_stack.update_admin.updates

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 an update.
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 an update.
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		Get a specific update at an update location.
list	select	subscriptionId, resourceGroupName, updateLocation		Get the list of updates at an update locations
prepare	exec	subscriptionId, resourceGroupName, updateLocation, updateName		Prepare a specified update at an update location.
health_check	exec	subscriptionId, resourceGroupName, updateLocation, updateName		Run health check for a specified update at an update location.
apply	exec	subscriptionId, resourceGroupName, updateLocation, updateName		Apply a specific update at an update location.

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.
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 a specific update at an update location.

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

list

Get the list of updates at an update locations

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

Lifecycle Methods

prepare

Prepare a specified update at an update location.

EXEC azure_stack.update_admin.updates.prepare 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@updateLocation='{{ updateLocation }}' --required, 
@updateName='{{ updateName }}' --required
;

health_check

Run health check for a specified update at an update location.

EXEC azure_stack.update_admin.updates.health_check 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@updateLocation='{{ updateLocation }}' --required, 
@updateName='{{ updateName }}' --required
;

apply

Apply a specific update at an update location.

EXEC azure_stack.update_admin.updates.apply 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@updateLocation='{{ updateLocation }}' --required, 
@updateName='{{ updateName }}' --required
;