VirtualMachinesOperations interface

Package:
@azure/arm-networkcloud

Interface representing a VirtualMachines operations.

Properties

assignRelay

Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.
beginAssignRelay
beginAssignRelayAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginPowerOff
beginPowerOffAndWait
beginReimage
beginReimageAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

Create a new virtual machine or update the properties of the existing virtual machine.
delete

Delete the provided virtual machine.
get

Get properties of the provided virtual machine.
listByResourceGroup

Get a list of virtual machines in the provided resource group.
listBySubscription

Get a list of virtual machines in the provided subscription.
powerOff

Power off the provided virtual machine.
reimage

Reimage the provided virtual machine.
restart

Restart the provided virtual machine.
start

Start the provided virtual machine.
update

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

Property Details

assignRelay

Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.

assignRelay: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

beginAssignRelay

Warning

This API is now deprecated.

use assignRelay instead

beginAssignRelay: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginAssignRelayAndWait

Warning

This API is now deprecated.

use assignRelay instead

beginAssignRelayAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesAssignRelayOptionalParams) => Promise<OperationStatusResult>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => Promise<VirtualMachine>

Property Value

(resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => Promise<VirtualMachine>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams) => Promise<OperationStatusResult>

beginPowerOff

Warning

This API is now deprecated.

use powerOff instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginPowerOffAndWait

Warning

This API is now deprecated.

use powerOff instead

beginPowerOffAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams) => Promise<OperationStatusResult>

beginReimage

Warning

This API is now deprecated.

use reimage instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginReimageAndWait

Warning

This API is now deprecated.

use reimage instead

beginReimageAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams) => Promise<OperationStatusResult>

beginRestart

Warning

This API is now deprecated.

use restart instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

beginRestartAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams) => Promise<OperationStatusResult>

beginStart

Warning

This API is now deprecated.

use start instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams) => Promise<OperationStatusResult>

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualMachine>, VirtualMachine>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

createOrUpdate

Create a new virtual machine or update the properties of the existing virtual machine.

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

Property Value

(resourceGroupName: string, virtualMachineName: string, virtualMachineParameters: VirtualMachine, options?: VirtualMachinesCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualMachine>, VirtualMachine>

delete

Delete the provided virtual machine.

delete: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

get

Get properties of the provided virtual machine.

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

Property Value

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

listByResourceGroup

Get a list of virtual machines in the provided resource group.

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

Property Value

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

listBySubscription

Get a list of virtual machines in the provided subscription.

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

Property Value

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

powerOff

Power off the provided virtual machine.

powerOff: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesPowerOffOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

reimage

Reimage the provided virtual machine.

reimage: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesReimageOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

restart

Restart the provided virtual machine.

restart: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesRestartOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

start

Start the provided virtual machine.

start: (resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesStartOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

update

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

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

Property Value

(resourceGroupName: string, virtualMachineName: string, options?: VirtualMachinesUpdateOptionalParams) => PollerLike<OperationState<VirtualMachine>, VirtualMachine>