Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VirtualMachineScaleSets

Package version

Class representing a VirtualMachineScaleSets.

Hierarchy

  • VirtualMachineScaleSets

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

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

  • Create or update a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set to create or update.

    • parameters: VirtualMachineScaleSet

      The scale set object.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeallocate

  • beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginDeallocateOptionalParams): Promise<msRestAzure.LROPoller>

  • Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginDeallocateOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteInstances

  • Deletes virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

      A list of virtual machine instance IDs from the VM scale set.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

  • Deletes a VM scale set.

    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>

beginPerformMaintenance

  • beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginPerformMaintenanceOptionalParams): Promise<msRestAzure.LROPoller>

beginPowerOff

  • beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginPowerOffOptionalParams): Promise<msRestAzure.LROPoller>

  • Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginPowerOffOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginRedeploy

  • beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginRedeployOptionalParams): Promise<msRestAzure.LROPoller>

  • Redeploy one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginRedeployOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginReimage

  • beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginReimageOptionalParams): Promise<msRestAzure.LROPoller>

  • Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginReimageOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginReimageAll

  • beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginReimageAllOptionalParams): Promise<msRestAzure.LROPoller>

  • Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginReimageAllOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginRestart

  • beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginRestartOptionalParams): Promise<msRestAzure.LROPoller>

  • Restarts one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginRestartOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginStart

  • beginStart(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsBeginStartOptionalParams): Promise<msRestAzure.LROPoller>

  • Starts one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsBeginStartOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdate

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

  • Update a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set to create or update.

    • parameters: VirtualMachineScaleSetUpdate

      The scale set object.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdateInstances

  • Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

      A list of virtual machine instance IDs from the VM scale set.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsCreateOrUpdateResponse>

  • Create or update a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set to create or update.

    • parameters: VirtualMachineScaleSet

      The scale set object.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsCreateOrUpdateResponse>

    Promise<Models.VirtualMachineScaleSetsCreateOrUpdateResponse>

deallocate

  • deallocate(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsDeallocateOptionalParams): Promise<Models.VirtualMachineScaleSetsDeallocateResponse>

  • Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsDeallocateOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsDeallocateResponse>

    Promise<Models.VirtualMachineScaleSetsDeallocateResponse>

deleteInstances

  • deleteInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsDeleteInstancesResponse>

  • Deletes virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

      A list of virtual machine instance IDs from the VM scale set.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsDeleteInstancesResponse>

    Promise<Models.VirtualMachineScaleSetsDeleteInstancesResponse>

deleteMethod

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

  • Deletes a VM scale set.

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

    Promise<Models.VirtualMachineScaleSetsDeleteMethodResponse>

forceRecoveryServiceFabricPlatformUpdateDomainWalk

  • forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse>
  • forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, callback: msRest.ServiceCallback<RecoveryWalkResponse>): void
  • forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryWalkResponse>): void

  • Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • platformUpdateDomain: number

      The platform update domain for which a manual recovery walk is requested

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse>

    Promise<Models.VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • platformUpdateDomain: number

      The platform update domain for which a manual recovery walk is requested

    • callback: msRest.ServiceCallback<RecoveryWalkResponse>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • platformUpdateDomain: number

      The platform update domain for which a manual recovery walk is requested

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RecoveryWalkResponse>

      The callback

    Returns void

get

  • get(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsGetResponse>
  • get(resourceGroupName: string, vmScaleSetName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSet>): void
  • get(resourceGroupName: string, vmScaleSetName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSet>): void

  • Display information about a virtual machine scale set.

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

    Promise<Models.VirtualMachineScaleSetsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • callback: msRest.ServiceCallback<VirtualMachineScaleSet>

      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<VirtualMachineScaleSet>

      The callback

    Returns void

getInstanceView

  • getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsGetInstanceViewResponse>
  • getInstanceView(resourceGroupName: string, vmScaleSetName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetInstanceView>): void
  • getInstanceView(resourceGroupName: string, vmScaleSetName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetInstanceView>): void

  • Gets the status of a VM scale set instance.

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

    Promise<Models.VirtualMachineScaleSetsGetInstanceViewResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • callback: msRest.ServiceCallback<VirtualMachineScaleSetInstanceView>

      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<VirtualMachineScaleSetInstanceView>

      The callback

    Returns void

getOSUpgradeHistory

  • getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsGetOSUpgradeHistoryResponse>
  • getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>): void
  • getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>): void

