Interface VirtualMachinesClient


public interface VirtualMachinesClient
An instance of this class provides access to all the operations defined in VirtualMachinesClient.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginRedeploy(String resourceGroupName, String labName, String virtualMachineName)
    Redeploy a lab virtual machine to a different compute node.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginRedeploy(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Redeploy a lab virtual machine to a different compute node.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginReimage(String resourceGroupName, String labName, String virtualMachineName)
    Re-image a lab virtual machine.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginReimage(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Re-image a lab virtual machine.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)
    Reset a lab virtual machine password.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, com.azure.core.util.Context context)
    Reset a lab virtual machine password.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginStart(String resourceGroupName, String labName, String virtualMachineName)
    Start a lab virtual machine.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginStart(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Start a lab virtual machine.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginStop(String resourceGroupName, String labName, String virtualMachineName)
    Stop a lab virtual machine.
    com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>
    beginStop(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Stop a lab virtual machine.
    get(String resourceGroupName, String labName, String virtualMachineName)
    Get a lab virtual machine.
    com.azure.core.http.rest.Response<VirtualMachineInner>
    getWithResponse(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Get a lab virtual machine.
    com.azure.core.http.rest.PagedIterable<VirtualMachineInner>
    listByLab(String resourceGroupName, String labName)
    Get all virtual machines for a lab.
    com.azure.core.http.rest.PagedIterable<VirtualMachineInner>
    listByLab(String resourceGroupName, String labName, String filter, com.azure.core.util.Context context)
    Get all virtual machines for a lab.
    void
    redeploy(String resourceGroupName, String labName, String virtualMachineName)
    Redeploy a lab virtual machine to a different compute node.
    void
    redeploy(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Redeploy a lab virtual machine to a different compute node.
    void
    reimage(String resourceGroupName, String labName, String virtualMachineName)
    Re-image a lab virtual machine.
    void
    reimage(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Re-image a lab virtual machine.
    void
    resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body)
    Reset a lab virtual machine password.
    void
    resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, com.azure.core.util.Context context)
    Reset a lab virtual machine password.
    void
    start(String resourceGroupName, String labName, String virtualMachineName)
    Start a lab virtual machine.
    void
    start(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Start a lab virtual machine.
    void
    stop(String resourceGroupName, String labName, String virtualMachineName)
    Stop a lab virtual machine.
    void
    stop(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.Context context)
    Stop a lab virtual machine.
  • Method Details

    • listByLab

      com.azure.core.http.rest.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listByLab

      com.azure.core.http.rest.PagedIterable<VirtualMachineInner> listByLab(String resourceGroupName, String labName, String filter, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<VirtualMachineInner> getWithResponse(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStart

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStart(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • start

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • start

      void start(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStop

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginStop

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStop(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stop

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stop

      void stop(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginReimage

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginReimage

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginReimage(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • reimage

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • reimage

      void reimage(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginRedeploy

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginRedeploy

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRedeploy(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • redeploy

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • redeploy

      void redeploy(String resourceGroupName, String labName, String virtualMachineName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginResetPassword

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginResetPassword

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginResetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, com.azure.core.util.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 for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • resetPassword

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • resetPassword

      void resetPassword(String resourceGroupName, String labName, String virtualMachineName, ResetPasswordBody body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.