VirtualMachineScaleSetVMs interface

Package:

@azure/arm-compute-profile-2020-09-01-hybrid

Interface representing a VirtualMachineScaleSetVMs.

Methods

beginDeallocate(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)	Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
beginDeallocateAndWait(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)	Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
beginDelete(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)	Deletes a virtual machine from a VM scale set.
beginDeleteAndWait(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)	Deletes a virtual machine from a VM scale set.
beginPerformMaintenance(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)	Performs maintenance on a virtual machine in a VM scale set.
beginPerformMaintenanceAndWait(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)	Performs maintenance on a virtual machine in a VM scale set.
beginPowerOff(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)	Power off (stop) a virtual machine 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.
beginPowerOffAndWait(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)	Power off (stop) a virtual machine 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(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)	Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
beginRedeployAndWait(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)	Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
beginReimage(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)	Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
beginReimageAll(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)	Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
beginReimageAllAndWait(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)	Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
beginReimageAndWait(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)	Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
beginRestart(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)	Restarts a virtual machine in a VM scale set.
beginRestartAndWait(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)	Restarts a virtual machine in a VM scale set.
beginStart(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)	Starts a virtual machine in a VM scale set.
beginStartAndWait(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)	Starts a virtual machine in a VM scale set.
beginUpdate(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)	Updates a virtual machine of a VM scale set.
beginUpdateAndWait(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)	Updates a virtual machine of a VM scale set.
get(string, string, string, VirtualMachineScaleSetVMsGetOptionalParams)	Gets a virtual machine from a VM scale set.
getInstanceView(string, string, string, VirtualMachineScaleSetVMsGetInstanceViewOptionalParams)	Gets the status of a virtual machine from a VM scale set.
list(string, string, VirtualMachineScaleSetVMsListOptionalParams)	Gets a list of all virtual machines in a VM scale sets.
retrieveBootDiagnosticsData(string, string, string, VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams)	The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
simulateEviction(string, string, string, VirtualMachineScaleSetVMsSimulateEvictionOptionalParams)	The operation to simulate the eviction of spot virtual machine in a VM scale set.

Method Details

beginDeallocate(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)

Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsDeallocateOptionalParams

The options parameters.

Returns

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

beginDeallocateAndWait(string, string, string, VirtualMachineScaleSetVMsDeallocateOptionalParams)

Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.

function beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsDeallocateOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)

Deletes a virtual machine from a VM scale set.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VirtualMachineScaleSetVMsDeleteOptionalParams)

Deletes a virtual machine from a VM scale set.

function beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPerformMaintenance(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)

Performs maintenance on a virtual machine in a VM scale set.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams

The options parameters.

Returns

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

beginPerformMaintenanceAndWait(string, string, string, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams)

Performs maintenance on a virtual machine in a VM scale set.

function beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams

The options parameters.

Returns

Promise<void>

beginPowerOff(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)

Power off (stop) a virtual machine 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, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsPowerOffOptionalParams

The options parameters.

Returns

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

beginPowerOffAndWait(string, string, string, VirtualMachineScaleSetVMsPowerOffOptionalParams)

Power off (stop) a virtual machine 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 beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsPowerOffOptionalParams

The options parameters.

Returns

Promise<void>

beginRedeploy(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsRedeployOptionalParams

The options parameters.

Returns

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

beginRedeployAndWait(string, string, string, VirtualMachineScaleSetVMsRedeployOptionalParams)

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

function beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsRedeployOptionalParams

The options parameters.

Returns

Promise<void>

beginReimage(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsReimageOptionalParams

The options parameters.

Returns

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

beginReimageAll(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)

Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsReimageAllOptionalParams

The options parameters.

Returns

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

beginReimageAllAndWait(string, string, string, VirtualMachineScaleSetVMsReimageAllOptionalParams)

Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.

function beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsReimageAllOptionalParams

The options parameters.

Returns

Promise<void>

beginReimageAndWait(string, string, string, VirtualMachineScaleSetVMsReimageOptionalParams)

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

function beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsReimageOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)

Restarts a virtual machine in a VM scale set.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsRestartOptionalParams

The options parameters.

Returns

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

beginRestartAndWait(string, string, string, VirtualMachineScaleSetVMsRestartOptionalParams)

Restarts a virtual machine in a VM scale set.

function beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)

Starts a virtual machine in a VM scale set.

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

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, string, VirtualMachineScaleSetVMsStartOptionalParams)

Starts a virtual machine in a VM scale set.

function beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)

Updates a virtual machine of a VM scale set.

function beginUpdate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set where the extension should be create or updated.

instanceId

string

The instance ID of the virtual machine.

parameters

VirtualMachineScaleSetVM

Parameters supplied to the Update Virtual Machine Scale Sets VM operation.

options

VirtualMachineScaleSetVMsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<VirtualMachineScaleSetVM>, VirtualMachineScaleSetVM>>

beginUpdateAndWait(string, string, string, VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsUpdateOptionalParams)

Updates a virtual machine of a VM scale set.

function beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<VirtualMachineScaleSetVM>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set where the extension should be create or updated.

instanceId

string

The instance ID of the virtual machine.

parameters

VirtualMachineScaleSetVM

Parameters supplied to the Update Virtual Machine Scale Sets VM operation.

options

VirtualMachineScaleSetVMsUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSetVM>

get(string, string, string, VirtualMachineScaleSetVMsGetOptionalParams)

Gets a virtual machine from a VM scale set.

function get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetOptionalParams): Promise<VirtualMachineScaleSetVM>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSetVM>

getInstanceView(string, string, string, VirtualMachineScaleSetVMsGetInstanceViewOptionalParams)

Gets the status of a virtual machine from a VM scale set.

function getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetVMInstanceView>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsGetInstanceViewOptionalParams

The options parameters.

Returns

Promise<VirtualMachineScaleSetVMInstanceView>

list(string, string, VirtualMachineScaleSetVMsListOptionalParams)

Gets a list of all virtual machines in a VM scale sets.

function list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: VirtualMachineScaleSetVMsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetVM, VirtualMachineScaleSetVM[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the VM scale set.

options

VirtualMachineScaleSetVMsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachineScaleSetVM, VirtualMachineScaleSetVM[], PageSettings>

retrieveBootDiagnosticsData(string, string, string, VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams)

The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.

function retrieveBootDiagnosticsData(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams): Promise<RetrieveBootDiagnosticsDataResult>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams

The options parameters.

Returns

Promise<RetrieveBootDiagnosticsDataResult>

simulateEviction(string, string, string, VirtualMachineScaleSetVMsSimulateEvictionOptionalParams)

The operation to simulate the eviction of spot virtual machine in a VM scale set.

function simulateEviction(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsSimulateEvictionOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

vmScaleSetName

string

The name of the VM scale set.

instanceId

string

The instance ID of the virtual machine.

options

VirtualMachineScaleSetVMsSimulateEvictionOptionalParams

The options parameters.

Returns

Promise<void>