Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VirtualMachineScaleSetRollingUpgrades

Package version

Class representing a VirtualMachineScaleSetRollingUpgrades.

Hierarchy

  • VirtualMachineScaleSetRollingUpgrades

Index

Constructors

Methods

Constructors

constructor

Methods

beginCancel

  • beginCancel(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginStartOSUpgrade

  • beginStartOSUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

cancel

  • cancel(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetRollingUpgradesCancelResponse>

  • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetRollingUpgradesCancelResponse>

    Promise<Models.VirtualMachineScaleSetRollingUpgradesCancelResponse>

getLatest

  • getLatest(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetRollingUpgradesGetLatestResponse>
  • getLatest(resourceGroupName: string, vmScaleSetName: string, callback: msRest.ServiceCallback<RollingUpgradeStatusInfo>): void
  • getLatest(resourceGroupName: string, vmScaleSetName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RollingUpgradeStatusInfo>): void

  • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetRollingUpgradesGetLatestResponse>

    Promise<Models.VirtualMachineScaleSetRollingUpgradesGetLatestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • callback: msRest.ServiceCallback<RollingUpgradeStatusInfo>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RollingUpgradeStatusInfo>

      The callback

    Returns void

startOSUpgrade

  • startOSUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetRollingUpgradesStartOSUpgradeResponse>

  • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetRollingUpgradesStartOSUpgradeResponse>

    Promise<Models.VirtualMachineScaleSetRollingUpgradesStartOSUpgradeResponse>

Generated using TypeDoc