Package version:

Interface VirtualMachines

Interface representing a VirtualMachines.

interface VirtualMachines {
    beginAssessPatches(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>;
    beginAssessPatchesAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<VirtualMachineAssessPatchesResult>;
    beginAttachDetachDataDisks(resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>;
    beginAttachDetachDataDisksAndWait(resourceGroupName: string, vmName: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachinesAttachDetachDataDisksOptionalParams): Promise<StorageProfile>;
    beginCapture(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>;
    beginCaptureAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineCaptureParameters, options?: VirtualMachinesCaptureOptionalParams): Promise<VirtualMachineCaptureResult>;
    beginConvertToManagedDisks(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginConvertToManagedDisksAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesConvertToManagedDisksOptionalParams): Promise<void>;
    beginCreateOrUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachine>;
    beginDeallocate(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeallocateAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeallocateOptionalParams): Promise<void>;
    beginDelete(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesDeleteOptionalParams): Promise<void>;
    beginInstallPatches(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>;
    beginInstallPatchesAndWait(resourceGroupName: string, vmName: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<VirtualMachineInstallPatchesResult>;
    beginMigrateToVMScaleSet(resourceGroupName: string, vmName: string, options?: VirtualMachinesMigrateToVMScaleSetOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginMigrateToVMScaleSetAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesMigrateToVMScaleSetOptionalParams): Promise<void>;
    beginPerformMaintenance(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPerformMaintenanceAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPerformMaintenanceOptionalParams): Promise<void>;
    beginPowerOff(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPowerOffAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesPowerOffOptionalParams): Promise<void>;
    beginReapply(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReapplyAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReapplyOptionalParams): Promise<void>;
    beginRedeploy(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRedeployAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRedeployOptionalParams): Promise<void>;
    beginReimage(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReimageAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesReimageOptionalParams): Promise<void>;
    beginRestart(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRestartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesRestartOptionalParams): Promise<void>;
    beginRunCommand(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>;
    beginRunCommandAndWait(resourceGroupName: string, vmName: string, parameters: RunCommandInput, options?: VirtualMachinesRunCommandOptionalParams): Promise<RunCommandResult>;
    beginStart(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartAndWait(resourceGroupName: string, vmName: string, options?: VirtualMachinesStartOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>;
    beginUpdateAndWait(resourceGroupName: string, vmName: string, parameters: VirtualMachineUpdate, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachine>;
    generalize(resourceGroupName: string, vmName: string, options?: VirtualMachinesGeneralizeOptionalParams): Promise<void>;
    get(resourceGroupName: string, vmName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>;
    instanceView(resourceGroupName: string, vmName: string, options?: VirtualMachinesInstanceViewOptionalParams): Promise<VirtualMachineInstanceView>;
    list(resourceGroupName: string, options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<VirtualMachine>;
    listAll(options?: VirtualMachinesListAllOptionalParams): PagedAsyncIterableIterator<VirtualMachine>;
    listAvailableSizes(resourceGroupName: string, vmName: string, options?: VirtualMachinesListAvailableSizesOptionalParams): PagedAsyncIterableIterator<VirtualMachineSize>;
    listByLocation(location: string, options?: VirtualMachinesListByLocationOptionalParams): PagedAsyncIterableIterator<VirtualMachine>;
    retrieveBootDiagnosticsData(resourceGroupName: string, vmName: string, options?: VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams): Promise<RetrieveBootDiagnosticsDataResult>;
    simulateEviction(resourceGroupName: string, vmName: string, options?: VirtualMachinesSimulateEvictionOptionalParams): Promise<void>;
}

Index

Methods

beginAssessPatches beginAssessPatchesAndWait beginAttachDetachDataDisks beginAttachDetachDataDisksAndWait beginCapture beginCaptureAndWait beginConvertToManagedDisks beginConvertToManagedDisksAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait beginDeallocate beginDeallocateAndWait beginDelete beginDeleteAndWait beginInstallPatches beginInstallPatchesAndWait beginMigrateToVMScaleSet beginMigrateToVMScaleSetAndWait beginPerformMaintenance beginPerformMaintenanceAndWait beginPowerOff beginPowerOffAndWait beginReapply beginReapplyAndWait beginRedeploy beginRedeployAndWait beginReimage beginReimageAndWait beginRestart beginRestartAndWait beginRunCommand beginRunCommandAndWait beginStart beginStartAndWait beginUpdate beginUpdateAndWait generalize get instanceView list listAll listAvailableSizes listByLocation retrieveBootDiagnosticsData simulateEviction

Methods

beginAssessPatches

beginAssessPatches(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>
Assess patches on the VM.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesAssessPatchesOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>
- Defined in operationsInterfaces/virtualMachines.ts:500

beginAssessPatchesAndWait

beginAssessPatchesAndWait(resourceGroupName, vmName, options?): Promise<VirtualMachineAssessPatchesResult>
Assess patches on the VM.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesAssessPatchesOptionalParams
  The options parameters.
Returns Promise<VirtualMachineAssessPatchesResult>
- Defined in operationsInterfaces/virtualMachines.ts:516

beginAttachDetachDataDisks

beginAttachDetachDataDisks(resourceGroupName, vmName, parameters, options?): Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
Attach and detach data disks to/from the virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- parameters: AttachDetachDataDisksRequest
  Parameters supplied to the attach and detach data disks operation on the virtual machine.
- Optionaloptions: VirtualMachinesAttachDetachDataDisksOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>
- Defined in operationsInterfaces/virtualMachines.ts:560

beginAttachDetachDataDisksAndWait

beginAttachDetachDataDisksAndWait(resourceGroupName, vmName, parameters, options?): Promise<StorageProfile>
Attach and detach data disks to/from the virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- parameters: AttachDetachDataDisksRequest
  Parameters supplied to the attach and detach data disks operation on the virtual machine.
- Optionaloptions: VirtualMachinesAttachDetachDataDisksOptionalParams
  The options parameters.
Returns Promise<StorageProfile>
- Defined in operationsInterfaces/virtualMachines.ts:579

beginCapture

beginCapture(resourceGroupName, vmName, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>
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.
- Optionaloptions: VirtualMachinesCaptureOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>
- Defined in operationsInterfaces/virtualMachines.ts:107

beginCaptureAndWait

beginCaptureAndWait(resourceGroupName, vmName, parameters, options?): Promise<VirtualMachineCaptureResult>
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.
- Optionaloptions: VirtualMachinesCaptureOptionalParams
  The options parameters.
Returns Promise<VirtualMachineCaptureResult>
- Defined in operationsInterfaces/virtualMachines.ts:126

beginConvertToManagedDisks

beginConvertToManagedDisks(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachinesConvertToManagedDisksOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:247

beginConvertToManagedDisksAndWait

beginConvertToManagedDisksAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesConvertToManagedDisksOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:259

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, vmName, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
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.
- Optionaloptions: VirtualMachinesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
- Defined in operationsInterfaces/virtualMachines.ts:140

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, vmName, parameters, options?): Promise<VirtualMachine>
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.
- Optionaloptions: VirtualMachinesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:159

beginDeallocate

beginDeallocate(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachinesDeallocateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:271

beginDeallocateAndWait

beginDeallocateAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesDeallocateOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:283

beginDelete

beginDelete(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
The operation to delete a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:202

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, vmName, options?): Promise<void>
The operation to delete a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:213

beginInstallPatches

beginInstallPatches(resourceGroupName, vmName, installPatchesInput, options?): Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>
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
- Optionaloptions: VirtualMachinesInstallPatchesOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>
- Defined in operationsInterfaces/virtualMachines.ts:528

beginInstallPatchesAndWait

beginInstallPatchesAndWait(resourceGroupName, vmName, installPatchesInput, options?): Promise<VirtualMachineInstallPatchesResult>
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
- Optionaloptions: VirtualMachinesInstallPatchesOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstallPatchesResult>
- Defined in operationsInterfaces/virtualMachines.ts:546

beginMigrateToVMScaleSet

beginMigrateToVMScaleSet(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Migrate a virtual machine from availability set to Flexible Virtual Machine Scale Set.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesMigrateToVMScaleSetOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:591

beginMigrateToVMScaleSetAndWait

beginMigrateToVMScaleSetAndWait(resourceGroupName, vmName, options?): Promise<void>
Migrate a virtual machine from availability set to Flexible Virtual Machine Scale Set.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesMigrateToVMScaleSetOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:602

beginPerformMaintenance

beginPerformMaintenance(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachinesPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:467

beginPerformMaintenanceAndWait

beginPerformMaintenanceAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesPerformMaintenanceOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:478

beginPowerOff

beginPowerOff(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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. NOTE: This operation is not allowed on a virtual machine that is being deallocated or has already been deallocated.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesPowerOffOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:312

beginPowerOffAndWait

beginPowerOffAndWait(resourceGroupName, vmName, options?): Promise<void>
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. NOTE: This operation is not allowed on a virtual machine that is being deallocated or has already been deallocated.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesPowerOffOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:325

beginReapply

beginReapply(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachinesReapplyOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:336

beginReapplyAndWait

beginReapplyAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesReapplyOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:347

beginRedeploy

beginRedeploy(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
- Optionaloptions: VirtualMachinesRedeployOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:402

beginRedeployAndWait

beginRedeployAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesRedeployOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:413

beginReimage

beginReimage(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesReimageOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:429

beginReimageAndWait

beginReimageAndWait(resourceGroupName, vmName, options?): Promise<void>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesReimageOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:445

beginRestart

beginRestart(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
The operation to restart a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesRestartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:358

beginRestartAndWait

beginRestartAndWait(resourceGroupName, vmName, options?): Promise<void>
The operation to restart a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesRestartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:369

beginRunCommand

beginRunCommand(resourceGroupName, vmName, parameters, options?): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
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.
- Optionaloptions: VirtualMachinesRunCommandOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
- Defined in operationsInterfaces/virtualMachines.ts:614

beginRunCommandAndWait

beginRunCommandAndWait(resourceGroupName, vmName, parameters, options?): Promise<RunCommandResult>
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.
- Optionaloptions: VirtualMachinesRunCommandOptionalParams
  The options parameters.
Returns Promise<RunCommandResult>
- Defined in operationsInterfaces/virtualMachines.ts:632

beginStart

beginStart(resourceGroupName, vmName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
The operation to start a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualMachines.ts:380

beginStartAndWait

beginStartAndWait(resourceGroupName, vmName, options?): Promise<void>
The operation to start a virtual machine.
Parameters
- resourceGroupName: string
  The name of the resource group.
- vmName: string
  The name of the virtual machine.
- Optionaloptions: VirtualMachinesStartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:391

beginUpdate

beginUpdate(resourceGroupName, vmName, parameters, options?): Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
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.
- Optionaloptions: VirtualMachinesUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>
- Defined in operationsInterfaces/virtualMachines.ts:172

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, vmName, parameters, options?): Promise<VirtualMachine>
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.
- Optionaloptions: VirtualMachinesUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:190

generalize

generalize(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesGeneralizeOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:299

get

get(resourceGroupName, vmName, options?): Promise<VirtualMachine>
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.
- Optionaloptions: VirtualMachinesGetOptionalParams
  The options parameters.
Returns Promise<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:224

instanceView

instanceView(resourceGroupName, vmName, options?): Promise<VirtualMachineInstanceView>
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.
- Optionaloptions: VirtualMachinesInstanceViewOptionalParams
  The options parameters.
Returns Promise<VirtualMachineInstanceView>
- Defined in operationsInterfaces/virtualMachines.ts:235

list

list(resourceGroupName, options?): PagedAsyncIterableIterator<VirtualMachine>
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.
- Optionaloptions: VirtualMachinesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:76

listAll

listAll(options?): PagedAsyncIterableIterator<VirtualMachine>
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
- Optionaloptions: VirtualMachinesListAllOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:85

listAvailableSizes

listAvailableSizes(resourceGroupName, vmName, options?): PagedAsyncIterableIterator<VirtualMachineSize>
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.
- Optionaloptions: VirtualMachinesListAvailableSizesOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineSize>
- Defined in operationsInterfaces/virtualMachines.ts:94

listByLocation

listByLocation(location, options?): PagedAsyncIterableIterator<VirtualMachine>
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.
- Optionaloptions: VirtualMachinesListByLocationOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachine>
- Defined in operationsInterfaces/virtualMachines.ts:66

retrieveBootDiagnosticsData

retrieveBootDiagnosticsData(resourceGroupName, vmName, options?): Promise<RetrieveBootDiagnosticsDataResult>
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.
- Optionaloptions: VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams
  The options parameters.
Returns Promise<RetrieveBootDiagnosticsDataResult>
- Defined in operationsInterfaces/virtualMachines.ts:456

simulateEviction

simulateEviction(resourceGroupName, vmName, options?): Promise<void>
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.
- Optionaloptions: VirtualMachinesSimulateEvictionOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualMachines.ts:489

Interface VirtualMachines

Index

Methods

Methods

beginAssessPatches

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>

beginAssessPatchesAndWait

Parameters

Returns Promise<VirtualMachineAssessPatchesResult>

beginAttachDetachDataDisks

Parameters

Returns Promise<SimplePollerLike<OperationState<StorageProfile>, StorageProfile>>

beginAttachDetachDataDisksAndWait

Parameters

Returns Promise<StorageProfile>

beginCapture

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineCaptureResult>, VirtualMachineCaptureResult>>

beginCaptureAndWait

Parameters

Returns Promise<VirtualMachineCaptureResult>

beginConvertToManagedDisks

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginConvertToManagedDisksAndWait

Parameters

Returns Promise<void>

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<VirtualMachine>

beginDeallocate

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeallocateAndWait

Parameters

Returns Promise<void>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginInstallPatches

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>

beginInstallPatchesAndWait

Parameters

Returns Promise<VirtualMachineInstallPatchesResult>

beginMigrateToVMScaleSet

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginMigrateToVMScaleSetAndWait

Parameters

Returns Promise<void>

beginPerformMaintenance

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginPerformMaintenanceAndWait

Parameters

Returns Promise<void>

beginPowerOff

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginPowerOffAndWait

Parameters

Returns Promise<void>

beginReapply

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginReapplyAndWait

Parameters

Returns Promise<void>

beginRedeploy

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRedeployAndWait