VirtualMachines interface

Package:

@azure/arm-avs

Interface representing a VirtualMachines.

Methods

beginRestrictMovement(string, string, string, string, VirtualMachineRestrictMovement, VirtualMachinesRestrictMovementOptionalParams)	Enable or disable DRS-driven VM movement restriction
beginRestrictMovementAndWait(string, string, string, string, VirtualMachineRestrictMovement, VirtualMachinesRestrictMovementOptionalParams)	Enable or disable DRS-driven VM movement restriction
get(string, string, string, string, VirtualMachinesGetOptionalParams)	Get a VirtualMachine
list(string, string, string, VirtualMachinesListOptionalParams)	List VirtualMachine resources by Cluster

Method Details

beginRestrictMovement(string, string, string, string, VirtualMachineRestrictMovement, VirtualMachinesRestrictMovementOptionalParams)

Enable or disable DRS-driven VM movement restriction

function beginRestrictMovement(resourceGroupName: string, privateCloudName: string, clusterName: string, virtualMachineId: string, restrictMovement: VirtualMachineRestrictMovement, options?: VirtualMachinesRestrictMovementOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachinesRestrictMovementHeaders>, VirtualMachinesRestrictMovementHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

privateCloudName

string

Name of the private cloud

clusterName

string

Name of the cluster

virtualMachineId

string

ID of the virtual machine.

restrictMovement

VirtualMachineRestrictMovement

The body type of the operation request.

options

VirtualMachinesRestrictMovementOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachinesRestrictMovementHeaders>, VirtualMachinesRestrictMovementHeaders>>

beginRestrictMovementAndWait(string, string, string, string, VirtualMachineRestrictMovement, VirtualMachinesRestrictMovementOptionalParams)

Enable or disable DRS-driven VM movement restriction

function beginRestrictMovementAndWait(resourceGroupName: string, privateCloudName: string, clusterName: string, virtualMachineId: string, restrictMovement: VirtualMachineRestrictMovement, options?: VirtualMachinesRestrictMovementOptionalParams): Promise<VirtualMachinesRestrictMovementHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

privateCloudName

string

Name of the private cloud

clusterName

string

Name of the cluster

virtualMachineId

string

ID of the virtual machine.

restrictMovement

VirtualMachineRestrictMovement

The body type of the operation request.

options

VirtualMachinesRestrictMovementOptionalParams

The options parameters.

Returns

Promise<VirtualMachinesRestrictMovementHeaders>

get(string, string, string, string, VirtualMachinesGetOptionalParams)

Get a VirtualMachine

function get(resourceGroupName: string, privateCloudName: string, clusterName: string, virtualMachineId: string, options?: VirtualMachinesGetOptionalParams): Promise<VirtualMachine>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

privateCloudName

string

Name of the private cloud

clusterName

string

Name of the cluster

virtualMachineId

string

ID of the virtual machine.

options

VirtualMachinesGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachine>

list(string, string, string, VirtualMachinesListOptionalParams)

List VirtualMachine resources by Cluster

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

privateCloudName

string

Name of the private cloud

clusterName

string

Name of the cluster

options

VirtualMachinesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualMachine, VirtualMachine[], PageSettings>