VirtualMachines Interface

public interface VirtualMachines

Resource collection API of VirtualMachines.

Method Summary

Modifier and Type Method and Description
abstract void createCheckpoint(String resourceGroupName, String virtualMachineName)

Creates a checkpoint in virtual machine.

abstract void createCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineCreateCheckpoint body)

Creates a checkpoint in virtual machine.

abstract void createCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineCreateCheckpoint body, Context context)

Creates a checkpoint in virtual machine.

abstract Blank define(String name)

Begins definition for a new VirtualMachine resource.

abstract void delete(String resourceGroupName, String virtualMachineName)

Deletes a VirtualMachine deployed on ScVmm fabric.

abstract void delete(String resourceGroupName, String virtualMachineName, Boolean retain, Boolean force)

Deletes a VirtualMachine deployed on ScVmm fabric.

abstract void delete(String resourceGroupName, String virtualMachineName, Boolean retain, Boolean force, Context context)

Deletes a VirtualMachine deployed on ScVmm fabric.

abstract void deleteById(String id)

Deletes a VirtualMachine deployed on ScVmm fabric.

abstract void deleteByIdWithResponse(String id, Boolean retain, Boolean force, Context context)

Deletes a VirtualMachine deployed on ScVmm fabric.

abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName)

Deletes a checkpoint in virtual machine.

abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineDeleteCheckpoint body)

Deletes a checkpoint in virtual machine.

abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineDeleteCheckpoint body, Context context)

Deletes a checkpoint in virtual machine.

abstract VirtualMachine getById(String id)

Implements VirtualMachine GET method.

abstract Response<VirtualMachine> getByIdWithResponse(String id, Context context)

Implements VirtualMachine GET method.

abstract VirtualMachine getByResourceGroup(String resourceGroupName, String virtualMachineName)

Implements VirtualMachine GET method.

abstract Response<VirtualMachine> getByResourceGroupWithResponse(String resourceGroupName, String virtualMachineName, Context context)

Implements VirtualMachine GET method.

abstract PagedIterable<VirtualMachine> list()

List of VirtualMachines in a subscription.

abstract PagedIterable<VirtualMachine> list(Context context)

List of VirtualMachines in a subscription.

abstract PagedIterable<VirtualMachine> listByResourceGroup(String resourceGroupName)

List of VirtualMachines in a resource group.

abstract PagedIterable<VirtualMachine> listByResourceGroup(String resourceGroupName, Context context)

List of VirtualMachines in a resource group.

abstract void restart(String resourceGroupName, String virtualMachineName)

Restart virtual machine.

abstract void restart(String resourceGroupName, String virtualMachineName, Context context)

Restart virtual machine.

abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName)

Restores to a checkpoint in virtual machine.

abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineRestoreCheckpoint body)

Restores to a checkpoint in virtual machine.

abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineRestoreCheckpoint body, Context context)

Restores to a checkpoint in virtual machine.

abstract void start(String resourceGroupName, String virtualMachineName)

Start virtual machine.

abstract void start(String resourceGroupName, String virtualMachineName, Context context)

Start virtual machine.

abstract void stop(String resourceGroupName, String virtualMachineName)

Stop virtual machine.

abstract void stop(String resourceGroupName, String virtualMachineName, StopVirtualMachineOptions body)

Stop virtual machine.

abstract void stop(String resourceGroupName, String virtualMachineName, StopVirtualMachineOptions body, Context context)

Stop virtual machine.

Method Details

createCheckpoint

public abstract void createCheckpoint(String resourceGroupName, String virtualMachineName)

Creates a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

createCheckpoint

public abstract void createCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineCreateCheckpoint body)

Creates a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine create checkpoint action payload.

createCheckpoint

public abstract void createCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineCreateCheckpoint body, Context context)

Creates a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine create checkpoint action payload.
context - The context to associate with this operation.

define

public abstract VirtualMachine.DefinitionStages.Blank define(String name)

Begins definition for a new VirtualMachine resource.

Parameters:

name - resource name.

Returns:

the first stage of the new VirtualMachine definition.

delete

public abstract void delete(String resourceGroupName, String virtualMachineName)

Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

delete

public abstract void delete(String resourceGroupName, String virtualMachineName, Boolean retain, Boolean force)

Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
retain - Whether to just disable the VM from azure and retain the VM in the VMM.
force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.

delete

public abstract void delete(String resourceGroupName, String virtualMachineName, Boolean retain, Boolean force, Context context)

Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
retain - Whether to just disable the VM from azure and retain the VM in the VMM.
force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Boolean retain, Boolean force, Context context)

Deletes a VirtualMachine deployed on ScVmm fabric.

Parameters:

id - the resource ID.
retain - Whether to just disable the VM from azure and retain the VM in the VMM.
force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.
context - The context to associate with this operation.

deleteCheckpoint

public abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName)

Deletes a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

deleteCheckpoint

public abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineDeleteCheckpoint body)

Deletes a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine delete checkpoint action payload.

deleteCheckpoint

public abstract void deleteCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineDeleteCheckpoint body, Context context)

Deletes a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine delete checkpoint action payload.
context - The context to associate with this operation.

getById

public abstract VirtualMachine getById(String id)

Implements VirtualMachine GET method.

Parameters:

id - the resource ID.

Returns:

the VirtualMachines resource definition along with Response<T>.

getByIdWithResponse

public abstract Response<VirtualMachine> getByIdWithResponse(String id, Context context)

Implements VirtualMachine GET method.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

the VirtualMachines resource definition along with Response<T>.

getByResourceGroup

public abstract VirtualMachine getByResourceGroup(String resourceGroupName, String virtualMachineName)

Implements VirtualMachine GET method.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

Returns:

the VirtualMachines resource definition.

getByResourceGroupWithResponse

public abstract Response<VirtualMachine> getByResourceGroupWithResponse(String resourceGroupName, String virtualMachineName, Context context)

Implements VirtualMachine GET method.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
context - The context to associate with this operation.

Returns:

the VirtualMachines resource definition along with Response<T>.

list

public abstract PagedIterable<VirtualMachine> list()

List of VirtualMachines in a subscription.

Returns:

list of VirtualMachines as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<VirtualMachine> list(Context context)

List of VirtualMachines in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

list of VirtualMachines as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VirtualMachine> listByResourceGroup(String resourceGroupName)

List of VirtualMachines in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

list of VirtualMachines as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VirtualMachine> listByResourceGroup(String resourceGroupName, Context context)

List of VirtualMachines in a resource group.

Parameters:

resourceGroupName - The name of the resource group.
context - The context to associate with this operation.

Returns:

list of VirtualMachines as paginated response with PagedIterable<T>.

restart

public abstract void restart(String resourceGroupName, String virtualMachineName)

Restart virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

restart

public abstract void restart(String resourceGroupName, String virtualMachineName, Context context)

Restart virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
context - The context to associate with this operation.

restoreCheckpoint

public abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName)

Restores to a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

restoreCheckpoint

public abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineRestoreCheckpoint body)

Restores to a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine restore checkpoint action payload.

restoreCheckpoint

public abstract void restoreCheckpoint(String resourceGroupName, String virtualMachineName, VirtualMachineRestoreCheckpoint body, Context context)

Restores to a checkpoint in virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine restore checkpoint action payload.
context - The context to associate with this operation.

start

public abstract void start(String resourceGroupName, String virtualMachineName)

Start virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

start

public abstract void start(String resourceGroupName, String virtualMachineName, Context context)

Start virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
context - The context to associate with this operation.

stop

public abstract void stop(String resourceGroupName, String virtualMachineName)

Stop virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.

stop

public abstract void stop(String resourceGroupName, String virtualMachineName, StopVirtualMachineOptions body)

Stop virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine stop action payload.

stop

public abstract void stop(String resourceGroupName, String virtualMachineName, StopVirtualMachineOptions body, Context context)

Stop virtual machine.

Parameters:

resourceGroupName - The name of the resource group.
virtualMachineName - Name of the VirtualMachine.
body - Virtualmachine stop action payload.
context - The context to associate with this operation.

Applies to