VirtualMachineScaleSets interface

Reference

Package:: @azure/arm-compute

Interface representing a VirtualMachineScaleSets.

Methods

beginApproveRollingUpgrade(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)	Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
beginApproveRollingUpgradeAndWait(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)	Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
beginCreateOrUpdate(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)	Create or update a VM scale set.
beginCreateOrUpdateAndWait(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)	Create or update a VM scale set.
beginDeallocate(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)	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.
beginDeallocateAndWait(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)	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.
beginDelete(string, string, VirtualMachineScaleSetsDeleteOptionalParams)	Deletes a VM scale set.
beginDeleteAndWait(string, string, VirtualMachineScaleSetsDeleteOptionalParams)	Deletes a VM scale set.
beginDeleteInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)	Deletes virtual machines in a VM scale set.
beginDeleteInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)	Deletes virtual machines in a VM scale set.
beginPerformMaintenance(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)	Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
beginPerformMaintenanceAndWait(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)	Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
beginPowerOff(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)	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.
beginPowerOffAndWait(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)	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.
beginReapply(string, string, VirtualMachineScaleSetsReapplyOptionalParams)	Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
beginReapplyAndWait(string, string, VirtualMachineScaleSetsReapplyOptionalParams)	Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
beginRedeploy(string, string, VirtualMachineScaleSetsRedeployOptionalParams)	Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
beginRedeployAndWait(string, string, VirtualMachineScaleSetsRedeployOptionalParams)	Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
beginReimage(string, string, VirtualMachineScaleSetsReimageOptionalParams)	Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
beginReimageAll(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)	Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
beginReimageAllAndWait(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)	Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
beginReimageAndWait(string, string, VirtualMachineScaleSetsReimageOptionalParams)	Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
beginRestart(string, string, VirtualMachineScaleSetsRestartOptionalParams)	Restarts one or more virtual machines in a VM scale set.
beginRestartAndWait(string, string, VirtualMachineScaleSetsRestartOptionalParams)	Restarts one or more virtual machines in a VM scale set.
beginSetOrchestrationServiceState(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)	Changes ServiceState property for a given service
beginSetOrchestrationServiceStateAndWait(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)	Changes ServiceState property for a given service
beginStart(string, string, VirtualMachineScaleSetsStartOptionalParams)	Starts one or more virtual machines in a VM scale set.
beginStartAndWait(string, string, VirtualMachineScaleSetsStartOptionalParams)	Starts one or more virtual machines in a VM scale set.
beginUpdate(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)	Update a VM scale set.
beginUpdateAndWait(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)	Update a VM scale set.
beginUpdateInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)	Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
beginUpdateInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)	Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
convertToSinglePlacementGroup(string, string, VMScaleSetConvertToSinglePlacementGroupInput, VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams)	Converts SinglePlacementGroup property to false for a existing virtual machine scale set.
forceRecoveryServiceFabricPlatformUpdateDomainWalk(string, string, number, VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams)	Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
get(string, string, VirtualMachineScaleSetsGetOptionalParams)	Display information about a virtual machine scale set.
getInstanceView(string, string, VirtualMachineScaleSetsGetInstanceViewOptionalParams)	Gets the status of a VM scale set instance.
list(string, VirtualMachineScaleSetsListOptionalParams)	Gets a list of all VM scale sets under a resource group.
listAll(VirtualMachineScaleSetsListAllOptionalParams)	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.
listByLocation(string, VirtualMachineScaleSetsListByLocationOptionalParams)	Gets all the VM scale sets under the specified subscription for the specified location.
listOSUpgradeHistory(string, string, VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams)	Gets list of OS upgrades on a VM scale set instance.
listSkus(string, string, VirtualMachineScaleSetsListSkusOptionalParams)	Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

Method Details

beginApproveRollingUpgrade(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)

Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.

function beginApproveRollingUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetsApproveRollingUpgradeHeaders>>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetsApproveRollingUpgradeHeaders>>

beginApproveRollingUpgradeAndWait(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)

Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.

function beginApproveRollingUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams): Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>

beginCreateOrUpdate(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)

Create or update a VM scale set.

function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>

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.

options: VirtualMachineScaleSetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>

beginCreateOrUpdateAndWait(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)

Create or update a VM scale set.

function beginCreateOrUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<VirtualMachineScaleSet>

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.

options: VirtualMachineScaleSetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSet>

beginDeallocate(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)

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.

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsDeallocateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeallocateAndWait(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)

function beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsDeallocateOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, VirtualMachineScaleSetsDeleteOptionalParams)

Deletes a VM scale set.

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualMachineScaleSetsDeleteOptionalParams)

Deletes a VM scale set.

function beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)

Deletes virtual machines in a VM scale set.

function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options: VirtualMachineScaleSetsDeleteInstancesOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)

Deletes virtual machines in a VM scale set.

function beginDeleteInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<void>

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.

options: VirtualMachineScaleSetsDeleteInstancesOptionalParams

The options parameters.

Returns

Promise<void>

beginPerformMaintenance(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)

Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginPerformMaintenanceAndWait(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)

function beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams

The options parameters.

Returns

Promise<void>

beginPowerOff(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)

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.

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsPowerOffOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginPowerOffAndWait(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)

function beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsPowerOffOptionalParams

The options parameters.

Returns

Promise<void>

beginReapply(string, string, VirtualMachineScaleSetsReapplyOptionalParams)

Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReapplyOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginReapplyAndWait(string, string, VirtualMachineScaleSetsReapplyOptionalParams)

Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances

function beginReapplyAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReapplyOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReapplyOptionalParams

The options parameters.

Returns

Promise<void>

beginRedeploy(string, string, VirtualMachineScaleSetsRedeployOptionalParams)

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsRedeployOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRedeployAndWait(string, string, VirtualMachineScaleSetsRedeployOptionalParams)

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

function beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsRedeployOptionalParams

The options parameters.

Returns

Promise<void>

beginReimage(string, string, VirtualMachineScaleSetsReimageOptionalParams)

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReimageOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginReimageAll(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)

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

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReimageAllOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginReimageAllAndWait(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)

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

function beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReimageAllOptionalParams

The options parameters.

Returns

Promise<void>

beginReimageAndWait(string, string, VirtualMachineScaleSetsReimageOptionalParams)

function beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsReimageOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, VirtualMachineScaleSetsRestartOptionalParams)

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

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsRestartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, VirtualMachineScaleSetsRestartOptionalParams)

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

function beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginSetOrchestrationServiceState(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)

Changes ServiceState property for a given service

function beginSetOrchestrationServiceState(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the virtual machine scale set to create or update.

parameters: OrchestrationServiceStateInput

The input object for SetOrchestrationServiceState API.

options: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginSetOrchestrationServiceStateAndWait(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)

Changes ServiceState property for a given service

function beginSetOrchestrationServiceStateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the virtual machine scale set to create or update.

parameters: OrchestrationServiceStateInput

The input object for SetOrchestrationServiceState API.

options: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, VirtualMachineScaleSetsStartOptionalParams)

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

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

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsStartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, VirtualMachineScaleSetsStartOptionalParams)

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

function beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)

Update a VM scale set.

function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>

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.

options: VirtualMachineScaleSetsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>

beginUpdateAndWait(string, string, VirtualMachineScaleSetUpdate, VirtualMachineScaleSetsUpdateOptionalParams)

Update a VM scale set.

function beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<VirtualMachineScaleSet>

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.

options: VirtualMachineScaleSetsUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSet>

beginUpdateInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)

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

function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options: VirtualMachineScaleSetsUpdateInstancesOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginUpdateInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsUpdateInstancesOptionalParams)

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

function beginUpdateInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<void>

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.

options: VirtualMachineScaleSetsUpdateInstancesOptionalParams

The options parameters.

Returns

Promise<void>

convertToSinglePlacementGroup(string, string, VMScaleSetConvertToSinglePlacementGroupInput, VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams)

Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

function convertToSinglePlacementGroup(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetConvertToSinglePlacementGroupInput, options?: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the virtual machine scale set to create or update.

parameters: VMScaleSetConvertToSinglePlacementGroupInput

The input object for ConvertToSinglePlacementGroup API.

options: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams

The options parameters.

Returns

Promise<void>

forceRecoveryServiceFabricPlatformUpdateDomainWalk(string, string, number, VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams)

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

function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams): Promise<RecoveryWalkResponse>

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: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams

The options parameters.

Returns

Promise<RecoveryWalkResponse>

get(string, string, VirtualMachineScaleSetsGetOptionalParams)

Display information about a virtual machine scale set.

function get(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOptionalParams): Promise<VirtualMachineScaleSet>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSet>

getInstanceView(string, string, VirtualMachineScaleSetsGetInstanceViewOptionalParams)

