VirtualMachineScaleSetRollingUpgrades interface

Package:

@azure/arm-compute

Interface representing a VirtualMachineScaleSetRollingUpgrades.

Methods

beginCancel(string, string, VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)	Cancels the current virtual machine scale set rolling upgrade.
beginCancelAndWait(string, string, VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)	Cancels the current virtual machine scale set rolling upgrade.
beginStartExtensionUpgrade(string, string, VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)	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.
beginStartExtensionUpgradeAndWait(string, string, VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)	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.
beginStartOSUpgrade(string, string, VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)	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.
beginStartOSUpgradeAndWait(string, string, VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)	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.
getLatest(string, string, VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams)	Gets the status of the latest virtual machine scale set rolling upgrade.

Method Details

beginCancel(string, string, VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)

Cancels the current virtual machine scale set rolling upgrade.

function beginCancel(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesCancelOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCancelAndWait(string, string, VirtualMachineScaleSetRollingUpgradesCancelOptionalParams)

Cancels the current virtual machine scale set rolling upgrade.

function beginCancelAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesCancelOptionalParams

The options parameters.

Returns

Promise<void>

beginStartExtensionUpgrade(string, string, VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)

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.

function beginStartExtensionUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartExtensionUpgradeAndWait(string, string, VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams)

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.

function beginStartExtensionUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams

The options parameters.

Returns

Promise<void>

beginStartOSUpgrade(string, string, VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)

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.

function beginStartOSUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartOSUpgradeAndWait(string, string, VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams)

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.

function beginStartOSUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams

The options parameters.

Returns

Promise<void>

getLatest(string, string, VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams)

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

function getLatest(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams): Promise<RollingUpgradeStatusInfo>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams

The options parameters.

Returns

Promise<RollingUpgradeStatusInfo>