Share via


VirtualMachinesClient Interface

public interface VirtualMachinesClient

An instance of this class provides access to all the operations defined in VirtualMachinesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginRedeploy(String resourceGroupName, String labName, String virtualMachineName)

Redeploy a lab virtual machine to a different compute node.

abstract SyncPoller<PollResult<Void>,Void> beginRedeploy(String resourceGroupName, String labName, String virtualMachineName, Context context)

Redeploy a lab virtual machine to a different compute node.

abstract SyncPoller<PollResult<Void>,Void> beginReimage(String resourceGroupName, String labName, String virtualMachineName)

Re-image a lab virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginReimage(String resourceGroupName, String labName, String virtualMachineName, Context context)

Re-image a lab virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)

Reset a lab virtual machine password.

abstract SyncPoller<PollResult<Void>,Void> beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, Context context)

Reset a lab virtual machine password.

abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String labName, String virtualMachineName)

Start a lab virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String labName, String virtualMachineName, Context context)

Start a lab virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String labName, String virtualMachineName)

Stop a lab virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String labName, String virtualMachineName, Context context)

Stop a lab virtual machine.

abstract VirtualMachineInner get(String resourceGroupName, String labName, String virtualMachineName)

Get a lab virtual machine.

abstract Response<VirtualMachineInner> getWithResponse(String resourceGroupName, String labName, String virtualMachineName, Context context)

Get a lab virtual machine.

abstract PagedIterable<VirtualMachineInner> listByLab(String resourceGroupName, String labName)

Get all virtual machines for a lab.

abstract PagedIterable<VirtualMachineInner> listByLab(String resourceGroupName, String labName, String filter, Context context)

Get all virtual machines for a lab.

abstract void redeploy(String resourceGroupName, String labName, String virtualMachineName)

Redeploy a lab virtual machine to a different compute node.

abstract void redeploy(String resourceGroupName, String labName, String virtualMachineName, Context context)

Redeploy a lab virtual machine to a different compute node.

abstract void reimage(String resourceGroupName, String labName, String virtualMachineName)

Re-image a lab virtual machine.

abstract void reimage(String resourceGroupName, String labName, String virtualMachineName, Context context)

Re-image a lab virtual machine.

abstract void resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)

Reset a lab virtual machine password.

abstract void resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, Context context)

Reset a lab virtual machine password.

abstract void start(String resourceGroupName, String labName, String virtualMachineName)

Start a lab virtual machine.

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

Start a lab virtual machine.

abstract void stop(String resourceGroupName, String labName, String virtualMachineName)

Stop a lab virtual machine.

abstract void stop(String resourceGroupName, String labName, String virtualMachineName, Context context)

Stop a lab virtual machine.

Method Details

beginRedeploy

public abstract SyncPoller<PollResult<Void>,Void> beginRedeploy(String resourceGroupName, String labName, String virtualMachineName)

Redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity. Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRedeploy

public abstract SyncPoller<PollResult<Void>,Void> beginRedeploy(String resourceGroupName, String labName, String virtualMachineName, Context context)

Redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity. Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReimage

public abstract SyncPoller<PollResult<Void>,Void> beginReimage(String resourceGroupName, String labName, String virtualMachineName)

Re-image a lab virtual machine. Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReimage

public abstract SyncPoller<PollResult<Void>,Void> beginReimage(String resourceGroupName, String labName, String virtualMachineName, Context context)

Re-image a lab virtual machine. Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginResetPassword

public abstract SyncPoller<PollResult<Void>,Void> beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)

Reset a lab virtual machine password. Resets a lab virtual machine password.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
body - The request body.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginResetPassword

public abstract SyncPoller<PollResult<Void>,Void> beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, Context context)

Reset a lab virtual machine password. Resets a lab virtual machine password.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
body - The request body.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String labName, String virtualMachineName)

Start a lab virtual machine. Action to start a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStart

public abstract SyncPoller<PollResult<Void>,Void> beginStart(String resourceGroupName, String labName, String virtualMachineName, Context context)

Start a lab virtual machine. Action to start a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStop

public abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String labName, String virtualMachineName)

Stop a lab virtual machine. Action to stop a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginStop

public abstract SyncPoller<PollResult<Void>,Void> beginStop(String resourceGroupName, String labName, String virtualMachineName, Context context)

Stop a lab virtual machine. Action to stop a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

get

public abstract VirtualMachineInner get(String resourceGroupName, String labName, String virtualMachineName)

Get a lab virtual machine. Returns the properties for a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

Returns:

a lab virtual machine resource.

getWithResponse

public abstract Response<VirtualMachineInner> getWithResponse(String resourceGroupName, String labName, String virtualMachineName, Context context)

Get a lab virtual machine. Returns the properties for a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Returns:

a lab virtual machine resource along with Response<T>.

listByLab

public abstract PagedIterable<VirtualMachineInner> listByLab(String resourceGroupName, String labName)

Get all virtual machines for a lab. Returns a list of all virtual machines for a lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.

Returns:

paged list of lab services virtual machines as paginated response with PagedIterable<T>.

listByLab

public abstract PagedIterable<VirtualMachineInner> listByLab(String resourceGroupName, String labName, String filter, Context context)

Get all virtual machines for a lab. Returns a list of all virtual machines for a lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
filter - The filter to apply to the operation.
context - The context to associate with this operation.

Returns:

paged list of lab services virtual machines as paginated response with PagedIterable<T>.

redeploy

public abstract void redeploy(String resourceGroupName, String labName, String virtualMachineName)

Redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity. Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

redeploy

public abstract void redeploy(String resourceGroupName, String labName, String virtualMachineName, Context context)

Redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity. Action to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

reimage

public abstract void reimage(String resourceGroupName, String labName, String virtualMachineName)

Re-image a lab virtual machine. Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

reimage

public abstract void reimage(String resourceGroupName, String labName, String virtualMachineName, Context context)

Re-image a lab virtual machine. Re-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

resetPassword

public abstract void resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)

Reset a lab virtual machine password. Resets a lab virtual machine password.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
body - The request body.

resetPassword

public abstract void resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, Context context)

Reset a lab virtual machine password. Resets a lab virtual machine password.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
body - The request body.
context - The context to associate with this operation.

start

public abstract void start(String resourceGroupName, String labName, String virtualMachineName)

Start a lab virtual machine. Action to start a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

start

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

Start a lab virtual machine. Action to start a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

stop

public abstract void stop(String resourceGroupName, String labName, String virtualMachineName)

Stop a lab virtual machine. Action to stop a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.

stop

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

Stop a lab virtual machine. Action to stop a lab virtual machine.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
virtualMachineName - The ID of the virtual machine that uniquely identifies it within the containing lab. Used in resource URIs.
context - The context to associate with this operation.

Applies to