Gets the status of a VM scale set instance.

function getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetInstanceView>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsGetInstanceViewOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSetInstanceView>

list(string, VirtualMachineScaleSetsListOptionalParams)

Gets a list of all VM scale sets under a resource group.

function list(resourceGroupName: string, options?: VirtualMachineScaleSetsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group.

options: VirtualMachineScaleSetsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

listAll(VirtualMachineScaleSetsListAllOptionalParams)

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.

function listAll(options?: VirtualMachineScaleSetsListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

Parameters

options: VirtualMachineScaleSetsListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

listByLocation(string, VirtualMachineScaleSetsListByLocationOptionalParams)

Gets all the VM scale sets under the specified subscription for the specified location.

function listByLocation(location: string, options?: VirtualMachineScaleSetsListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

Parameters

location: string

The location for which VM scale sets under the subscription are queried.

options: VirtualMachineScaleSetsListByLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineScaleSet, VirtualMachineScaleSet[], PageSettings>

listOSUpgradeHistory(string, string, VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams)

Gets list of OS upgrades on a VM scale set instance.

function listOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo, UpgradeOperationHistoricalStatusInfo[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo, UpgradeOperationHistoricalStatusInfo[], PageSettings>

listSkus(string, string, VirtualMachineScaleSetsListSkusOptionalParams)

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

function listSkus(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListSkusOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetSku, VirtualMachineScaleSetSku[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group.

vmScaleSetName: string

The name of the VM scale set.

options: VirtualMachineScaleSetsListSkusOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineScaleSetSku, VirtualMachineScaleSetSku[], PageSettings>

Share via

VirtualMachineScaleSets interface

Methods

Method Details

beginApproveRollingUpgrade(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)

Parameters

Returns

beginApproveRollingUpgradeAndWait(string, string, VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams)

Parameters

Returns

beginCreateOrUpdate(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)

Parameters

Returns

beginCreateOrUpdateAndWait(string, string, VirtualMachineScaleSet, VirtualMachineScaleSetsCreateOrUpdateOptionalParams)

Parameters

Returns

beginDeallocate(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)

Parameters

Returns

beginDeallocateAndWait(string, string, VirtualMachineScaleSetsDeallocateOptionalParams)

Parameters

Returns

beginDelete(string, string, VirtualMachineScaleSetsDeleteOptionalParams)

Parameters

Returns

beginDeleteAndWait(string, string, VirtualMachineScaleSetsDeleteOptionalParams)

Parameters

Returns

beginDeleteInstances(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)

Parameters

Returns

beginDeleteInstancesAndWait(string, string, VirtualMachineScaleSetVMInstanceRequiredIDs, VirtualMachineScaleSetsDeleteInstancesOptionalParams)

Parameters

Returns

beginPerformMaintenance(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)

Parameters

Returns

beginPerformMaintenanceAndWait(string, string, VirtualMachineScaleSetsPerformMaintenanceOptionalParams)

Parameters

Returns

beginPowerOff(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)

Parameters

Returns

beginPowerOffAndWait(string, string, VirtualMachineScaleSetsPowerOffOptionalParams)

Parameters

Returns

beginReapply(string, string, VirtualMachineScaleSetsReapplyOptionalParams)

Parameters

Returns

beginReapplyAndWait(string, string, VirtualMachineScaleSetsReapplyOptionalParams)

Parameters

Returns

beginRedeploy(string, string, VirtualMachineScaleSetsRedeployOptionalParams)

Parameters

Returns

beginRedeployAndWait(string, string, VirtualMachineScaleSetsRedeployOptionalParams)

Parameters

Returns

beginReimage(string, string, VirtualMachineScaleSetsReimageOptionalParams)

Parameters

Returns

beginReimageAll(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)

Parameters

Returns

beginReimageAllAndWait(string, string, VirtualMachineScaleSetsReimageAllOptionalParams)

Parameters

Returns

beginReimageAndWait(string, string, VirtualMachineScaleSetsReimageOptionalParams)

Parameters

Returns

beginRestart(string, string, VirtualMachineScaleSetsRestartOptionalParams)

Parameters

Returns

beginRestartAndWait(string, string, VirtualMachineScaleSetsRestartOptionalParams)

Parameters

Returns

beginSetOrchestrationServiceState(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)

Parameters

Returns

beginSetOrchestrationServiceStateAndWait(string, string, OrchestrationServiceStateInput, VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams)