Package com.azure.resourcemanager.devtestlabs.models

Interface Labs

public interface Labs
Resource collection API of Labs.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Lab> list()
      List labs in a subscription.
      Returns:
      the response of a list operation as paginated response with PagedIterable.
      Throws:
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Lab> list(String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List labs in a subscription.
      Parameters:
      expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
      filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Lab> listByResourceGroup(String resourceGroupName)
      List labs in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group.
      Returns:
      the response of a list operation 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Lab> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List labs in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group.
      expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
      filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Lab> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, com.azure.core.util.Context context)
      Get lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
      context - The context to associate with this operation.
      Returns:
      lab 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.

    • getByResourceGroup

      Lab getByResourceGroup(String resourceGroupName, String name)
      Get lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      Returns:
      lab.
      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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String name)
      Delete lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      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.

    • delete

      void delete(String resourceGroupName, String name, com.azure.core.util.Context context)
      Delete lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      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.

    • claimAnyVm

      void claimAnyVm(String resourceGroupName, String name)
      Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      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.

    • claimAnyVm

      void claimAnyVm(String resourceGroupName, String name, com.azure.core.util.Context context)
      Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      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.

    • createEnvironment

      void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)
      Create virtual machines in a lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      labVirtualMachineCreationParameter - Properties for creating a virtual machine.
      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.

    • createEnvironment

      void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, com.azure.core.util.Context context)
      Create virtual machines in a lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      labVirtualMachineCreationParameter - Properties for creating a virtual machine.
      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.

    • exportResourceUsage

      void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters)
      Exports the lab resource usage into a storage account This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      exportResourceUsageParameters - The parameters of the export 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.

    • exportResourceUsage

      void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters, com.azure.core.util.Context context)
      Exports the lab resource usage into a storage account This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      exportResourceUsageParameters - The parameters of the export operation.
      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.

    • generateUploadUriWithResponse

      com.azure.core.http.rest.Response<GenerateUploadUriResponse> generateUploadUriWithResponse(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter, com.azure.core.util.Context context)
      Generate a URI for uploading custom disk images to a Lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      generateUploadUriParameter - Properties for generating an upload URI.
      context - The context to associate with this operation.
      Returns:
      response body for generating an upload URI 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.

    • generateUploadUri

      GenerateUploadUriResponse generateUploadUri(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter)
      Generate a URI for uploading custom disk images to a Lab.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      generateUploadUriParameter - Properties for generating an upload URI.
      Returns:
      response body for generating an upload URI.
      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.

    • importVirtualMachine

      void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest)
      Import a virtual machine into a different lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.
      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.

    • importVirtualMachine

      void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest, com.azure.core.util.Context context)
      Import a virtual machine into a different lab. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.
      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.

    • listVhds

      com.azure.core.http.rest.PagedIterable<LabVhd> listVhds(String resourceGroupName, String name)
      List disk images available for custom image creation.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      Returns:
      the response of a list operation 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.

    • listVhds

      com.azure.core.http.rest.PagedIterable<LabVhd> listVhds(String resourceGroupName, String name, com.azure.core.util.Context context)
      List disk images available for custom image creation.
      Parameters:
      resourceGroupName - The name of the resource group.
      name - The name of the lab.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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.

    • getById

      Lab getById(String id)
      Get lab.
      Parameters:
      id - the resource ID.
      Returns:
      lab 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Lab> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context)
      Get lab.
      Parameters:
      id - the resource ID.
      expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
      context - The context to associate with this operation.
      Returns:
      lab 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.

    • deleteById

      void deleteById(String id)
      Delete lab. This operation can take a while to complete.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete lab. This operation can take a while to complete.
      Parameters:
      id - the resource ID.
      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.

    • define

      Lab.DefinitionStages.Blank define(String name)
      Begins definition for a new Lab resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Lab definition.