VirtualMachineScaleSetsOperations interface

Package:
@azure/arm-compute

Interface representing a VirtualMachineScaleSets operations.

Properties

approveRollingUpgrade

Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
beginApproveRollingUpgrade
beginApproveRollingUpgradeAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDeallocate
beginDeallocateAndWait
beginDelete
beginDeleteAndWait
beginDeleteInstances
beginDeleteInstancesAndWait
beginPerformMaintenance
beginPerformMaintenanceAndWait
beginPowerOff
beginPowerOffAndWait
beginReapply
beginReapplyAndWait
beginRedeploy
beginRedeployAndWait
beginReimage
beginReimageAll
beginReimageAllAndWait
beginReimageAndWait
beginRestart
beginRestartAndWait
beginScaleOut
beginScaleOutAndWait
beginSetOrchestrationServiceState
beginSetOrchestrationServiceStateAndWait
beginStart
beginStartAndWait
beginUpdate
beginUpdateAndWait
beginUpdateInstances
beginUpdateInstancesAndWait
convertToSinglePlacementGroup

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

Create or update a VM scale set.
deallocate

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.
delete
deleteInstances

Deletes virtual machines in a VM scale set.
forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

Display information about a virtual machine scale set.
getInstanceView

Gets the status of a VM scale set instance.
list

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

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

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

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

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

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
powerOff

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

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

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

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

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

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

Scales out one or more virtual machines in a VM scale set.
setOrchestrationServiceState

Changes ServiceState property for a given service
start

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

Update a VM scale set.
updateInstances

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

Property Details

approveRollingUpgrade

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

approveRollingUpgrade: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams) => PollerLike<OperationState<void>, void>

beginApproveRollingUpgrade

Warning

This API is now deprecated.

use approveRollingUpgrade instead

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

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginApproveRollingUpgradeAndWait

Warning

This API is now deprecated.

use approveRollingUpgrade instead

beginApproveRollingUpgradeAndWait: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams) => Promise<void>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDeallocate

Warning

This API is now deprecated.

use deallocate instead

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

Property Value

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

beginDeallocateAndWait

Warning

This API is now deprecated.

use deallocate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteInstances

Warning

This API is now deprecated.

use deleteInstances instead

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

Property Value

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

beginDeleteInstancesAndWait

Warning

This API is now deprecated.

use deleteInstances instead

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

Property Value

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

beginPerformMaintenance

Warning

This API is now deprecated.

use performMaintenance instead

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

Property Value

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

beginPerformMaintenanceAndWait

Warning

This API is now deprecated.

use performMaintenance instead

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

Property Value

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

beginPowerOff

Warning

This API is now deprecated.

use powerOff instead

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

Property Value

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

beginPowerOffAndWait

Warning

This API is now deprecated.

use powerOff instead

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

Property Value

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

beginReapply

Warning

This API is now deprecated.

use reapply instead

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

Property Value

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

beginReapplyAndWait

Warning

This API is now deprecated.

use reapply instead

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

Property Value

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

beginRedeploy

Warning

This API is now deprecated.

use redeploy instead

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

Property Value

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

beginRedeployAndWait

Warning

This API is now deprecated.

use redeploy instead

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

Property Value

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

beginReimage

Warning

This API is now deprecated.

use reimage instead

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

Property Value

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

beginReimageAll

Warning

This API is now deprecated.

use reimageAll instead

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

Property Value

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

beginReimageAllAndWait

Warning

This API is now deprecated.

use reimageAll instead

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

Property Value

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

beginReimageAndWait

Warning

This API is now deprecated.

use reimage instead

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

Property Value

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

beginRestart

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginScaleOut

Warning

This API is now deprecated.

use scaleOut instead

beginScaleOut: (resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginScaleOutAndWait

Warning

This API is now deprecated.

use scaleOut instead

beginScaleOutAndWait: (resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => Promise<void>

beginSetOrchestrationServiceState

Warning

This API is now deprecated.

use setOrchestrationServiceState instead

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

Property Value

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

beginSetOrchestrationServiceStateAndWait

Warning

This API is now deprecated.

use setOrchestrationServiceState instead

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

Property Value

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

beginStart

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStartAndWait

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateInstances

Warning

This API is now deprecated.

use updateInstances instead

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

Property Value

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

beginUpdateInstancesAndWait

Warning

This API is now deprecated.

use updateInstances instead

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

Property Value

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

convertToSinglePlacementGroup

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

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

Property Value

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

createOrUpdate

Create or update a VM scale set.

createOrUpdate: (resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>

deallocate

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.

deallocate: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams) => PollerLike<OperationState<void>, void>

delete 

delete: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deleteInstances

Deletes virtual machines in a VM scale set.

deleteInstances: (resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams) => PollerLike<OperationState<void>, void>

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

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

Property Value

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

get

Display information about a virtual machine scale set.

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

Property Value

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

getInstanceView

Gets the status of a VM scale set instance.

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

Property Value

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

list

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

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

Property Value

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

listAll

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.

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

Property Value

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

listByLocation

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

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

Property Value

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

listOSUpgradeHistory

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

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

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListOSUpgradeHistoryOptionalParams) => PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo, UpgradeOperationHistoricalStatusInfo[], PageSettings>

listSkus

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

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

Property Value

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

performMaintenance

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

performMaintenance: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams) => PollerLike<OperationState<void>, void>

powerOff

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.

powerOff: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams) => PollerLike<OperationState<void>, void>

reapply

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

reapply: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReapplyOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReapplyOptionalParams) => PollerLike<OperationState<void>, void>

redeploy

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

redeploy: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams) => PollerLike<OperationState<void>, void>

reimage

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.

reimage: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams) => PollerLike<OperationState<void>, void>

reimageAll

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

reimageAll: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams) => PollerLike<OperationState<void>, void>

restart

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

restart: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams) => PollerLike<OperationState<void>, void>

scaleOut

Scales out one or more virtual machines in a VM scale set.

scaleOut: (resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetScaleOutInput, options?: VirtualMachineScaleSetsScaleOutOptionalParams) => PollerLike<OperationState<void>, void>

setOrchestrationServiceState

Changes ServiceState property for a given service

setOrchestrationServiceState: (resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams) => PollerLike<OperationState<void>, void>

start

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

start: (resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams) => PollerLike<OperationState<void>, void>

update

Update a VM scale set.

update: (resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams) => PollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>

Property Value

(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams) => PollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>

updateInstances

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

updateInstances: (resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams) => PollerLike<OperationState<void>, void>