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:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
cancel | exec | resourceGroupName, vmScaleSetName, subscriptionId | Cancels the current virtual machine scale set rolling upgrade. | |
start_os_upgrade | exec | resourceGroupName, vmScaleSetName, subscriptionId | 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. | |
start_extension_upgrade | exec | resourceGroupName, vmScaleSetName, subscriptionId | 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. |
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. |
subscriptionId | string | Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
vmScaleSetName | string | The name of the VM scale set. |
Lifecycle Methods
- cancel
- start_os_upgrade
- start_extension_upgrade
Cancels the current virtual machine scale set rolling upgrade.
EXEC azure.compute.virtual_machine_scale_set_rolling_upgrades.cancel
@resourceGroupName='{{ resourceGroupName }}' --required,
@vmScaleSetName='{{ vmScaleSetName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
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
@resourceGroupName='{{ resourceGroupName }}' --required,
@vmScaleSetName='{{ vmScaleSetName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
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
@resourceGroupName='{{ resourceGroupName }}' --required,
@vmScaleSetName='{{ vmScaleSetName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;