Share via


VirtualMachines interface

Interface representing a VirtualMachines.

Methods

beginAssessPatches(string, string, VirtualMachinesAssessPatchesOptionalParams)

The operation to assess patches on a vSphere VMware machine identity in Azure.

beginAssessPatchesAndWait(string, string, VirtualMachinesAssessPatchesOptionalParams)

The operation to assess patches on a vSphere VMware machine identity in Azure.

beginCreate(string, string, VirtualMachinesCreateOptionalParams)

Create Or Update virtual machine.

beginCreateAndWait(string, string, VirtualMachinesCreateOptionalParams)

Create Or Update virtual machine.

beginDelete(string, string, VirtualMachinesDeleteOptionalParams)

Implements virtual machine DELETE method.

beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)

Implements virtual machine DELETE method.

beginInstallPatches(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)

The operation to install patches on a vSphere VMware machine identity in Azure.

beginInstallPatchesAndWait(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)

The operation to install patches on a vSphere VMware machine identity in Azure.

beginRestart(string, string, VirtualMachinesRestartOptionalParams)

Restart virtual machine.

beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)

Restart virtual machine.

beginStart(string, string, VirtualMachinesStartOptionalParams)

Start virtual machine.

beginStartAndWait(string, string, VirtualMachinesStartOptionalParams)

Start virtual machine.

beginStop(string, string, VirtualMachinesStopOptionalParams)

Stop virtual machine.

beginStopAndWait(string, string, VirtualMachinesStopOptionalParams)

Stop virtual machine.

beginUpdate(string, string, VirtualMachinesUpdateOptionalParams)

API to update certain properties of the virtual machine resource.

beginUpdateAndWait(string, string, VirtualMachinesUpdateOptionalParams)

API to update certain properties of the virtual machine resource.

get(string, string, VirtualMachinesGetOptionalParams)

Implements virtual machine GET method.

list(VirtualMachinesListOptionalParams)

List of virtualMachines in a subscription.

listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)

List of virtualMachines in a resource group.

Method Details

beginAssessPatches(string, string, VirtualMachinesAssessPatchesOptionalParams)

The operation to assess patches on a vSphere VMware machine identity in Azure.

function beginAssessPatches(resourceGroupName: string, name: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the vSphere VMware machine.

options
VirtualMachinesAssessPatchesOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachineAssessPatchesResult>, VirtualMachineAssessPatchesResult>>

beginAssessPatchesAndWait(string, string, VirtualMachinesAssessPatchesOptionalParams)

The operation to assess patches on a vSphere VMware machine identity in Azure.

function beginAssessPatchesAndWait(resourceGroupName: string, name: string, options?: VirtualMachinesAssessPatchesOptionalParams): Promise<VirtualMachineAssessPatchesResult>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the vSphere VMware machine.

options
VirtualMachinesAssessPatchesOptionalParams

The options parameters.

Returns

beginCreate(string, string, VirtualMachinesCreateOptionalParams)

Create Or Update virtual machine.

function beginCreate(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachine>, VirtualMachine>>

beginCreateAndWait(string, string, VirtualMachinesCreateOptionalParams)

Create Or Update virtual machine.

function beginCreateAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesCreateOptionalParams): Promise<VirtualMachine>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesCreateOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

beginDelete(string, string, VirtualMachinesDeleteOptionalParams)

Implements virtual machine DELETE method.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualMachinesDeleteOptionalParams)

Implements virtual machine DELETE method.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginInstallPatches(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)

The operation to install patches on a vSphere VMware machine identity in Azure.

function beginInstallPatches(resourceGroupName: string, name: string, installPatchesInput: VirtualMachineInstallPatchesParameters, options?: VirtualMachinesInstallPatchesOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineInstallPatchesResult>, VirtualMachineInstallPatchesResult>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the vSphere VMware machine.

installPatchesInput
VirtualMachineInstallPatchesParameters

Input for InstallPatches as directly received by the API

options
VirtualMachinesInstallPatchesOptionalParams

The options parameters.

Returns

beginInstallPatchesAndWait(string, string, VirtualMachineInstallPatchesParameters, VirtualMachinesInstallPatchesOptionalParams)

The operation to install patches on a vSphere VMware machine identity in Azure.

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

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the vSphere VMware machine.

installPatchesInput
VirtualMachineInstallPatchesParameters

Input for InstallPatches as directly received by the API

options
VirtualMachinesInstallPatchesOptionalParams

The options parameters.

Returns

beginRestart(string, string, VirtualMachinesRestartOptionalParams)

Restart virtual machine.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesRestartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginRestartAndWait(string, string, VirtualMachinesRestartOptionalParams)

Restart virtual machine.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, VirtualMachinesStartOptionalParams)

Start virtual machine.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesStartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStartAndWait(string, string, VirtualMachinesStartOptionalParams)

Start virtual machine.

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

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, VirtualMachinesStopOptionalParams)

Stop virtual machine.

function beginStop(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesStopOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStopAndWait(string, string, VirtualMachinesStopOptionalParams)

Stop virtual machine.

function beginStopAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, VirtualMachinesUpdateOptionalParams)

API to update certain properties of the virtual machine resource.

function beginUpdate(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualMachine>, VirtualMachine>>

beginUpdateAndWait(string, string, VirtualMachinesUpdateOptionalParams)

API to update certain properties of the virtual machine resource.

function beginUpdateAndWait(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams): Promise<VirtualMachine>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

get(string, string, VirtualMachinesGetOptionalParams)

Implements virtual machine GET method.

function get(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>

Parameters

resourceGroupName

string

The Resource Group Name.

virtualMachineName

string

Name of the virtual machine resource.

options
VirtualMachinesGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

list(VirtualMachinesListOptionalParams)

List of virtualMachines in a subscription.

function list(options?: VirtualMachinesListOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Parameters

options
VirtualMachinesListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)

List of virtualMachines in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: VirtualMachinesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name.

options
VirtualMachinesListByResourceGroupOptionalParams

The options parameters.

Returns