getOSUpgradeHistoryNext

  • getOSUpgradeHistoryNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsGetOSUpgradeHistoryNextResponse>
  • getOSUpgradeHistoryNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>): void
  • getOSUpgradeHistoryNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>): void

list

  • list(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsListResponse>
  • list(resourceGroupName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListResult>): void
  • list(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListResult>): void

listAll

listAllNext

  • listAllNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsListAllNextResponse>
  • listAllNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListWithLinkResult>): void
  • listAllNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListWithLinkResult>): void

  • Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsListAllNextResponse>

    Promise<Models.VirtualMachineScaleSetsListAllNextResponse>

  • Parameters

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VirtualMachineScaleSetListWithLinkResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListResult>): void

listSkus

  • listSkus(resourceGroupName: string, vmScaleSetName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsListSkusResponse>
  • listSkus(resourceGroupName: string, vmScaleSetName: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>): void
  • listSkus(resourceGroupName: string, vmScaleSetName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>): void

  • Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

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

    Promise<Models.VirtualMachineScaleSetsListSkusResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>

      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<VirtualMachineScaleSetListSkusResult>

      The callback

    Returns void

listSkusNext

  • listSkusNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsListSkusNextResponse>
  • listSkusNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>): void
  • listSkusNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>): void

  • Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsListSkusNextResponse>

    Promise<Models.VirtualMachineScaleSetsListSkusNextResponse>

  • Parameters

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VirtualMachineScaleSetListSkusResult>

      The callback

    Returns void

performMaintenance

  • performMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<Models.VirtualMachineScaleSetsPerformMaintenanceResponse>

powerOff

  • powerOff(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsPowerOffOptionalParams): Promise<Models.VirtualMachineScaleSetsPowerOffResponse>

  • Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsPowerOffOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsPowerOffResponse>

    Promise<Models.VirtualMachineScaleSetsPowerOffResponse>

redeploy

  • redeploy(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsRedeployOptionalParams): Promise<Models.VirtualMachineScaleSetsRedeployResponse>

  • Redeploy one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsRedeployOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsRedeployResponse>

    Promise<Models.VirtualMachineScaleSetsRedeployResponse>

reimage

  • reimage(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsReimageOptionalParams): Promise<Models.VirtualMachineScaleSetsReimageResponse>

  • Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsReimageOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsReimageResponse>

    Promise<Models.VirtualMachineScaleSetsReimageResponse>

reimageAll

  • reimageAll(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsReimageAllOptionalParams): Promise<Models.VirtualMachineScaleSetsReimageAllResponse>

  • Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsReimageAllOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsReimageAllResponse>

    Promise<Models.VirtualMachineScaleSetsReimageAllResponse>

restart

  • restart(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsRestartOptionalParams): Promise<Models.VirtualMachineScaleSetsRestartResponse>

  • Restarts one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsRestartOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsRestartResponse>

    Promise<Models.VirtualMachineScaleSetsRestartResponse>

start

  • start(resourceGroupName: string, vmScaleSetName: string, options?: Models.VirtualMachineScaleSetsStartOptionalParams): Promise<Models.VirtualMachineScaleSetsStartResponse>

  • Starts one or more virtual machines in a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • Optional options: Models.VirtualMachineScaleSetsStartOptionalParams

    Returns Promise<Models.VirtualMachineScaleSetsStartResponse>

    Promise<Models.VirtualMachineScaleSetsStartResponse>

update

  • update(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsUpdateResponse>

  • Update a VM scale set.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set to create or update.

    • parameters: VirtualMachineScaleSetUpdate

      The scale set object.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsUpdateResponse>

    Promise<Models.VirtualMachineScaleSetsUpdateResponse>

updateInstances

  • updateInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: msRest.RequestOptionsBase): Promise<Models.VirtualMachineScaleSetsUpdateInstancesResponse>

  • Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • vmScaleSetName: string

      The name of the VM scale set.

    • vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

      A list of virtual machine instance IDs from the VM scale set.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VirtualMachineScaleSetsUpdateInstancesResponse>

    Promise<Models.VirtualMachineScaleSetsUpdateInstancesResponse>

Generated using TypeDoc