Package com.azure.resourcemanager.labservices.models

Interface LabPlan

  • public interface LabPlan
    An immutable client-side representation of LabPlan.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: Metadata pertaining to creation and last modification of the lab plan.
        Returns:
        the systemData value.

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: Current provisioning state of the lab plan.
        Returns:
        the provisioningState value.

      • defaultConnectionProfile

        ConnectionProfile defaultConnectionProfile()
        Gets the defaultConnectionProfile property: The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
        Returns:
        the defaultConnectionProfile value.

      • defaultAutoShutdownProfile

        AutoShutdownProfile defaultAutoShutdownProfile()
        Gets the defaultAutoShutdownProfile property: The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
        Returns:
        the defaultAutoShutdownProfile value.

      • defaultNetworkProfile

        LabPlanNetworkProfile defaultNetworkProfile()
        Gets the defaultNetworkProfile property: The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
        Returns:
        the defaultNetworkProfile value.

      • allowedRegions

        List<String> allowedRegions()
        Gets the allowedRegions property: The allowed regions for the lab creator to use when creating labs using this lab plan.
        Returns:
        the allowedRegions value.

      • sharedGalleryId

        String sharedGalleryId()
        Gets the sharedGalleryId property: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
        Returns:
        the sharedGalleryId value.

      • supportInfo

        SupportInfo supportInfo()
        Gets the supportInfo property: Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
        Returns:
        the supportInfo value.

      • linkedLmsInstance

        String linkedLmsInstance()
        Gets the linkedLmsInstance property: Base Url of the lms instance this lab plan can link lab rosters against.
        Returns:
        the linkedLmsInstance value.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        LabPlanInner innerModel()
        Gets the inner com.azure.resourcemanager.labservices.fluent.models.LabPlanInner object.
        Returns:
        the inner object.

      • update

        LabPlan.Update update()
        Begins update for the LabPlan resource.
        Returns:
        the stage of resource update.

      • refresh

        LabPlan refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        LabPlan refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • saveImage

        void saveImage​(SaveImageBody body)
        Saves an image from a lab VM to the attached shared image gallery.
        Parameters:
        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​(SaveImageBody body,
               com.azure.core.util.Context context)
        Saves an image from a lab VM to the attached shared image gallery.
        Parameters:
        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.