LabVirtualMachine Interface

Package:

com.azure.resourcemanager.devtestlabs.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.0.0-beta.2

public interface LabVirtualMachine

An immutable client-side representation of LabVirtualMachine.

Method Summary

Modifier and Type	Method and Description
abstract void	addDataDisk(DataDiskProperties dataDiskProperties) Attach a new or existing data disk to virtual machine.
abstract void	addDataDisk(DataDiskProperties dataDiskProperties, Context context) Attach a new or existing data disk to virtual machine.
abstract Boolean	allowClaim() Gets the allowClaim property: Indicates whether another user can take ownership of the virtual machine.
abstract ApplicableSchedule	applicableSchedule() Gets the applicableSchedule property: The applicable schedule for the virtual machine.
abstract void	applyArtifacts(ApplyArtifactsRequest applyArtifactsRequest) Apply artifacts to virtual machine.
abstract void	applyArtifacts(ApplyArtifactsRequest applyArtifactsRequest, Context context) Apply artifacts to virtual machine.
abstract ArtifactDeploymentStatusProperties	artifactDeploymentStatus() Gets the artifactDeploymentStatus property: The artifact deployment status for the virtual machine.
abstract List<ArtifactInstallProperties>	artifacts() Gets the artifacts property: The artifacts to be installed on the virtual machine.
abstract void	claim() Take ownership of an existing virtual machine This operation can take a while to complete.
abstract void	claim(Context context) Take ownership of an existing virtual machine This operation can take a while to complete.
abstract String	computeId() Gets the computeId property: The resource identifier (Microsoft.Compute) of the virtual machine.
abstract ComputeVmProperties	computeVm() Gets the computeVm property: The compute virtual machine properties.
abstract String	createdByUser() Gets the createdByUser property: The email address of creator of the virtual machine.
abstract String	createdByUserId() Gets the createdByUserId property: The object identifier of the creator of the virtual machine.
abstract OffsetDateTime	createdDate() Gets the createdDate property: The creation date of the virtual machine.
abstract String	customImageId() Gets the customImageId property: The custom image identifier of the virtual machine.
abstract List<DataDiskProperties>	dataDiskParameters() Gets the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.
abstract void	detachDataDisk(DetachDataDiskProperties detachDataDiskProperties) Detach the specified disk from the virtual machine.
abstract void	detachDataDisk(DetachDataDiskProperties detachDataDiskProperties, Context context) Detach the specified disk from the virtual machine.
abstract Boolean	disallowPublicIpAddress() Gets the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.
abstract String	environmentId() Gets the environmentId property: The resource ID of the environment that contains this virtual machine, if any.
abstract OffsetDateTime	expirationDate() Gets the expirationDate property: The expiration date for VM.
abstract String	fqdn() Gets the fqdn property: The fully-qualified domain name of the virtual machine.
abstract GalleryImageReference	galleryImageReference() Gets the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.
abstract RdpConnection	getRdpFileContents() Gets a string that represents the contents of the RDP file for the virtual machine.
abstract Response<RdpConnection>	getRdpFileContentsWithResponse(Context context) Gets a string that represents the contents of the RDP file for the virtual machine.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract LabVirtualMachineInner	innerModel() Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.LabVirtualMachineInner object.
abstract Boolean	isAuthenticationWithSshKey() Gets the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.
abstract String	labSubnetName() Gets the labSubnetName property: The lab subnet name of the virtual machine.
abstract String	labVirtualNetworkId() Gets the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.
abstract String	lastKnownPowerState() Gets the lastKnownPowerState property: Last known compute power state captured in DTL.
abstract ApplicableSchedule	listApplicableSchedules() Lists the applicable start/stop schedules, if any.
abstract Response<ApplicableSchedule>	listApplicableSchedulesWithResponse(Context context) Lists the applicable start/stop schedules, if any.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	name() Gets the name property: The name of the resource.
abstract NetworkInterfaceProperties	networkInterface() Gets the networkInterface property: The network interface properties.
abstract String	notes() Gets the notes property: The notes of the virtual machine.
abstract String	osType() Gets the osType property: The OS type of the virtual machine.
abstract String	ownerObjectId() Gets the ownerObjectId property: The object identifier of the owner of the virtual machine.
abstract String	ownerUserPrincipalName() Gets the ownerUserPrincipalName property: The user principal name of the virtual machine owner.
abstract String	password() Gets the password property: The password of the virtual machine administrator.
abstract String	planId() Gets the planId property: The id of the plan associated with the virtual machine image.
abstract String	provisioningState() Gets the provisioningState property: The provisioning status of the resource.
abstract void	redeploy() Redeploy a virtual machine This operation can take a while to complete.
abstract void	redeploy(Context context) Redeploy a virtual machine This operation can take a while to complete.
abstract LabVirtualMachine	refresh() Refreshes the resource to sync with Azure.
abstract LabVirtualMachine	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 void	resize(ResizeLabVirtualMachineProperties resizeLabVirtualMachineProperties) Resize Virtual Machine.
abstract void	resize(ResizeLabVirtualMachineProperties resizeLabVirtualMachineProperties, Context context) Resize Virtual Machine.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract void	restart() Restart a virtual machine.
abstract void	restart(Context context) Restart a virtual machine.
abstract List<ScheduleCreationParameter>	scheduleParameters() Gets the scheduleParameters property: Virtual Machine schedules to be created.
abstract String	size() Gets the size property: The size of the virtual machine.
abstract String	sshKey() Gets the sshKey property: The SSH key of the virtual machine administrator.
abstract void	start() Start a virtual machine.
abstract void	start(Context context) Start a virtual machine.
abstract void	stop() Stop a virtual machine This operation can take a while to complete.
abstract void	stop(Context context) Stop a virtual machine This operation can take a while to complete.
abstract String	storageType() Gets the storageType property: Storage type to use for virtual machine (i.e.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract void	transferDisks() Transfers all data disks attached to the virtual machine to be owned by the current user.
abstract void	transferDisks(Context context) Transfers all data disks attached to the virtual machine to be owned by the current user.
abstract String	type() Gets the type property: The type of the resource.
abstract void	unClaim() Release ownership of an existing virtual machine This operation can take a while to complete.
abstract void	unClaim(Context context) Release ownership of an existing virtual machine This operation can take a while to complete.
abstract String	uniqueIdentifier() Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).
abstract Update	update() Begins update for the LabVirtualMachine resource.
abstract String	username() Gets the username property: The user name of the virtual machine.
abstract VirtualMachineCreationSource	virtualMachineCreationSource() Gets the virtualMachineCreationSource property: Tells source of creation of lab virtual machine.

