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