VirtualMachinesOperations interface

Assess patches on the VM.

assessPatches: (resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams) => PollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>

Property Value

Attach and detach data disks to/from the virtual machine.

attachDetachDataDisks: (resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams) => PollerLike<OperationState<StorageProfile>, StorageProfile>

Property Value

beginAssessPatches: (resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>

Property Value

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

Property Value

beginAttachDetachDataDisks: (resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams) => Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>

Property Value

beginAttachDetachDataDisksAndWait: (resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams) => Promise<StorageProfile>

Property Value

beginCapture: (resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>

Property Value

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

Property Value

beginConvertToManagedDisks: (resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginCreateOrUpdate: (resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>

Property Value

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

Property Value

beginDeallocate: (resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginDelete: (resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginInstallPatches: (resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>

Property Value

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

Property Value

beginMigrateToVMScaleSet: (resourceGroupName: string, vmName: string, options?: VirtualMachinesMigrateToVMScaleSetOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginMigrateToVMScaleSetAndWait: (resourceGroupName: string, vmName: string, options?: VirtualMachinesMigrateToVMScaleSetOptionalParams) => Promise<void>

Property Value

beginPerformMaintenance: (resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginPowerOff: (resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginReapply: (resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginRedeploy: (resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginReimage: (resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginRestart: (resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginRunCommand: (resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams) => Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>

Property Value

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

Property Value

beginStart: (resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

Property Value

beginUpdate: (resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>

Property Value

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

Property Value

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

capture: (resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams) => PollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>

Property Value

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

convertToManagedDisks: (resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.

createOrUpdate: (resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualMachine>, VirtualMachine>

Property Value

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

deallocate: (resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

delete: (resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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.

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

Property Value

Retrieves information about the model view or the instance view of a virtual machine.

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

Property Value

Installs patches on the VM.

installPatches: (resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams) => PollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>

Property Value

Retrieves information about the run-time state of a virtual machine.

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

Property Value

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.

list: (resourceGroupName: string, options?: VirtualMachinesListOptionalParams) => PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Property Value

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.

listAll: (options?: VirtualMachinesListAllOptionalParams) => PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Property Value

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

listAvailableSizes: (resourceGroupName: string, vmName: string, options?: VirtualMachinesListAvailableSizesOptionalParams) => PagedAsyncIterableIterator<VirtualMachineSize, VirtualMachineSize[], PageSettings>

Property Value

Gets all the virtual machines under the specified subscription for the specified location.

listByLocation: (location: string, options?: VirtualMachinesListByLocationOptionalParams) => PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Property Value

Migrate a virtual machine from availability set to Flexible Virtual Machine Scale Set.

migrateToVMScaleSet: (resourceGroupName: string, vmName: string, options?: VirtualMachinesMigrateToVMScaleSetOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to perform maintenance on a virtual machine.

performMaintenance: (resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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.

powerOff: (resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to reapply a virtual machine's state.

reapply: (resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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

redeploy: (resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.

reimage: (resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to restart a virtual machine.

restart: (resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.

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

Property Value

Run command on the VM.

runCommand: (resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams) => PollerLike<OperationState<RunCommandResult>, RunCommandResult>

Property Value

The operation to simulate the eviction of spot virtual machine.

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

Property Value

The operation to start a virtual machine.

start: (resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

The operation to update a virtual machine.

update: (resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams) => PollerLike<OperationState<VirtualMachine>, VirtualMachine>

Property Value