VirtualMachineScaleSetsImpl | @azure/arm-compute

Class containing VirtualMachineScaleSets operations.

Hierarchy

VirtualMachineScaleSetsImpl

Implements

VirtualMachineScaleSets

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualMachineScaleSetsImpl(client: ComputeManagementClientContext): VirtualMachineScaleSetsImpl

- Defined in operations/virtualMachineScaleSets.ts:74
Initialize a new instance of the class VirtualMachineScaleSets class.

Parameters
- client: ComputeManagementClientContext
  
  Reference to the service client
Returns VirtualMachineScaleSetsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSetsCreateOrUpdateResponse>, VirtualMachineScaleSetsCreateOrUpdateResponse>>

Implementation of VirtualMachineScaleSets.beginCreateOrUpdate
- Defined in operations/virtualMachineScaleSets.ts:393
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: VirtualMachineScaleSetsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachineScaleSetsCreateOrUpdateResponse>, VirtualMachineScaleSetsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of VirtualMachineScaleSets.beginCreateOrUpdateAndWait
- Defined in operations/virtualMachineScaleSets.ts:461
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: VirtualMachineScaleSetsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetsCreateOrUpdateResponse>

beginDeallocate

beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginDeallocate
- Defined in operations/virtualMachineScaleSets.ts:671
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: VirtualMachineScaleSetsDeallocateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeallocateAndWait

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

Implementation of VirtualMachineScaleSets.beginDeallocateAndWait
- Defined in operations/virtualMachineScaleSets.ts:734
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: VirtualMachineScaleSetsDeallocateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDelete

