Package version:

Interface VirtualMachineScaleSets

Interface representing a VirtualMachineScaleSets.

interface VirtualMachineScaleSets {
    beginApproveRollingUpgrade(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetsApproveRollingUpgradeHeaders>>;
    beginApproveRollingUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams): Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>;
    beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: VirtualMachineScaleSetsCreateOrUpdateOptionalParams): Promise<VirtualMachineScaleSet>;
    beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeallocateOptionalParams): Promise<void>;
    beginDelete(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsDeleteOptionalParams): Promise<void>;
    beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsDeleteInstancesOptionalParams): Promise<void>;
    beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPerformMaintenanceOptionalParams): Promise<void>;
    beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsPowerOffOptionalParams): Promise<void>;
    beginReapply(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReapplyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReapplyAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReapplyOptionalParams): Promise<void>;
    beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRedeployOptionalParams): Promise<void>;
    beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageAllOptionalParams): Promise<void>;
    beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsReimageOptionalParams): Promise<void>;
    beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsRestartOptionalParams): Promise<void>;
    beginSetOrchestrationServiceState(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginSetOrchestrationServiceStateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: OrchestrationServiceStateInput, options?: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams): Promise<void>;
    beginStart(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsStartOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>;
    beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: VirtualMachineScaleSetsUpdateOptionalParams): Promise<VirtualMachineScaleSet>;
    beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginUpdateInstancesAndWait(resourceGroupName: string, vmScaleSetName: string, vmInstanceIDs: VirtualMachineScaleSetVMInstanceRequiredIDs, options?: VirtualMachineScaleSetsUpdateInstancesOptionalParams): Promise<void>;
    convertToSinglePlacementGroup(resourceGroupName: string, vmScaleSetName: string, parameters: VMScaleSetConvertToSinglePlacementGroupInput, options?: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams): Promise<void>;
    forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams): Promise<RecoveryWalkResponse>;
    get(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOptionalParams): Promise<VirtualMachineScaleSet>;
    getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetInstanceView>;
    list(resourceGroupName: string, options?: VirtualMachineScaleSetsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>;
    listAll(options?: VirtualMachineScaleSetsListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>;
    listByLocation(location: string, options?: VirtualMachineScaleSetsListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSet>;
    listOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo>;
    listSkus(resourceGroupName: string, vmScaleSetName: string, options?: VirtualMachineScaleSetsListSkusOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetSku>;
}

Index

Methods

beginApproveRollingUpgrade

beginApproveRollingUpgrade(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetsApproveRollingUpgradeHeaders>>
Approve upgrade on deferred rolling upgrades for OS disks in the 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.
- Optionaloptions: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>, VirtualMachineScaleSetsApproveRollingUpgradeHeaders>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:491

beginApproveRollingUpgradeAndWait

beginApproveRollingUpgradeAndWait(resourceGroupName, vmScaleSetName, options?): Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>
Approve upgrade on deferred rolling upgrades for OS disks in the 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.
- Optionaloptions: VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:507

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, vmScaleSetName, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
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.
- Optionaloptions: VirtualMachineScaleSetsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:112

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, vmScaleSetName, parameters, options?): Promise<VirtualMachineScaleSet>
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.
- Optionaloptions: VirtualMachineScaleSetsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:130

beginDeallocate

beginDeallocate(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsDeallocateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:208

beginDeallocateAndWait

beginDeallocateAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsDeallocateOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:221

beginDelete

beginDelete(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a VM scale set.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:173

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
Deletes a VM scale set.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:184

beginDeleteInstances

beginDeleteInstances(resourceGroupName, vmScaleSetName, vmInstanceIDs, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsDeleteInstancesOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:233

beginDeleteInstancesAndWait

beginDeleteInstancesAndWait(resourceGroupName, vmScaleSetName, vmInstanceIDs, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsDeleteInstancesOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:246

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:390

beginPerformMaintenanceAndWait

beginPerformMaintenanceAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:404

beginPowerOff

beginPowerOff(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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. Additionally, this operation is not allowed on virtual machines in a VM scale set that are being deallocated or have already been deallocated.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsPowerOffOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:272

beginPowerOffAndWait

beginPowerOffAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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. Additionally, this operation is not allowed on virtual machines in a VM scale set that are being deallocated or have already been deallocated.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsPowerOffOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:286

beginReapply

beginReapply(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsReapplyOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:341

beginReapplyAndWait

beginReapplyAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmScaleSetName: string
  The name of the VM scale set.
- Optionaloptions: VirtualMachineScaleSetsReapplyOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:352

beginRedeploy

beginRedeploy(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsRedeployOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:364

beginRedeployAndWait

beginRedeployAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsRedeployOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:376

beginReimage

beginReimage(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsReimageOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:443

beginReimageAll

beginReimageAll(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsReimageAllOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:468

beginReimageAllAndWait

beginReimageAllAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsReimageAllOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:480

beginReimageAndWait

beginReimageAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsReimageOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:456

beginRestart

beginRestart(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsRestartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:297

beginRestartAndWait

beginRestartAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsRestartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:308

beginSetOrchestrationServiceState

beginSetOrchestrationServiceState(resourceGroupName, vmScaleSetName, parameters, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:546

beginSetOrchestrationServiceStateAndWait

beginSetOrchestrationServiceStateAndWait(resourceGroupName, vmScaleSetName, parameters, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:559

beginStart

beginStart(resourceGroupName, vmScaleSetName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:319

beginStartAndWait

beginStartAndWait(resourceGroupName, vmScaleSetName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsStartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:330

beginUpdate

beginUpdate(resourceGroupName, vmScaleSetName, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
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.
- Optionaloptions: VirtualMachineScaleSetsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineScaleSet>, VirtualMachineScaleSet>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:143

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, vmScaleSetName, parameters, options?): Promise<VirtualMachineScaleSet>
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.
- Optionaloptions: VirtualMachineScaleSetsUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:161

beginUpdateInstances

beginUpdateInstances(resourceGroupName, vmScaleSetName, vmInstanceIDs, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachineScaleSetsUpdateInstancesOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:416

beginUpdateInstancesAndWait

beginUpdateInstancesAndWait(resourceGroupName, vmScaleSetName, vmInstanceIDs, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsUpdateInstancesOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:429

convertToSinglePlacementGroup

convertToSinglePlacementGroup(resourceGroupName, vmScaleSetName, parameters, options?): Promise<void>
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.
- Optionaloptions: VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:533

forceRecoveryServiceFabricPlatformUpdateDomainWalk

forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, vmScaleSetName, platformUpdateDomain, options?): Promise<RecoveryWalkResponse>
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
- Optionaloptions: VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams
  The options parameters.
Returns Promise<RecoveryWalkResponse>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:520

get

get(resourceGroupName, vmScaleSetName, options?): Promise<VirtualMachineScaleSet>
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.
- Optionaloptions: VirtualMachineScaleSetsGetOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:195

getInstanceView

getInstanceView(resourceGroupName, vmScaleSetName, options?): Promise<VirtualMachineScaleSetInstanceView>
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.
- Optionaloptions: VirtualMachineScaleSetsGetInstanceViewOptionalParams
  The options parameters.
Returns Promise<VirtualMachineScaleSetInstanceView>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:258

list

list(resourceGroupName, options?): PagedAsyncIterableIterator<VirtualMachineScaleSet>
Gets a list of all VM scale sets under a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: VirtualMachineScaleSetsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:69

listAll

listAll(options?): PagedAsyncIterableIterator<VirtualMachineScaleSet>
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
- Optionaloptions: VirtualMachineScaleSetsListAllOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:79

listByLocation

listByLocation(location, options?): PagedAsyncIterableIterator<VirtualMachineScaleSet>
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.
- Optionaloptions: VirtualMachineScaleSetsListByLocationOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSet>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:60

listOSUpgradeHistory

listOSUpgradeHistory(resourceGroupName, vmScaleSetName, options?): PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo>
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.
- Optionaloptions: VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<UpgradeOperationHistoricalStatusInfo>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:100

listSkus

listSkus(resourceGroupName, vmScaleSetName, options?): PagedAsyncIterableIterator<VirtualMachineScaleSetSku>
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.
- Optionaloptions: VirtualMachineScaleSetsListSkusOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSetSku>
- Defined in operationsInterfaces/virtualMachineScaleSets.ts:89

Interface VirtualMachineScaleSets

Index

Methods

Methods

beginApproveRollingUpgrade

Parameters

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

beginApproveRollingUpgradeAndWait

Parameters

Returns Promise<VirtualMachineScaleSetsApproveRollingUpgradeHeaders>

beginCreateOrUpdate

Parameters

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

beginCreateOrUpdateAndWait

Parameters

Returns Promise<VirtualMachineScaleSet>

beginDeallocate

Parameters

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

beginDeallocateAndWait

Parameters

Returns Promise<void>

beginDelete

Parameters

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

beginDeleteAndWait

Parameters

Returns Promise<void>

beginDeleteInstances

Parameters

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

beginDeleteInstancesAndWait

Parameters

Returns Promise<void>

beginPerformMaintenance

Parameters

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

beginPerformMaintenanceAndWait

Parameters

Returns Promise<void>

beginPowerOff

Parameters

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

beginPowerOffAndWait

Parameters

Returns Promise<void>

beginReapply

Parameters

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

beginReapplyAndWait

Parameters

Returns Promise<void>

beginRedeploy

Parameters

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

beginRedeployAndWait

Parameters

Returns Promise<void>

beginReimage

Parameters

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

beginReimageAll

Parameters

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

beginReimageAllAndWait

Parameters

Returns Promise<void>

beginReimageAndWait

Parameters

Returns Promise<void>

beginRestart

Parameters

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

beginRestartAndWait

Parameters

Returns Promise<void>

beginSetOrchestrationServiceState

Parameters

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

beginSetOrchestrationServiceStateAndWait