VirtualMachinesImpl | @azure/arm-compute

Class containing VirtualMachines operations.

Hierarchy

VirtualMachinesImpl

Implements

VirtualMachines

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualMachinesImpl(client: ComputeManagementClientContext): VirtualMachinesImpl

- Defined in operations/virtualMachines.ts:74
Initialize a new instance of the class VirtualMachines class.

Parameters
- client: ComputeManagementClientContext
  
  Reference to the service client
Returns VirtualMachinesImpl

Methods

beginAssessPatches

beginAssessPatches(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesAssessPatchesResponse>, VirtualMachinesAssessPatchesResponse>>

Implementation of VirtualMachines.beginAssessPatches
- Defined in operations/virtualMachines.ts:1496
Assess patches on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesAssessPatchesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesAssessPatchesResponse>, VirtualMachinesAssessPatchesResponse>>

beginAssessPatchesAndWait

beginAssessPatchesAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<VirtualMachinesAssessPatchesResponse>

Implementation of VirtualMachines.beginAssessPatchesAndWait
- Defined in operations/virtualMachines.ts:1563
Assess patches on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesAssessPatchesOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesAssessPatchesResponse>

beginCapture

beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesCaptureResponse>, VirtualMachinesCaptureResponse>>

Implementation of VirtualMachines.beginCapture
- Defined in operations/virtualMachines.ts:311
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachineCaptureParameters
  
  Parameters supplied to the Capture Virtual Machine operation.
- Optional options: VirtualMachinesCaptureOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesCaptureResponse>, VirtualMachinesCaptureResponse>>

beginCaptureAndWait

beginCaptureAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<VirtualMachinesCaptureResponse>

Implementation of VirtualMachines.beginCaptureAndWait
- Defined in operations/virtualMachines.ts:381
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachineCaptureParameters
  
  Parameters supplied to the Capture Virtual Machine operation.
- Optional options: VirtualMachinesCaptureOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesCaptureResponse>

beginConvertToManagedDisks

beginConvertToManagedDisks(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginConvertToManagedDisks
- Defined in operations/virtualMachines.ts:695
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesConvertToManagedDisksOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginConvertToManagedDisksAndWait

beginConvertToManagedDisksAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<void>

Implementation of VirtualMachines.beginConvertToManagedDisksAndWait
- Defined in operations/virtualMachines.ts:757
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesConvertToManagedDisksOptionalParams
  
  The options parameters.
Returns Promise<void>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

Implementation of VirtualMachines.beginCreateOrUpdate
- Defined in operations/virtualMachines.ts:404
The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachine
  
  Parameters supplied to the Create Virtual Machine operation.
- Optional options: VirtualMachinesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachinesCreateOrUpdateResponse>

Implementation of VirtualMachines.beginCreateOrUpdateAndWait
- Defined in operations/virtualMachines.ts:473
The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachine
  
  Parameters supplied to the Create Virtual Machine operation.
- Optional options: VirtualMachinesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesCreateOrUpdateResponse>

beginDeallocate

beginDeallocate(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginDeallocate
- Defined in operations/virtualMachines.ts:777
Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesDeallocateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeallocateAndWait

beginDeallocateAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<void>

Implementation of VirtualMachines.beginDeallocateAndWait
- Defined in operations/virtualMachines.ts:839
Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesDeallocateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDelete

beginDelete(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginDelete
- Defined in operations/virtualMachines.ts:584
The operation to delete a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>

Implementation of VirtualMachines.beginDeleteAndWait
- Defined in operations/virtualMachines.ts:645
The operation to delete a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginInstallPatches

beginInstallPatches(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesInstallPatchesResponse>, VirtualMachinesInstallPatchesResponse>>

Implementation of VirtualMachines.beginInstallPatches
- Defined in operations/virtualMachines.ts:1583
Installs patches on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- installPatchesInput: VirtualMachineInstallPatchesParameters
  
  Input for InstallPatches as directly received by the API
- Optional options: VirtualMachinesInstallPatchesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesInstallPatchesResponse>, VirtualMachinesInstallPatchesResponse>>

beginInstallPatchesAndWait

beginInstallPatchesAndWait(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<VirtualMachinesInstallPatchesResponse>

Implementation of VirtualMachines.beginInstallPatchesAndWait
- Defined in operations/virtualMachines.ts:1652
Installs patches on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- installPatchesInput: VirtualMachineInstallPatchesParameters
  
  Input for InstallPatches as directly received by the API
- Optional options: VirtualMachinesInstallPatchesOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesInstallPatchesResponse>

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginPerformMaintenance
- Defined in operations/virtualMachines.ts:1399
The operation to perform maintenance on a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesPerformMaintenanceOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPerformMaintenanceAndWait

beginPerformMaintenanceAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<void>

Implementation of VirtualMachines.beginPerformMaintenanceAndWait
- Defined in operations/virtualMachines.ts:1460
The operation to perform maintenance on a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesPerformMaintenanceOptionalParams
  
  The options parameters.
Returns Promise<void>

beginPowerOff

beginPowerOff(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginPowerOff
- Defined in operations/virtualMachines.ts:925
The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesPowerOffOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPowerOffAndWait

beginPowerOffAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<void>

Implementation of VirtualMachines.beginPowerOffAndWait
- Defined in operations/virtualMachines.ts:987
The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesPowerOffOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReapply

beginReapply(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginReapply
- Defined in operations/virtualMachines.ts:1002
The operation to reapply a virtual machine's state.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesReapplyOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReapplyAndWait

beginReapplyAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<void>

Implementation of VirtualMachines.beginReapplyAndWait
- Defined in operations/virtualMachines.ts:1063
The operation to reapply a virtual machine's state.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesReapplyOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRedeploy

beginRedeploy(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginRedeploy
- Defined in operations/virtualMachines.ts:1230
Shuts down the virtual machine, moves it to a new node, and powers it back on.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesRedeployOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRedeployAndWait

beginRedeployAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>

Implementation of VirtualMachines.beginRedeployAndWait
- Defined in operations/virtualMachines.ts:1291
Shuts down the virtual machine, moves it to a new node, and powers it back on.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesRedeployOptionalParams
  
  The options parameters.
Returns Promise<void>

beginReimage

beginReimage(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginReimage
- Defined in operations/virtualMachines.ts:1306
Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesReimageOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginReimageAndWait

beginReimageAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<void>

Implementation of VirtualMachines.beginReimageAndWait
- Defined in operations/virtualMachines.ts:1367
Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesReimageOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

beginRestart(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginRestart
- Defined in operations/virtualMachines.ts:1078
The operation to restart a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

beginRestartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>

Implementation of VirtualMachines.beginRestartAndWait
- Defined in operations/virtualMachines.ts:1139
The operation to restart a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRunCommand

beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesRunCommandResponse>, VirtualMachinesRunCommandResponse>>

Implementation of VirtualMachines.beginRunCommand
- Defined in operations/virtualMachines.ts:1674
Run command on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: RunCommandInput
  
  Parameters supplied to the Run command operation.
- Optional options: VirtualMachinesRunCommandOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesRunCommandResponse>, VirtualMachinesRunCommandResponse>>

beginRunCommandAndWait

beginRunCommandAndWait(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<VirtualMachinesRunCommandResponse>

Implementation of VirtualMachines.beginRunCommandAndWait
- Defined in operations/virtualMachines.ts:1743
Run command on the VM.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: RunCommandInput
  
  Parameters supplied to the Run command operation.
- Optional options: VirtualMachinesRunCommandOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesRunCommandResponse>

beginStart

beginStart(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of VirtualMachines.beginStart
- Defined in operations/virtualMachines.ts:1154
The operation to start a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

beginStartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>

Implementation of VirtualMachines.beginStartAndWait
- Defined in operations/virtualMachines.ts:1215
The operation to start a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesUpdateResponse>, VirtualMachinesUpdateResponse>>

Implementation of VirtualMachines.beginUpdate
- Defined in operations/virtualMachines.ts:495
The operation to update a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachineUpdate
  
  Parameters supplied to the Update Virtual Machine operation.
- Optional options: VirtualMachinesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<VirtualMachinesUpdateResponse>, VirtualMachinesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachinesUpdateResponse>

Implementation of VirtualMachines.beginUpdateAndWait
- Defined in operations/virtualMachines.ts:563
The operation to update a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- parameters: VirtualMachineUpdate
  
  Parameters supplied to the Update Virtual Machine operation.
- Optional options: VirtualMachinesUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesUpdateResponse>

generalize

generalize(resourceGroupName: string, vmName: string, options?: VirtualMachinesGeneralizeOptionalParams): Promise<void>

Implementation of VirtualMachines.generalize
- Defined in operations/virtualMachines.ts:863
Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation.
For Windows, please refer to Create a managed image of a generalized VM in Azure.
For Linux, please refer to How to create an image of a virtual machine or VHD.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesGeneralizeOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, vmName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachinesGetResponse>

Implementation of VirtualMachines.get
- Defined in operations/virtualMachines.ts:660
Retrieves information about the model view or the instance view of a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesGetOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesGetResponse>

instanceView

instanceView(resourceGroupName: string, vmName: string, options?: VirtualMachinesInstanceViewOptionalParams): Promise<VirtualMachinesInstanceViewResponse>

Implementation of VirtualMachines.instanceView
- Defined in operations/virtualMachines.ts:677
Retrieves information about the run-time state of a virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesInstanceViewOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesInstanceViewResponse>

list

list(resourceGroupName: string, options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<VirtualMachine>

Implementation of VirtualMachines.list
- Defined in operations/virtualMachines.ts:140
Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: VirtualMachinesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>

listAll

listAll(options?: VirtualMachinesListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachine>

Implementation of VirtualMachines.listAll
- Defined in operations/virtualMachines.ts:190
Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

Parameters
- Optional options: VirtualMachinesListAllOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>

listAvailableSizes

listAvailableSizes(resourceGroupName: string, vmName: string, options?: VirtualMachinesListAvailableSizesOptionalParams): PagedAsyncIterableIterator<VirtualMachineSize>

Implementation of VirtualMachines.listAvailableSizes
- Defined in operations/virtualMachines.ts:234
Lists all available virtual machine sizes to which the specified virtual machine can be resized.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesListAvailableSizesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineSize>

listByLocation

listByLocation(location: string, options?: VirtualMachinesListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachine>

Implementation of VirtualMachines.listByLocation
- Defined in operations/virtualMachines.ts:89
Gets all the virtual machines under the specified subscription for the specified location.

Parameters
- location: string
  
  The location for which virtual machines under the subscription are queried.
- Optional options: VirtualMachinesListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>

retrieveBootDiagnosticsData

retrieveBootDiagnosticsData(resourceGroupName: string, vmName: string, options?: VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams): Promise<VirtualMachinesRetrieveBootDiagnosticsDataResponse>

Implementation of VirtualMachines.retrieveBootDiagnosticsData
- Defined in operations/virtualMachines.ts:1382
The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams
  
  The options parameters.
Returns Promise<VirtualMachinesRetrieveBootDiagnosticsDataResponse>

simulateEviction

simulateEviction(resourceGroupName: string, vmName: string, options?: VirtualMachinesSimulateEvictionOptionalParams): Promise<void>

Implementation of VirtualMachines.simulateEviction
- Defined in operations/virtualMachines.ts:1479
The operation to simulate the eviction of spot virtual machine.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- vmName: string
  
  The name of the virtual machine.
- Optional options: VirtualMachinesSimulateEvictionOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ComputeManagementClientContext

Returns VirtualMachinesImpl

Methods

beginAssessPatches

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesAssessPatchesOptionalParams

Returns Promise<PollerLike<PollOperationState<VirtualMachinesAssessPatchesResponse>, VirtualMachinesAssessPatchesResponse>>

beginAssessPatchesAndWait

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesAssessPatchesOptionalParams

Returns Promise<VirtualMachinesAssessPatchesResponse>

beginCapture

Parameters

resourceGroupName: string

vmName: string

parameters: VirtualMachineCaptureParameters

Optional options: VirtualMachinesCaptureOptionalParams

Returns Promise<PollerLike<PollOperationState<VirtualMachinesCaptureResponse>, VirtualMachinesCaptureResponse>>

beginCaptureAndWait

Parameters

resourceGroupName: string

vmName: string

parameters: VirtualMachineCaptureParameters

Optional options: VirtualMachinesCaptureOptionalParams

Returns Promise<VirtualMachinesCaptureResponse>

beginConvertToManagedDisks

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesConvertToManagedDisksOptionalParams

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

beginConvertToManagedDisksAndWait

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesConvertToManagedDisksOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

resourceGroupName: string

vmName: string

parameters: VirtualMachine

Optional options: VirtualMachinesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

vmName: string

parameters: VirtualMachine

Optional options: VirtualMachinesCreateOrUpdateOptionalParams

Returns Promise<VirtualMachinesCreateOrUpdateResponse>

beginDeallocate

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesDeallocateOptionalParams

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

beginDeallocateAndWait

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesDeallocateOptionalParams

Returns Promise<void>

beginDelete

Parameters

resourceGroupName: string

vmName: string

Optional options: VirtualMachinesDeleteOptionalParams