VirtualMachineScaleSets interface

Methods

beginCreateOrUpdate

Create or update a VM scale set.

beginCreateOrUpdate

Create or update a VM scale set.

beginCreateOrUpdate

Create or update a VM scale set.

beginCreateOrUpdateWithHttpOperationResponse

Create or update a VM scale set.

beginDeallocate

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.

beginDeallocate

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.

beginDeallocate

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.

beginDeallocateWithHttpOperationResponse

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.

beginDeleteInstances

Deletes virtual machines in a VM scale set.

beginDeleteInstances

Deletes virtual machines in a VM scale set.

beginDeleteInstances

Deletes virtual machines in a VM scale set.

beginDeleteInstancesWithHttpOperationResponse

Deletes virtual machines in a VM scale set.

beginDeleteMethod

Deletes a VM scale set.

beginDeleteMethod

Deletes a VM scale set.

beginDeleteMethod

Deletes a VM scale set.

beginDeleteMethodWithHttpOperationResponse

Deletes a VM scale set.

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

beginPerformMaintenanceWithHttpOperationResponse

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

beginPowerOff

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.

beginPowerOff

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.

beginPowerOff

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.

beginPowerOffWithHttpOperationResponse

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.

beginRedeploy

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

beginRedeploy

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

beginRedeploy

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

beginRedeployWithHttpOperationResponse

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

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

beginReimageAll

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

beginReimageAll

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

beginReimageAll

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

beginReimageAllWithHttpOperationResponse

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

beginReimageWithHttpOperationResponse

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

beginRestart

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

beginRestart

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

beginRestart

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

beginRestartWithHttpOperationResponse

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

beginStart

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

beginStart

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

beginStart

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

beginStartWithHttpOperationResponse

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

beginUpdate

Update a VM scale set.

beginUpdate

Update a VM scale set.

beginUpdate

Update a VM scale set.

beginUpdateInstances

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

beginUpdateInstances

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

beginUpdateInstances

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

beginUpdateInstancesWithHttpOperationResponse

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

beginUpdateWithHttpOperationResponse

Update a VM scale set.

createOrUpdate

Create or update a VM scale set.

createOrUpdate

Create or update a VM scale set.

createOrUpdate

Create or update a VM scale set.

createOrUpdateWithHttpOperationResponse

Create or update a VM scale set.

deallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

deallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

deallocate

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.

deallocateWithHttpOperationResponse

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.

deleteInstances

Deletes virtual machines in a VM scale set.

deleteInstances

Deletes virtual machines in a VM scale set.

deleteInstances

Deletes virtual machines in a VM scale set.

deleteInstancesWithHttpOperationResponse

Deletes virtual machines in a VM scale set.

deleteMethod

Deletes a VM scale set.

deleteMethod

Deletes a VM scale set.

deleteMethod

Deletes a VM scale set.

deleteMethodWithHttpOperationResponse

Deletes a VM scale set.

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

forceRecoveryServiceFabricPlatformUpdateDomainWalkWithHttpOperationResponse

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

get

Display information about a virtual machine scale set.

get

Display information about a virtual machine scale set.

get

Display information about a virtual machine scale set.

getInstanceView

Gets the status of a VM scale set instance.

getInstanceView

Gets the status of a VM scale set instance.

getInstanceView

Gets the status of a VM scale set instance.

getInstanceViewWithHttpOperationResponse

Gets the status of a VM scale set instance.

getOSUpgradeHistory

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

getOSUpgradeHistory

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

getOSUpgradeHistory

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

getOSUpgradeHistoryNext

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

getOSUpgradeHistoryNext

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

getOSUpgradeHistoryNext

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

getOSUpgradeHistoryNextWithHttpOperationResponse

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

getOSUpgradeHistoryWithHttpOperationResponse

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

getWithHttpOperationResponse

Display information about a virtual machine scale set.

list

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

list

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

list

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

listAll

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

listAll

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

listAll

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.

listAllNext

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.

listAllNext

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.

listAllNext

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.

listAllNextWithHttpOperationResponse

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.

listAllWithHttpOperationResponse

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.

listNext

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

listNext

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

listNext

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

listNextWithHttpOperationResponse

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

listSkus

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

listSkus

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

listSkus

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

listSkusNext

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

listSkusNext

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

listSkusNext

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

listSkusNextWithHttpOperationResponse

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

listSkusWithHttpOperationResponse

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

listWithHttpOperationResponse

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

performMaintenance

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

performMaintenance

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

performMaintenance

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

performMaintenanceWithHttpOperationResponse

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

powerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

powerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

powerOff

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.

powerOffWithHttpOperationResponse

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.

redeploy

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

redeploy

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

redeploy

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

redeployWithHttpOperationResponse

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

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

reimageAll

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

reimageAll

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

reimageAll

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

reimageAllWithHttpOperationResponse

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

reimageWithHttpOperationResponse

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

restart

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

restart

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

restart

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

restartWithHttpOperationResponse

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

start

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

start

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

start

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

startWithHttpOperationResponse

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

update

Update a VM scale set.

update

Update a VM scale set.

update

Update a VM scale set.

updateInstances

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

updateInstances

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

updateInstances

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

updateInstancesWithHttpOperationResponse

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

updateWithHttpOperationResponse

Update a VM scale set.

Method Details

beginCreateOrUpdate

Create or update a VM scale set.

function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSet

The scale set object.

options
Object
Returns

beginCreateOrUpdate

Create or update a VM scale set.

function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

beginCreateOrUpdate

Create or update a VM scale set.

function beginCreateOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options: Object, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

beginCreateOrUpdateWithHttpOperationResponse

Create or update a VM scale set.

function beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSet

The scale set object.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSet>>

beginDeallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginDeallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function beginDeallocate(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeallocateWithHttpOperationResponse

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function beginDeallocateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginDeleteInstances

Deletes virtual machines in a VM scale set.

function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeleteInstances

Deletes virtual machines in a VM scale set.

function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeleteInstances

Deletes virtual machines in a VM scale set.

function beginDeleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<void>

beginDeleteInstancesWithHttpOperationResponse

Deletes virtual machines in a VM scale set.

function beginDeleteInstancesWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginDeleteMethod

Deletes a VM scale set.

function beginDeleteMethod(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeleteMethod

Deletes a VM scale set.

function beginDeleteMethod(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginDeleteMethod

Deletes a VM scale set.

function beginDeleteMethod(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginDeleteMethodWithHttpOperationResponse

Deletes a VM scale set.

function beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginPerformMaintenance

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

function beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginPerformMaintenanceWithHttpOperationResponse

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

function beginPerformMaintenanceWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginPowerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginPowerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function beginPowerOff(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginPowerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function beginPowerOff(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginPowerOffWithHttpOperationResponse

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function beginPowerOffWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginRedeploy

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

function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginRedeploy

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

function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginRedeploy

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

function beginRedeploy(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginRedeployWithHttpOperationResponse

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

function beginRedeployWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function beginReimage(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function beginReimage(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginReimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function beginReimage(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginReimageAll

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

function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginReimageAll

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

function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginReimageAll

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

function beginReimageAll(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginReimageAllWithHttpOperationResponse

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

function beginReimageAllWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginReimageWithHttpOperationResponse

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function beginReimageWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginRestart

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

function beginRestart(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginRestart

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

function beginRestart(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginRestart

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

function beginRestart(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginRestartWithHttpOperationResponse

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

function beginRestartWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginStart

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

function beginStart(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

beginStart

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

function beginStart(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginStart

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

function beginStart(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

beginStartWithHttpOperationResponse

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

function beginStartWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginUpdate

Update a VM scale set.

function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

beginUpdate

Update a VM scale set.

function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options: Object, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

beginUpdate

Update a VM scale set.

function beginUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSetUpdate

The scale set object.

options
Object
Returns

beginUpdateInstances

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

function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<void>

beginUpdateInstances

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

function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
callback
ServiceCallback<void>
Returns
Promise<void>

beginUpdateInstances

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

function beginUpdateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

beginUpdateInstancesWithHttpOperationResponse

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

function beginUpdateInstancesWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<HttpOperationResponse<void>>

beginUpdateWithHttpOperationResponse

Update a VM scale set.

function beginUpdateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSetUpdate

The scale set object.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSet>>

createOrUpdate

Create or update a VM scale set.

function createOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

createOrUpdate

Create or update a VM scale set.

function createOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options: Object, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

createOrUpdate

Create or update a VM scale set.

function createOrUpdate(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSet

The scale set object.

options
Object
Returns

createOrUpdateWithHttpOperationResponse

Create or update a VM scale set.

function createOrUpdateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSet, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSet

The scale set object.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSet>>

deallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function deallocate(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

deallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function deallocate(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

deallocate

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function deallocate(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

deallocateWithHttpOperationResponse

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

function deallocateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

deleteInstances

Deletes virtual machines in a VM scale set.

function deleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
callback
ServiceCallback<void>
Returns
Promise<void>

deleteInstances

Deletes virtual machines in a VM scale set.

function deleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<void>

deleteInstances

Deletes virtual machines in a VM scale set.

function deleteInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

deleteInstancesWithHttpOperationResponse

Deletes virtual machines in a VM scale set.

function deleteInstancesWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<HttpOperationResponse<void>>

deleteMethod

Deletes a VM scale set.

function deleteMethod(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

deleteMethod

Deletes a VM scale set.

function deleteMethod(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

deleteMethod

Deletes a VM scale set.

function deleteMethod(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

deleteMethodWithHttpOperationResponse

Deletes a VM scale set.

function deleteMethodWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

platformUpdateDomain
number

The platform update domain for which a manual recovery walk is requested

options
Object
Returns

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, callback: ServiceCallback<RecoveryWalkResponse>)
Parameters
resourceGroupName
string
vmScaleSetName
string
platformUpdateDomain
number
callback
ServiceCallback<RecoveryWalkResponse>
Returns

forceRecoveryServiceFabricPlatformUpdateDomainWalk

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

function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options: Object, callback: ServiceCallback<RecoveryWalkResponse>)
Parameters
resourceGroupName
string
vmScaleSetName
string
platformUpdateDomain
number
options
Object
callback
ServiceCallback<RecoveryWalkResponse>
Returns

forceRecoveryServiceFabricPlatformUpdateDomainWalkWithHttpOperationResponse

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

function forceRecoveryServiceFabricPlatformUpdateDomainWalkWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, platformUpdateDomain: number, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

platformUpdateDomain
number

The platform update domain for which a manual recovery walk is requested

options
Object
Returns
Promise<HttpOperationResponse<RecoveryWalkResponse>>

get

Display information about a virtual machine scale set.

function get(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns

get

Display information about a virtual machine scale set.

function get(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

get

Display information about a virtual machine scale set.

function get(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

getInstanceView

Gets the status of a VM scale set instance.

function getInstanceView(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns

getInstanceView

Gets the status of a VM scale set instance.

function getInstanceView(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<VirtualMachineScaleSetInstanceView>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSetInstanceView>
Returns

getInstanceView

Gets the status of a VM scale set instance.

function getInstanceView(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetInstanceView>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetInstanceView>
Returns

getInstanceViewWithHttpOperationResponse

Gets the status of a VM scale set instance.

function getInstanceViewWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetInstanceView>>

getOSUpgradeHistory

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

function getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns

getOSUpgradeHistory

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

function getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>
Returns

getOSUpgradeHistory

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

function getOSUpgradeHistory(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>
Returns

getOSUpgradeHistoryNext

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

function getOSUpgradeHistoryNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>)
Parameters
nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>
Returns

getOSUpgradeHistoryNext

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

function getOSUpgradeHistoryNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>)
Parameters
nextPageLink
string
callback
ServiceCallback<VirtualMachineScaleSetListOSUpgradeHistory>
Returns

getOSUpgradeHistoryNext

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

function getOSUpgradeHistoryNext(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns

getOSUpgradeHistoryNextWithHttpOperationResponse

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

function getOSUpgradeHistoryNextWithHttpOperationResponse(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListOSUpgradeHistory>>

getOSUpgradeHistoryWithHttpOperationResponse

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

function getOSUpgradeHistoryWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListOSUpgradeHistory>>

getWithHttpOperationResponse

Display information about a virtual machine scale set.

function getWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSet>>

list

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

function list(resourceGroupName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

options
Object
Returns

list

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

function list(resourceGroupName: string, callback: ServiceCallback<VirtualMachineScaleSetListResult>)
Parameters
resourceGroupName
string
callback
ServiceCallback<VirtualMachineScaleSetListResult>
Returns

list

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

function list(resourceGroupName: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListResult>)
Parameters
resourceGroupName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListResult>
Returns

listAll

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAll(callback: ServiceCallback<VirtualMachineScaleSetListWithLinkResult>)
Parameters
callback
ServiceCallback<VirtualMachineScaleSetListWithLinkResult>
Returns

listAll

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAll(options: Object, callback: ServiceCallback<VirtualMachineScaleSetListWithLinkResult>)
Parameters
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListWithLinkResult>
Returns

listAll

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAll(options?: Object)
Parameters
options
Object
Returns

listAllNext

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAllNext(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns

listAllNext

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAllNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListWithLinkResult>)
Parameters
nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListWithLinkResult>
Returns

listAllNext

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAllNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineScaleSetListWithLinkResult>)
Parameters
nextPageLink
string
callback
ServiceCallback<VirtualMachineScaleSetListWithLinkResult>
Returns

listAllNextWithHttpOperationResponse

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAllNextWithHttpOperationResponse(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListWithLinkResult>>

listAllWithHttpOperationResponse

Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.

function listAllWithHttpOperationResponse(options?: Object)
Parameters
options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListWithLinkResult>>

listNext

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

function listNext(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns

listNext

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

function listNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListResult>)
Parameters
nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListResult>
Returns

listNext

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

function listNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineScaleSetListResult>)
Parameters
nextPageLink
string
callback
ServiceCallback<VirtualMachineScaleSetListResult>
Returns

listNextWithHttpOperationResponse

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

function listNextWithHttpOperationResponse(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListResult>>

listSkus

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

function listSkus(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<VirtualMachineScaleSetListSkusResult>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSetListSkusResult>
Returns

listSkus

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

function listSkus(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns

listSkus

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

function listSkus(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListSkusResult>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListSkusResult>
Returns

listSkusNext

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

function listSkusNext(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns

listSkusNext

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

function listSkusNext(nextPageLink: string, callback: ServiceCallback<VirtualMachineScaleSetListSkusResult>)
Parameters
nextPageLink
string
callback
ServiceCallback<VirtualMachineScaleSetListSkusResult>
Returns

listSkusNext

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

function listSkusNext(nextPageLink: string, options: Object, callback: ServiceCallback<VirtualMachineScaleSetListSkusResult>)
Parameters
nextPageLink
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSetListSkusResult>
Returns

listSkusNextWithHttpOperationResponse

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

function listSkusNextWithHttpOperationResponse(nextPageLink: string, options?: Object)
Parameters
nextPageLink
string

The NextLink from the previous successful call to List operation.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListSkusResult>>

listSkusWithHttpOperationResponse

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

function listSkusWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListSkusResult>>

listWithHttpOperationResponse

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

function listWithHttpOperationResponse(resourceGroupName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSetListResult>>

performMaintenance

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

function performMaintenance(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

performMaintenance

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

function performMaintenance(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

performMaintenance

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

function performMaintenance(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

performMaintenanceWithHttpOperationResponse

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/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

function performMaintenanceWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

powerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function powerOff(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

powerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function powerOff(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

powerOff

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function powerOff(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

powerOffWithHttpOperationResponse

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

function powerOffWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

redeploy

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

function redeploy(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

redeploy

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

function redeploy(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

redeploy

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

function redeploy(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

redeployWithHttpOperationResponse

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

function redeployWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function reimage(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function reimage(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

reimage

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function reimage(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

reimageAll

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

function reimageAll(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

reimageAll

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

function reimageAll(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

reimageAll

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

function reimageAll(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

reimageAllWithHttpOperationResponse

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

function reimageAllWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

reimageWithHttpOperationResponse

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

function reimageWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

restart

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

function restart(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

restart

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

function restart(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

restart

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

function restart(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

restartWithHttpOperationResponse

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

function restartWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

start

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

function start(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<void>

start

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

function start(resourceGroupName: string, vmScaleSetName: string, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<void>
Returns
Promise<void>

start

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

function start(resourceGroupName: string, vmScaleSetName: string, options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

startWithHttpOperationResponse

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

function startWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

options
Object
Returns
Promise<HttpOperationResponse<void>>

update

Update a VM scale set.

function update(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSetUpdate

The scale set object.

options
Object
Returns

update

Update a VM scale set.

function update(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

update

Update a VM scale set.

function update(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options: Object, callback: ServiceCallback<VirtualMachineScaleSet>)
Parameters
resourceGroupName
string
vmScaleSetName
string
options
Object
callback
ServiceCallback<VirtualMachineScaleSet>
Returns

updateInstances

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

function updateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<void>

updateInstances

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

function updateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
callback
ServiceCallback<void>
Returns
Promise<void>

updateInstances

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

function updateInstances(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options: Object, callback: ServiceCallback<void>)
Parameters
resourceGroupName
string
vmScaleSetName
string
instanceIds
string[]
options
Object
callback
ServiceCallback<void>
Returns
Promise<void>

updateInstancesWithHttpOperationResponse

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

function updateInstancesWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, instanceIds: string[], options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set.

instanceIds
string[]

The virtual machine scale set instance ids.

options
Object
Returns
Promise<HttpOperationResponse<void>>

updateWithHttpOperationResponse

Update a VM scale set.

function updateWithHttpOperationResponse(resourceGroupName: string, vmScaleSetName: string, parameters: VirtualMachineScaleSetUpdate, options?: Object)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
VirtualMachineScaleSetUpdate

The scale set object.

options
Object
Returns
Promise<HttpOperationResponse<VirtualMachineScaleSet>>