Package com.azure.resourcemanager.labservices.models

Interface LabPlans

public interface LabPlans
Resource collection API of LabPlans.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<LabPlan> list()
      Get all lab plans for a subscription.

      Returns a list of all lab plans within a subscription.

      Returns:
      paged list of lab plans 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<LabPlan> list(String filter, com.azure.core.util.Context context)
      Get all lab plans for a subscription.

      Returns a list of all lab plans within a subscription.

      Parameters:
      filter - The filter to apply to the operation.
      context - The context to associate with this operation.
      Returns:
      paged list of lab plans 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<LabPlan> listByResourceGroup(String resourceGroupName)
      Get all lab plans for a subscription and resource group.

      Returns a list of all lab plans for a subscription and resource group.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      paged list of lab plans 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<LabPlan> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Get all lab plans for a subscription and resource group.

      Returns a list of all lab plans for a subscription and resource group.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      paged list of lab plans 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.

    • getByResourceGroup

      LabPlan getByResourceGroup(String resourceGroupName, String labPlanName)
      Retrieves a Lab Plan resource.

      Retrieves the properties of a Lab Plan.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      Returns:
      lab Plans act as a permission container for creating labs via labs.azure.com.
      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<LabPlan> getByResourceGroupWithResponse(String resourceGroupName, String labPlanName, com.azure.core.util.Context context)
      Retrieves a Lab Plan resource.

      Retrieves the properties of a Lab Plan.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      context - The context to associate with this operation.
      Returns:
      lab Plans act as a permission container for creating labs via labs.azure.com 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String labPlanName)
      Deletes a Lab Plan resource.

      Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      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 labPlanName, com.azure.core.util.Context context)
      Deletes a Lab Plan resource.

      Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      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.

    • saveImage

      void saveImage(String resourceGroupName, String labPlanName, SaveImageBody body)
      Save an image from a lab VM to the attached shared image gallery.

      Saves an image from a lab VM to the attached shared image gallery.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      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.

    • saveImage

      void saveImage(String resourceGroupName, String labPlanName, SaveImageBody body, com.azure.core.util.Context context)
      Save an image from a lab VM to the attached shared image gallery.

      Saves an image from a lab VM to the attached shared image gallery.

      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
      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.

    • getById

      LabPlan getById(String id)
      Retrieves a Lab Plan resource.

      Retrieves the properties of a Lab Plan.

      Parameters:
      id - the resource ID.
      Returns:
      lab Plans act as a permission container for creating labs via labs.azure.com 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<LabPlan> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Retrieves a Lab Plan resource.

      Retrieves the properties of a Lab Plan.

      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      lab Plans act as a permission container for creating labs via labs.azure.com 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)
      Deletes a Lab Plan resource.

      Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.

      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)
      Deletes a Lab Plan resource.

      Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.

      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

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