Method Details

addDataDisk

public abstract void addDataDisk(DataDiskProperties dataDiskProperties)

Attach a new or existing data disk to virtual machine. This operation can take a while to complete.

Parameters:

dataDiskProperties - Request body for adding a new or existing data disk to a virtual machine.

addDataDisk

public abstract void addDataDisk(DataDiskProperties dataDiskProperties, Context context)

Attach a new or existing data disk to virtual machine. This operation can take a while to complete.

Parameters:

dataDiskProperties - Request body for adding a new or existing data disk to a virtual machine.

context - The context to associate with this operation.

allowClaim

public abstract Boolean allowClaim()

Gets the allowClaim property: Indicates whether another user can take ownership of the virtual machine.

Returns:

the allowClaim value.

applicableSchedule

public abstract ApplicableSchedule applicableSchedule()

Gets the applicableSchedule property: The applicable schedule for the virtual machine.

Returns:

the applicableSchedule value.

applyArtifacts

public abstract void applyArtifacts(ApplyArtifactsRequest applyArtifactsRequest)

Apply artifacts to virtual machine. This operation can take a while to complete.

Parameters:

applyArtifactsRequest - Request body for applying artifacts to a virtual machine.

applyArtifacts

public abstract void applyArtifacts(ApplyArtifactsRequest applyArtifactsRequest, Context context)

Apply artifacts to virtual machine. This operation can take a while to complete.

Parameters:

applyArtifactsRequest - Request body for applying artifacts to a virtual machine.

context - The context to associate with this operation.

artifactDeploymentStatus

public abstract ArtifactDeploymentStatusProperties artifactDeploymentStatus()

