Package version:

Interface VirtualMachineScaleSetRollingUpgrades

Interface representing a VirtualMachineScaleSetRollingUpgrades.

interface VirtualMachineScaleSetRollingUpgrades {
    beginCancel(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginCancelAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams): Promise<void>;
    beginStartExtensionUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartExtensionUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams): Promise<void>;
    beginStartOSUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartOSUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams): Promise<void>;
    getLatest(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams): Promise<RollingUpgradeStatusInfo>;
}

Methods

beginCancel(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Cancels the current virtual machine scale set rolling upgrade.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesCancelOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:26

beginStartExtensionUpgrade(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:76

beginStartExtensionUpgradeAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:89

beginStartOSUpgrade(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:50

beginStartOSUpgradeAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:63

getLatest(resourceGroupName, vmScaleSetName, options?): Promise<RollingUpgradeStatusInfo>
Gets the status of the latest virtual machine scale set rolling upgrade.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams
  The options parameters.
Returns Promise<RollingUpgradeStatusInfo>
- Defined in operationsInterfaces/virtualMachineScaleSetRollingUpgrades.ts:100