Package com.azure.resourcemanager.devtestlabs.models

Interface Lab

public interface Lab
An immutable client-side representation of Lab.

  • Method Details

    • 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.

    • defaultStorageAccount

      String defaultStorageAccount()
      Gets the defaultStorageAccount property: The lab's default storage account.
      Returns:
      the defaultStorageAccount value.

    • defaultPremiumStorageAccount

      String defaultPremiumStorageAccount()
      Gets the defaultPremiumStorageAccount property: The lab's default premium storage account.
      Returns:
      the defaultPremiumStorageAccount value.

    • artifactsStorageAccount

      String artifactsStorageAccount()
      Gets the artifactsStorageAccount property: The lab's artifact storage account.
      Returns:
      the artifactsStorageAccount value.

    • premiumDataDiskStorageAccount

      String premiumDataDiskStorageAccount()
      Gets the premiumDataDiskStorageAccount property: The lab's premium data disk storage account.
      Returns:
      the premiumDataDiskStorageAccount value.

    • vaultName

      String vaultName()
      Gets the vaultName property: The lab's Key vault.
      Returns:
      the vaultName value.

    • labStorageType

      StorageType labStorageType()
      Gets the labStorageType property: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
      Returns:
      the labStorageType value.

    • mandatoryArtifactsResourceIdsLinux

      List<String> mandatoryArtifactsResourceIdsLinux()
      Gets the mandatoryArtifactsResourceIdsLinux property: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
      Returns:
      the mandatoryArtifactsResourceIdsLinux value.

    • mandatoryArtifactsResourceIdsWindows

      List<String> mandatoryArtifactsResourceIdsWindows()
      Gets the mandatoryArtifactsResourceIdsWindows property: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
      Returns:
      the mandatoryArtifactsResourceIdsWindows value.

    • createdDate

      OffsetDateTime createdDate()
      Gets the createdDate property: The creation date of the lab.
      Returns:
      the createdDate value.

    • premiumDataDisks

      PremiumDataDisk premiumDataDisks()
      Gets the premiumDataDisks property: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
      Returns:
      the premiumDataDisks value.

    • environmentPermission

      EnvironmentPermission environmentPermission()
      Gets the environmentPermission property: The access rights to be granted to the user when provisioning an environment.
      Returns:
      the environmentPermission value.

    • announcement

      LabAnnouncementProperties announcement()
      Gets the announcement property: The properties of any lab announcement associated with this lab.
      Returns:
      the announcement value.

    • support

      LabSupportProperties support()
      Gets the support property: The properties of any lab support message associated with this lab.
      Returns:
      the support value.

    • vmCreationResourceGroup

      String vmCreationResourceGroup()
      Gets the vmCreationResourceGroup property: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
      Returns:
      the vmCreationResourceGroup value.

    • publicIpId

      String publicIpId()
      Gets the publicIpId property: The public IP address for the lab's load balancer.
      Returns:
      the publicIpId value.

    • loadBalancerId

      String loadBalancerId()
      Gets the loadBalancerId property: The load balancer used to for lab VMs that use shared IP address.
      Returns:
      the loadBalancerId value.

    • networkSecurityGroupId

      String networkSecurityGroupId()
      Gets the networkSecurityGroupId property: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
      Returns:
      the networkSecurityGroupId value.

    • extendedProperties

      Map<String,String> extendedProperties()
      Gets the extendedProperties property: Extended properties of the lab used for experimental features.
      Returns:
      the extendedProperties value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: The provisioning status of the resource.
      Returns:
      the provisioningState value.

    • uniqueIdentifier

      String uniqueIdentifier()
      Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).
      Returns:
      the uniqueIdentifier 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.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      LabInner innerModel()
      Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.LabInner object.
      Returns:
      the inner object.

    • update

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

    • refresh

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

    • refresh

      Lab 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.

    • claimAnyVm

      void claimAnyVm()
      Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
      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.

    • claimAnyVm

      void claimAnyVm(com.azure.core.util.Context context)
      Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
      Parameters:
      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(LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)
      Create virtual machines in a lab. This operation can take a while to complete.
      Parameters:
      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(LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, com.azure.core.util.Context context)
      Create virtual machines in a lab. This operation can take a while to complete.
      Parameters:
      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(ExportResourceUsageParameters exportResourceUsageParameters)
      Exports the lab resource usage into a storage account This operation can take a while to complete.
      Parameters:
      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(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:
      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(GenerateUploadUriParameter generateUploadUriParameter, com.azure.core.util.Context context)
      Generate a URI for uploading custom disk images to a Lab.
      Parameters:
      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(GenerateUploadUriParameter generateUploadUriParameter)
      Generate a URI for uploading custom disk images to a Lab.
      Parameters:
      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(ImportLabVirtualMachineRequest importLabVirtualMachineRequest)
      Import a virtual machine into a different lab. This operation can take a while to complete.
      Parameters:
      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(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:
      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()
      List disk images available for custom image creation.
      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.

    • listVhds

      com.azure.core.http.rest.PagedIterable<LabVhd> listVhds(com.azure.core.util.Context context)
      List disk images available for custom image creation.
      Parameters:
      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.