Gets the artifactDeploymentStatus property: The artifact deployment status for the virtual machine.

Returns:

the artifactDeploymentStatus value.

artifacts

public abstract List artifacts()

Gets the artifacts property: The artifacts to be installed on the virtual machine.

Returns:

the artifacts value.

claim

public abstract void claim()

Take ownership of an existing virtual machine This operation can take a while to complete.

claim

public abstract void claim(Context context)

Take ownership of an existing virtual machine This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

computeId

public abstract String computeId()

Gets the computeId property: The resource identifier (Microsoft.Compute) of the virtual machine.

Returns:

the computeId value.

computeVm

public abstract ComputeVmProperties computeVm()

Gets the computeVm property: The compute virtual machine properties.

Returns:

the computeVm value.

createdByUser

public abstract String createdByUser()

Gets the createdByUser property: The email address of creator of the virtual machine.

Returns:

the createdByUser value.

createdByUserId

public abstract String createdByUserId()

Gets the createdByUserId property: The object identifier of the creator of the virtual machine.

Returns:

the createdByUserId value.

createdDate

public abstract OffsetDateTime createdDate()

Gets the createdDate property: The creation date of the virtual machine.

Returns:

the createdDate value.

customImageId

public abstract String customImageId()

Gets the customImageId property: The custom image identifier of the virtual machine.

Returns:

the customImageId value.

dataDiskParameters

public abstract List dataDiskParameters()

Gets the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.

Returns:

the dataDiskParameters value.

detachDataDisk

public abstract void detachDataDisk(DetachDataDiskProperties detachDataDiskProperties)

Detach the specified disk from the virtual machine. This operation can take a while to complete.

Parameters:

detachDataDiskProperties - Request body for detaching data disk from a virtual machine.

detachDataDisk

public abstract void detachDataDisk(DetachDataDiskProperties detachDataDiskProperties, Context context)

Detach the specified disk from the virtual machine. This operation can take a while to complete.

Parameters:

detachDataDiskProperties - Request body for detaching data disk from a virtual machine.

context - The context to associate with this operation.

disallowPublicIpAddress

public abstract Boolean disallowPublicIpAddress()

Gets the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.

Returns:

the disallowPublicIpAddress value.

environmentId

public abstract String environmentId()

Gets the environmentId property: The resource ID of the environment that contains this virtual machine, if any.

Returns:

the environmentId value.

expirationDate

public abstract OffsetDateTime expirationDate()

Gets the expirationDate property: The expiration date for VM.

Returns:

the expirationDate value.

fqdn

public abstract String fqdn()

Gets the fqdn property: The fully-qualified domain name of the virtual machine.

Returns:

the fqdn value.

galleryImageReference

public abstract GalleryImageReference galleryImageReference()

Gets the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.

Returns:

the galleryImageReference value.

getRdpFileContents

public abstract RdpConnection getRdpFileContents()

Gets a string that represents the contents of the RDP file for the virtual machine.

Returns:

a string that represents the contents of the RDP file for the virtual machine.

getRdpFileContentsWithResponse

public abstract Response getRdpFileContentsWithResponse(Context context)

Gets a string that represents the contents of the RDP file for the virtual machine.

Parameters:

context - The context to associate with this operation.

Returns:

a string that represents the contents of the RDP file for the virtual machine along with Response<T>.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract LabVirtualMachineInner innerModel()

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

Returns:

the inner object.

isAuthenticationWithSshKey

public abstract Boolean isAuthenticationWithSshKey()

Gets the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.

Returns:

the isAuthenticationWithSshKey value.

labSubnetName

public abstract String labSubnetName()

Gets the labSubnetName property: The lab subnet name of the virtual machine.

Returns:

the labSubnetName value.

labVirtualNetworkId

public abstract String labVirtualNetworkId()

Gets the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.

Returns:

the labVirtualNetworkId value.

lastKnownPowerState

public abstract String lastKnownPowerState()

Gets the lastKnownPowerState property: Last known compute power state captured in DTL.

Returns:

the lastKnownPowerState value.

listApplicableSchedules

public abstract ApplicableSchedule listApplicableSchedules()

Lists the applicable start/stop schedules, if any.

