VirtualMachineScaleSets | @azure/arm-compute

Interface representing a VirtualMachineScaleSets.

Hierarchy

VirtualMachineScaleSets

Implemented by

VirtualMachineScaleSetsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:110
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:128
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:206
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:219
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:171
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:182
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:231
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:244
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:364
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:378
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:269
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:282
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:338
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:350
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:417
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:442
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:454
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:430
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:293
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:304
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:495
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:508
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:315
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:326
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:141
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:159
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>>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:390
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:403
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:482
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:467
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:193
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:256
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:67
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:77
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:58
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:98
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>

- Defined in operationsInterfaces/virtualMachineScaleSets.ts:87
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

Implemented by

Index

Methods

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

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

beginPowerOffAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

Optional options: VirtualMachineScaleSetsPowerOffOptionalParams