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
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.
duration	string	Duration of the update run.
lastUpdatedTime	string (date-time)	Timestamp of the most recently completed step in the update run.
location	string	The geo-location where the resource lives.
progress	object	Progress representation of the update run steps.
provisioningState	string	Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
state	string	Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. Known values are: "Unknown", "Succeeded", "InProgress", and "Failed". (Unknown, Succeeded, InProgress, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeStarted	string (date-time)	Timestamp of the update run was started.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
duration	string	Duration of the update run.
lastUpdatedTime	string (date-time)	Timestamp of the most recently completed step in the update run.
location	string	The geo-location where the resource lives.
progress	object	Progress representation of the update run steps.
provisioningState	string	Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
state	string	Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. Known values are: "Unknown", "Succeeded", "InProgress", and "Failed". (Unknown, Succeeded, InProgress, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeStarted	string (date-time)	Timestamp of the update run was started.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, update_name, update_run_name, subscription_id		Get the Update run for a specified update.
list	select	resource_group_name, cluster_name, update_name, subscription_id		List all Update runs for a specified update.
delete	delete	resource_group_name, cluster_name, update_name, update_run_name, subscription_id		Delete specified Update Run.
put	exec	resource_group_name, cluster_name, update_name, update_run_name, subscription_id		Put Update runs for a specified 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
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
update_name	string	The name of the Update. Required.
update_run_name	string	The name of the Update Run. Required.

SELECT examples

get

Get the Update run for a specified update.

SELECT
id,
name,
duration,
lastUpdatedTime,
location,
progress,
provisioningState,
state,
systemData,
timeStarted,
type
FROM azure_stack.azure_stack_hci.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND update_name = '{{ update_name }}' -- required
AND update_run_name = '{{ update_run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all Update runs for a specified update.

SELECT
id,
name,
duration,
lastUpdatedTime,
location,
progress,
provisioningState,
state,
systemData,
timeStarted,
type
FROM azure_stack.azure_stack_hci.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND update_name = '{{ update_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete specified Update Run.

DELETE FROM azure_stack.azure_stack_hci.update_runs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND update_name = '{{ update_name }}' --required
AND update_run_name = '{{ update_run_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

Put Update runs for a specified update.

EXEC azure_stack.azure_stack_hci.update_runs.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@update_name='{{ update_name }}' --required, 
@update_run_name='{{ update_run_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}"
}'
;