Returns:

schedules applicable to a virtual machine.

listApplicableSchedulesWithResponse

public abstract Response listApplicableSchedulesWithResponse(Context context)

Lists the applicable start/stop schedules, if any.

Parameters:

context - The context to associate with this operation.

Returns:

schedules applicable to a virtual machine along with Response<T>.

location

public abstract String location()

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

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkInterface

public abstract NetworkInterfaceProperties networkInterface()

Gets the networkInterface property: The network interface properties.

Returns:

the networkInterface value.

notes

public abstract String notes()

Gets the notes property: The notes of the virtual machine.

Returns:

the notes value.

osType

public abstract String osType()

Gets the osType property: The OS type of the virtual machine.

Returns:

the osType value.

ownerObjectId

public abstract String ownerObjectId()

Gets the ownerObjectId property: The object identifier of the owner of the virtual machine.

Returns:

the ownerObjectId value.

ownerUserPrincipalName

public abstract String ownerUserPrincipalName()

Gets the ownerUserPrincipalName property: The user principal name of the virtual machine owner.

Returns:

the ownerUserPrincipalName value.

password

public abstract String password()

Gets the password property: The password of the virtual machine administrator.

Returns:

the password value.

planId

public abstract String planId()

Gets the planId property: The id of the plan associated with the virtual machine image.

Returns:

the planId value.

provisioningState

public abstract String provisioningState()

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

Returns:

the provisioningState value.

redeploy

public abstract void redeploy()

Redeploy a virtual machine This operation can take a while to complete.

redeploy

public abstract void redeploy(Context context)

Redeploy a virtual machine This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

refresh

public abstract LabVirtualMachine refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

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

resize

public abstract void resize(ResizeLabVirtualMachineProperties resizeLabVirtualMachineProperties)

Resize Virtual Machine. This operation can take a while to complete.

Parameters:

resizeLabVirtualMachineProperties - Request body for resizing a virtual machine.

resize

public abstract void resize(ResizeLabVirtualMachineProperties resizeLabVirtualMachineProperties, Context context)

Resize Virtual Machine. This operation can take a while to complete.

Parameters:

resizeLabVirtualMachineProperties - Request body for resizing a virtual machine.

context - The context to associate with this operation.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

restart

public abstract void restart()

Restart a virtual machine. This operation can take a while to complete.

restart

public abstract void restart(Context context)

Restart a virtual machine. This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

scheduleParameters

public abstract List scheduleParameters()

Gets the scheduleParameters property: Virtual Machine schedules to be created.

Returns:

the scheduleParameters value.

size

public abstract String size()

Gets the size property: The size of the virtual machine.

Returns:

the size value.

sshKey

public abstract String sshKey()

Gets the sshKey property: The SSH key of the virtual machine administrator.

Returns:

the sshKey value.

start

public abstract void start()

Start a virtual machine. This operation can take a while to complete.

start

public abstract void start(Context context)

Start a virtual machine. This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

stop

public abstract void stop()

Stop a virtual machine This operation can take a while to complete.

stop

public abstract void stop(Context context)

Stop a virtual machine This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

storageType

public abstract String storageType()

Gets the storageType property: Storage type to use for virtual machine (i.e. Standard, Premium).

Returns:

the storageType value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

transferDisks

public abstract void transferDisks()

Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.

transferDisks

public abstract void transferDisks(Context context)

Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

unClaim

public abstract void unClaim()

Release ownership of an existing virtual machine This operation can take a while to complete.

unClaim

public abstract void unClaim(Context context)

Release ownership of an existing virtual machine This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

uniqueIdentifier

public abstract String uniqueIdentifier()

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

Returns:

the uniqueIdentifier value.

update

public abstract LabVirtualMachine.Update update()

Begins update for the LabVirtualMachine resource.

Returns:

the stage of resource update.

username

public abstract String username()

Gets the username property: The user name of the virtual machine.

Returns:

the username value.

virtualMachineCreationSource

public abstract VirtualMachineCreationSource virtualMachineCreationSource()

Gets the virtualMachineCreationSource property: Tells source of creation of lab virtual machine. Output property only.

Returns:

the virtualMachineCreationSource value.