beginDelete(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginDelete
- Defined in operations/virtualMachineScaleSets.ts:572
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: VirtualMachineScaleSetsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of VirtualMachineScaleSets.beginDeleteAndWait
- Defined in operations/virtualMachineScaleSets.ts:633
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: VirtualMachineScaleSetsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteInstances

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

Implementation of VirtualMachineScaleSets.beginDeleteInstances
- Defined in operations/virtualMachineScaleSets.ts:754
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: VirtualMachineScaleSetsDeleteInstancesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteInstancesAndWait

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

Implementation of VirtualMachineScaleSets.beginDeleteInstancesAndWait
- Defined in operations/virtualMachineScaleSets.ts:817
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: VirtualMachineScaleSetsDeleteInstancesOptionalParams
  
  The options parameters.
Returns Promise<void>

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginPerformMaintenance
- Defined in operations/virtualMachineScaleSets.ts:1246
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

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPerformMaintenanceAndWait

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

Implementation of VirtualMachineScaleSets.beginPerformMaintenanceAndWait
- Defined in operations/virtualMachineScaleSets.ts:1310
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

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams
  
  The options parameters.
Returns Promise<void>

beginPowerOff

beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginPowerOff
- Defined in operations/virtualMachineScaleSets.ts:919
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: VirtualMachineScaleSetsPowerOffOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPowerOffAndWait

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

Implementation of VirtualMachineScaleSets.beginPowerOffAndWait
- Defined in operations/virtualMachineScaleSets.ts:982
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: VirtualMachineScaleSetsPowerOffOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRedeploy

beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginRedeploy
- Defined in operations/virtualMachineScaleSets.ts:1162
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsRedeployOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRedeployAndWait

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

Implementation of VirtualMachineScaleSets.beginRedeployAndWait
- Defined in operations/virtualMachineScaleSets.ts:1224
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsRedeployOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReimage

beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginReimage
- Defined in operations/virtualMachineScaleSets.ts:1416
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsReimageOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAll

beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginReimageAll
- Defined in operations/virtualMachineScaleSets.ts:1499
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: VirtualMachineScaleSetsReimageAllOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAllAndWait

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

Implementation of VirtualMachineScaleSets.beginReimageAllAndWait
- Defined in operations/virtualMachineScaleSets.ts:1561
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: VirtualMachineScaleSetsReimageAllOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReimageAndWait

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

Implementation of VirtualMachineScaleSets.beginReimageAndWait
- Defined in operations/virtualMachineScaleSets.ts:1479
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetsReimageOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginRestart
- Defined in operations/virtualMachineScaleSets.ts:1001
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: VirtualMachineScaleSetsRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

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

Implementation of VirtualMachineScaleSets.beginRestartAndWait
- Defined in operations/virtualMachineScaleSets.ts:1062
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: VirtualMachineScaleSetsRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginSetOrchestrationServiceState

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

Implementation of VirtualMachineScaleSets.beginSetOrchestrationServiceState
- Defined in operations/virtualMachineScaleSets.ts:1622
Changes ServiceState property for a given service

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.
- Optional options: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginSetOrchestrationServiceStateAndWait

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

Implementation of VirtualMachineScaleSets.beginSetOrchestrationServiceStateAndWait
- Defined in operations/virtualMachineScaleSets.ts:1685
Changes ServiceState property for a given service

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.
- Optional options: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachineScaleSets.beginStart
- Defined in operations/virtualMachineScaleSets.ts:1081
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: VirtualMachineScaleSetsStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

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

Implementation of VirtualMachineScaleSets.beginStartAndWait
- Defined in operations/virtualMachineScaleSets.ts:1142
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: VirtualMachineScaleSetsStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSetsUpdateResponse>, VirtualMachineScaleSetsUpdateResponse>>

Implementation of VirtualMachineScaleSets.beginUpdate
- Defined in operations/virtualMachineScaleSets.ts:483
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: VirtualMachineScaleSetsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachineScaleSetsUpdateResponse>, VirtualMachineScaleSetsUpdateResponse>>

beginUpdateAndWait

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

Implementation of VirtualMachineScaleSets.beginUpdateAndWait
- Defined in operations/virtualMachineScaleSets.ts:551
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: VirtualMachineScaleSetsUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetsUpdateResponse>

beginUpdateInstances

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

Implementation of VirtualMachineScaleSets.beginUpdateInstances
- Defined in operations/virtualMachineScaleSets.ts:1330
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: VirtualMachineScaleSetsUpdateInstancesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginUpdateInstancesAndWait

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

Implementation of VirtualMachineScaleSets.beginUpdateInstancesAndWait
- Defined in operations/virtualMachineScaleSets.ts:1393
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: VirtualMachineScaleSetsUpdateInstancesOptionalParams
  
  The options parameters.
Returns Promise<void>

convertToSinglePlacementGroup

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

Implementation of VirtualMachineScaleSets.convertToSinglePlacementGroup
- Defined in operations/virtualMachineScaleSets.ts:1603
Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

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.
- Optional options: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams
  
  The options parameters.
Returns Promise<void>

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

Implementation of VirtualMachineScaleSets.forceRecoveryServiceFabricPlatformUpdateDomainWalk
- Defined in operations/virtualMachineScaleSets.ts:1582
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: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse>

get

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

Implementation of VirtualMachineScaleSets.get
- Defined in operations/virtualMachineScaleSets.ts:652
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: VirtualMachineScaleSetsGetOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetsGetResponse>

getInstanceView

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

Implementation of VirtualMachineScaleSets.getInstanceView
- Defined in operations/virtualMachineScaleSets.ts:838
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: VirtualMachineScaleSetsGetInstanceViewOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetsGetInstanceViewResponse>

list

list(resourceGroupName: string, options?: VirtualMachineScaleSetsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>

Implementation of VirtualMachineScaleSets.list
- Defined in operations/virtualMachineScaleSets.ts:139
Gets a list of all VM scale sets under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: VirtualMachineScaleSetsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>

listAll

listAll(options?: VirtualMachineScaleSetsListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>

Implementation of VirtualMachineScaleSets.listAll
- Defined in operations/virtualMachineScaleSets.ts:190
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
- Optional options: VirtualMachineScaleSetsListAllOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>

listByLocation

listByLocation(location: string, options?: VirtualMachineScaleSetsListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>

Implementation of VirtualMachineScaleSets.listByLocation
- Defined in operations/virtualMachineScaleSets.ts:89
Gets all the VM scale sets under the specified subscription for the specified location.

Parameters
- location: string
  
  The location for which VM scale sets under the subscription are queried.
- Optional options: VirtualMachineScaleSetsListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>

listOSUpgradeHistory

listOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo>

Implementation of VirtualMachineScaleSets.listOSUpgradeHistory
- Defined in operations/virtualMachineScaleSets.ts:306
Gets list of OS upgrades on 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: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo>

listSkus

listSkus(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListSkusOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetSku>

Implementation of VirtualMachineScaleSets.listSkus
- Defined in operations/virtualMachineScaleSets.ts:235
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: VirtualMachineScaleSetsListSkusOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSetSku>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ComputeManagementClientContext

Returns VirtualMachineScaleSetsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

vmScaleSetName: string

parameters: VirtualMachineScaleSet

Optional options: VirtualMachineScaleSetsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<VirtualMachineScaleSetsCreateOrUpdateResponse>, VirtualMachineScaleSetsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

parameters: VirtualMachineScaleSet

Optional options: VirtualMachineScaleSetsCreateOrUpdateOptionalParams

Returns Promise<VirtualMachineScaleSetsCreateOrUpdateResponse>

beginDeallocate

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsDeallocateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeallocateAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsDeallocateOptionalParams

Returns Promise<void>

beginDelete

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsDeleteOptionalParams

Returns Promise<void>

beginDeleteInstances

Parameters

resourceGroupName: string

vmScaleSetName: string

vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

Optional options: VirtualMachineScaleSetsDeleteInstancesOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteInstancesAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs

Optional options: VirtualMachineScaleSetsDeleteInstancesOptionalParams

Returns Promise<void>

beginPerformMaintenance

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPerformMaintenanceAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsPerformMaintenanceOptionalParams

Returns Promise<void>

beginPowerOff

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsPowerOffOptionalParams