VirtualMachines interface

Package:

@azure/arm-vmwarecloudsimple

Interface representing a VirtualMachines.

Methods

beginCreateOrUpdate(string, string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)	Create Or Update Virtual Machine
beginCreateOrUpdateAndWait(string, string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)	Create Or Update Virtual Machine
beginDelete(string, string, string, VirtualMachinesDeleteOptionalParams)	Delete virtual machine
beginDeleteAndWait(string, string, string, VirtualMachinesDeleteOptionalParams)	Delete virtual machine
beginStart(string, string, string, VirtualMachinesStartOptionalParams)	Power on virtual machine
beginStartAndWait(string, string, string, VirtualMachinesStartOptionalParams)	Power on virtual machine
beginStop(string, string, string, VirtualMachinesStopOptionalParams)	Power off virtual machine, options: shutdown, poweroff, and suspend
beginStopAndWait(string, string, string, VirtualMachinesStopOptionalParams)	Power off virtual machine, options: shutdown, poweroff, and suspend
beginUpdate(string, string, PatchPayload, VirtualMachinesUpdateOptionalParams)	Patch virtual machine properties
beginUpdateAndWait(string, string, PatchPayload, VirtualMachinesUpdateOptionalParams)	Patch virtual machine properties
get(string, string, VirtualMachinesGetOptionalParams)	Get virtual machine
listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)	Returns list of virtual machine within resource group
listBySubscription(VirtualMachinesListBySubscriptionOptionalParams)	Returns list virtual machine within subscription

Method Details

beginCreateOrUpdate(string, string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)

Create Or Update Virtual Machine

function beginCreateOrUpdate(resourceGroupName: string, referer: string, virtualMachineName: string, virtualMachineRequest: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachinesCreateOrUpdateResponse>, VirtualMachinesCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

virtualMachineRequest

VirtualMachine

Create or Update Virtual Machine request

options

VirtualMachinesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, VirtualMachine, VirtualMachinesCreateOrUpdateOptionalParams)

Create Or Update Virtual Machine

function beginCreateOrUpdateAndWait(resourceGroupName: string, referer: string, virtualMachineName: string, virtualMachineRequest: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams): Promise<VirtualMachinesCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

virtualMachineRequest

VirtualMachine

Create or Update Virtual Machine request

options

VirtualMachinesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachinesCreateOrUpdateResponse>

beginDelete(string, string, string, VirtualMachinesDeleteOptionalParams)

Delete virtual machine

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<VirtualMachinesDeleteHeaders>, VirtualMachinesDeleteHeaders>>

beginDeleteAndWait(string, string, string, VirtualMachinesDeleteOptionalParams)

Delete virtual machine

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesDeleteOptionalParams

The options parameters.

Returns

Promise<VirtualMachinesDeleteHeaders>

beginStart(string, string, string, VirtualMachinesStartOptionalParams)

Power on virtual machine

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, string, VirtualMachinesStartOptionalParams)

Power on virtual machine

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, string, VirtualMachinesStopOptionalParams)

Power off virtual machine, options: shutdown, poweroff, and suspend

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesStopOptionalParams

The options parameters.

Returns

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

beginStopAndWait(string, string, string, VirtualMachinesStopOptionalParams)

Power off virtual machine, options: shutdown, poweroff, and suspend

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

Parameters

resourceGroupName

string

The name of the resource group

referer

string

referer url

virtualMachineName

string

virtual machine name

options

VirtualMachinesStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, PatchPayload, VirtualMachinesUpdateOptionalParams)

Patch virtual machine properties

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

Parameters

resourceGroupName

string

The name of the resource group

virtualMachineName

string

virtual machine name

virtualMachineRequest

PatchPayload

Patch virtual machine request

options

VirtualMachinesUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<VirtualMachine>, VirtualMachine>>

beginUpdateAndWait(string, string, PatchPayload, VirtualMachinesUpdateOptionalParams)

Patch virtual machine properties

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

Parameters

resourceGroupName

string

The name of the resource group

virtualMachineName

string

virtual machine name

virtualMachineRequest

PatchPayload

Patch virtual machine request

options

VirtualMachinesUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

get(string, string, VirtualMachinesGetOptionalParams)

Get virtual machine

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

Parameters

resourceGroupName

string

The name of the resource group

virtualMachineName

string

virtual machine name

options

VirtualMachinesGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

listByResourceGroup(string, VirtualMachinesListByResourceGroupOptionalParams)

Returns list of virtual machine within resource group

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

Parameters

resourceGroupName

string

The name of the resource group

options

VirtualMachinesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

listBySubscription(VirtualMachinesListBySubscriptionOptionalParams)

Returns list virtual machine within subscription

function listBySubscription(options?: VirtualMachinesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>

Parameters

options

VirtualMachinesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>