VirtualMachineScaleSetVMs | @azure/arm-compute

Interface representing a VirtualMachineScaleSetVMs.

Hierarchy

VirtualMachineScaleSetVMs

Implemented by

VirtualMachineScaleSetVMsImpl

Methods

beginDeallocate

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:115
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.

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

beginDeallocateAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:130
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.

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

beginDelete

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:178
Deletes a virtual machine from a VM scale set.

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

beginDeleteAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:191
Deletes a virtual machine from a VM scale set.

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

beginPerformMaintenance

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:353
Performs maintenance on a virtual machine in a VM scale set.

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

beginPerformMaintenanceAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:366
Performs maintenance on a virtual machine in a VM scale set.

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

beginPowerOff

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:232
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.

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

beginPowerOffAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:247
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.

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

beginRedeploy

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:313
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.

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

beginRedeployAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:327
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.

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

beginReimage

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:59
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

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

beginReimageAll

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:86
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.

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

beginReimageAllAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:100
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.

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

beginReimageAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:72
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

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

beginRestart

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:260
Restarts a virtual machine in a VM scale set.

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

beginRestartAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:273
Restarts a virtual machine in a VM scale set.

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

beginRunCommand

beginRunCommand(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineScaleSetVMsRunCommandResponse>, VirtualMachineScaleSetVMsRunCommandResponse>>

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:393
Run command on a virtual machine in a VM scale set.

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.
- parameters: RunCommandInput
  
  Parameters supplied to the Run command operation.
- Optional options: VirtualMachineScaleSetVMsRunCommandOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachineScaleSetVMsRunCommandResponse>, VirtualMachineScaleSetVMsRunCommandResponse>>

beginRunCommandAndWait

beginRunCommandAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<VirtualMachineScaleSetVMsRunCommandResponse>

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:413
Run command on a virtual machine in a VM scale set.

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.
- parameters: RunCommandInput
  
  Parameters supplied to the Run command operation.
- Optional options: VirtualMachineScaleSetVMsRunCommandOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachineScaleSetVMsRunCommandResponse>

beginStart

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:286
Starts a virtual machine in a VM scale set.

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

beginStartAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:299
Starts a virtual machine in a VM scale set.

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

beginUpdate

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:144
Updates a virtual machine of a VM scale set.

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

beginUpdateAndWait

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:164
Updates a virtual machine of a VM scale set.

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

get

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:204
Gets a virtual machine from a VM scale set.

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

getInstanceView

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:217
Gets the status of a virtual machine from a VM scale set.

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

list

list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: VirtualMachineScaleSetVMsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetVM>

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:47
Gets a list of all virtual machines in a VM scale sets.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualMachineScaleSetName: string
  
  The name of the VM scale set.
- Optional options: VirtualMachineScaleSetVMsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineScaleSetVM>

retrieveBootDiagnosticsData

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:340
The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.

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

simulateEviction

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

- Defined in operationsInterfaces/virtualMachineScaleSetVMs.ts:379
The operation to simulate the eviction of spot virtual machine in a VM scale set.

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

Hierarchy

Implemented by

Index

Methods

Methods

beginDeallocate

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsDeallocateOptionalParams

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

beginDeallocateAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsDeallocateOptionalParams

Returns Promise<void>

beginDelete

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsDeleteOptionalParams

Returns Promise<void>

beginPerformMaintenance

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams

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

beginPerformMaintenanceAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams

Returns Promise<void>

beginPowerOff

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsPowerOffOptionalParams

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

beginPowerOffAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsPowerOffOptionalParams

Returns Promise<void>

beginRedeploy

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsRedeployOptionalParams

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

beginRedeployAndWait

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string

Optional options: VirtualMachineScaleSetVMsRedeployOptionalParams

Returns Promise<void>

beginReimage

Parameters

resourceGroupName: string

vmScaleSetName: string

instanceId: string