Lab Interface

Package:
com.azure.resourcemanager.devtestlabs.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.2.0

public interface Lab

An immutable client-side representation of Lab.

Method Summary

Modifier and Type Method and Description
abstract LabAnnouncementProperties announcement()

Gets the announcement property: The properties of any lab announcement associated with this lab.
abstract String artifactsStorageAccount()

Gets the artifactsStorageAccount property: The lab's artifact storage account.
abstract void claimAnyVm()

Claim a random claimable virtual machine in the lab.
abstract void claimAnyVm(Context context)

Claim a random claimable virtual machine in the lab.
abstract OffsetDateTime createdDate()

Gets the createdDate property: The creation date of the lab.
abstract void createEnvironment(LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)

Create virtual machines in a lab.
abstract void createEnvironment(LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, Context context)

Create virtual machines in a lab.
abstract String defaultPremiumStorageAccount()

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

Gets the defaultStorageAccount property: The lab's default storage account.
abstract EnvironmentPermission environmentPermission()

Gets the environmentPermission property: The access rights to be granted to the user when provisioning an environment.
abstract void exportResourceUsage(ExportResourceUsageParameters exportResourceUsageParameters)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract void exportResourceUsage(ExportResourceUsageParameters exportResourceUsageParameters, Context context)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract Map<String,String> extendedProperties()

Gets the extendedProperties property: Extended properties of the lab used for experimental features.
abstract GenerateUploadUriResponse generateUploadUri(GenerateUploadUriParameter generateUploadUriParameter)

Generate a URI for uploading custom disk images to a Lab.
abstract Response<GenerateUploadUriResponse> generateUploadUriWithResponse(GenerateUploadUriParameter generateUploadUriParameter, Context context)

Generate a URI for uploading custom disk images to a Lab.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract void importVirtualMachine(ImportLabVirtualMachineRequest importLabVirtualMachineRequest)

Import a virtual machine into a different lab.
abstract void importVirtualMachine(ImportLabVirtualMachineRequest importLabVirtualMachineRequest, Context context)

Import a virtual machine into a different lab.
abstract LabInner innerModel()

Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.LabInner object.
abstract StorageType labStorageType()

Gets the labStorageType property: Type of storage used by the lab.
abstract PagedIterable<LabVhd> listVhds()

List disk images available for custom image creation.
abstract PagedIterable<LabVhd> listVhds(Context context)

List disk images available for custom image creation.
abstract String loadBalancerId()

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

Gets the location property: The geo-location where the resource lives.
abstract 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.
abstract 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.
abstract String name()

Gets the name property: The name of the resource.
abstract String networkSecurityGroupId()

Gets the networkSecurityGroupId property: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
abstract PremiumDataDisk premiumDataDisks()

Gets the premiumDataDisks property: The setting to enable usage of premium data disks.
abstract String premiumDataDiskStorageAccount()

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

Gets the provisioningState property: The provisioning status of the resource.
abstract String publicIpId()

Gets the publicIpId property: The public IP address for the lab's load balancer.
abstract Lab refresh()

Refreshes the resource to sync with Azure.
abstract Lab refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract LabSupportProperties support()

Gets the support property: The properties of any lab support message associated with this lab.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract String type()

Gets the type property: The type of the resource.
abstract String uniqueIdentifier()

Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).
abstract Update update()

Begins update for the Lab resource.
abstract String vaultName()

Gets the vaultName property: The lab's Key vault.
abstract String vmCreationResourceGroup()

Gets the vmCreationResourceGroup property: The resource group in which all new lab virtual machines will be created.

Method Details

announcement

public abstract LabAnnouncementProperties announcement()

Gets the announcement property: The properties of any lab announcement associated with this lab.

Returns:

the announcement value.

artifactsStorageAccount

public abstract String artifactsStorageAccount()

Gets the artifactsStorageAccount property: The lab's artifact storage account.

Returns:

the artifactsStorageAccount value.

claimAnyVm

public abstract void claimAnyVm()

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

claimAnyVm

public abstract void claimAnyVm(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.

createdDate

public abstract OffsetDateTime createdDate()

Gets the createdDate property: The creation date of the lab.

Returns:

the createdDate value.

createEnvironment

public abstract 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.

createEnvironment

public abstract void createEnvironment(LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, 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.

defaultPremiumStorageAccount

public abstract String defaultPremiumStorageAccount()

Gets the defaultPremiumStorageAccount property: The lab's default premium storage account.

Returns:

the defaultPremiumStorageAccount value.

defaultStorageAccount

public abstract String defaultStorageAccount()

Gets the defaultStorageAccount property: The lab's default storage account.

Returns:

the defaultStorageAccount value.

environmentPermission

public abstract EnvironmentPermission environmentPermission()

Gets the environmentPermission property: The access rights to be granted to the user when provisioning an environment.

Returns:

the environmentPermission value.

exportResourceUsage

public abstract 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.

exportResourceUsage

public abstract void exportResourceUsage(ExportResourceUsageParameters exportResourceUsageParameters, 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.

extendedProperties

public abstract Map<String,String> extendedProperties()

Gets the extendedProperties property: Extended properties of the lab used for experimental features.

Returns:

the extendedProperties value.

generateUploadUri

public abstract 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.

generateUploadUriWithResponse

public abstract Response<GenerateUploadUriResponse> generateUploadUriWithResponse(GenerateUploadUriParameter generateUploadUriParameter, 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<T>.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

importVirtualMachine

public abstract 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.

importVirtualMachine

public abstract void importVirtualMachine(ImportLabVirtualMachineRequest importLabVirtualMachineRequest, 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.

innerModel

public abstract LabInner innerModel()

Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.LabInner object.

Returns:

the inner object.

labStorageType

public abstract 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.

listVhds

public abstract PagedIterable<LabVhd> listVhds()

List disk images available for custom image creation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listVhds

public abstract PagedIterable<LabVhd> listVhds(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<T>.

loadBalancerId

public abstract String loadBalancerId()

Gets the loadBalancerId property: The load balancer used to for lab VMs that use shared IP address.

Returns:

the loadBalancerId value.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

mandatoryArtifactsResourceIdsLinux

public abstract 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

public abstract 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.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkSecurityGroupId

public abstract 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.

premiumDataDisks

public abstract 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.

premiumDataDiskStorageAccount

public abstract String premiumDataDiskStorageAccount()

Gets the premiumDataDiskStorageAccount property: The lab's premium data disk storage account.

Returns:

the premiumDataDiskStorageAccount value.

provisioningState

public abstract String provisioningState()

Gets the provisioningState property: The provisioning status of the resource.

Returns:

the provisioningState value.

publicIpId

public abstract String publicIpId()

Gets the publicIpId property: The public IP address for the lab's load balancer.

Returns:

the publicIpId value.

refresh

public abstract Lab refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Lab refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

support

public abstract LabSupportProperties support()

Gets the support property: The properties of any lab support message associated with this lab.

Returns:

the support value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

uniqueIdentifier

public abstract String uniqueIdentifier()

Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).

Returns:

the uniqueIdentifier value.

update

public abstract Lab.Update update()

Begins update for the Lab resource.

Returns:

the stage of resource update.

vaultName

public abstract String vaultName()

Gets the vaultName property: The lab's Key vault.

Returns:

the vaultName value.

vmCreationResourceGroup

public abstract 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.

Applies to