virtual_machine_scale_set_rolling_upgrades

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

Overview

Name	virtual_machine_scale_set_rolling_upgrades
Type	Resource
Id	azure.compute.virtual_machine_scale_set_rolling_upgrades

Fields

The following fields are returned by SELECT queries:

get_latest

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.
error	object	Error details for this upgrade, if there are any.
location	string	The geo-location where the resource lives. Required.
policy	object	The rolling upgrade policies applied for this upgrade.
progress	object	Information about the number of virtual machine instances in each upgrade state.
runningStatus	object	Information about the current running state of the overall upgrade.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_latest	select	resource_group_name, vm_scale_set_name, subscription_id		Gets the status of the latest virtual machine scale set rolling upgrade.
start_extension_upgrade	exec	resource_group_name, vm_scale_set_name, subscription_id		Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.
start_os_upgrade	exec	resource_group_name, vm_scale_set_name, subscription_id		Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.
cancel	exec	resource_group_name, vm_scale_set_name, subscription_id		Cancels the current virtual machine scale set rolling upgrade.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vm_scale_set_name	string	The name of the VM scale set. Required.

SELECT examples

get_latest

Gets the status of the latest virtual machine scale set rolling upgrade.

SELECT
id,
name,
error,
location,
policy,
progress,
runningStatus,
systemData,
tags,
type
FROM azure.compute.virtual_machine_scale_set_rolling_upgrades
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vm_scale_set_name = '{{ vm_scale_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

start_extension_upgrade

Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.

EXEC azure.compute.virtual_machine_scale_set_rolling_upgrades.start_extension_upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@vm_scale_set_name='{{ vm_scale_set_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start_os_upgrade

Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

EXEC azure.compute.virtual_machine_scale_set_rolling_upgrades.start_os_upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@vm_scale_set_name='{{ vm_scale_set_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cancel

Cancels the current virtual machine scale set rolling upgrade.

EXEC azure.compute.virtual_machine_scale_set_rolling_upgrades.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@vm_scale_set_name='{{ vm_scale_set_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;