com.azure.resourcemanager.compute.models

Interface VirtualMachine

All Superinterfaces:

GroupableResource<ComputeManager,VirtualMachineInner>, HasId, HasInnerModel<InnerT>, HasManager<TManager>, HasName, HasNetworkInterfaces, HasResourceGroup, Indexable, Refreshable<VirtualMachine>, Resource, Updatable<VirtualMachine.Update>

public interface VirtualMachine
extends GroupableResource<ComputeManager,VirtualMachineInner>, Refreshable<VirtualMachine>, Updatable<VirtualMachine.Update>, HasNetworkInterfaces

An immutable client-side representation of an Azure virtual machine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VirtualMachine.DefinitionManaged The entirety of the managed disk based virtual machine definition.
static interface	VirtualMachine.DefinitionManagedOrUnmanaged The entirety of the virtual machine definition.
static interface	VirtualMachine.DefinitionShared The virtual machine scale set stages shared between managed and unmanaged based virtual machine definitions.
static interface	VirtualMachine.DefinitionStages Grouping of virtual machine definition stages.
static interface	VirtualMachine.DefinitionUnmanaged The entirety of the unmanaged disk based virtual machine definition.
static interface	VirtualMachine.Update The template for an update operation, containing all the settings that can be modified.
static interface	VirtualMachine.UpdateStages Grouping of virtual machine update stages.

Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

Method Summary

Modifier and Type	Method and Description
String	availabilitySetId()
Set<AvailabilityZoneId>	availabilityZones()
com.azure.core.http.rest.PagedIterable<VirtualMachineSize>	availableSizes() Lists all available virtual machine sizes this virtual machine can resized to.
BillingProfile	billingProfile()
String	bootDiagnosticsStorageUri()
String	capture(String containerName, String vhdPrefix, boolean overwriteVhd) Captures the virtual machine by copying virtual hard disks of the VM.
Mono<String>	captureAsync(String containerName, String vhdPrefix, boolean overwriteVhd) Captures the virtual machine by copying virtual hard disks of the VM asynchronously.
String	computerName()
void	convertToManaged() Converts (migrates) the virtual machine with un-managed disks to use managed disk.
Mono<Void>	convertToManagedAsync() Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.
Map<Integer,VirtualMachineDataDisk>	dataDisks()
void	deallocate() Shuts down the virtual machine and releases the compute resources.
Mono<Void>	deallocateAsync() Shuts down the virtual machine and releases the compute resources asynchronously.
DiagnosticsProfile	diagnosticsProfile()
VirtualMachineEncryption	diskEncryption()
VirtualMachineEvictionPolicyTypes	evictionPolicy()
void	generalize() Generalizes the virtual machine.
Mono<Void>	generalizeAsync() Generalizes the virtual machine asynchronously.
PublicIpAddress	getPrimaryPublicIPAddress() Gets the public IP address associated with this virtual machine's primary network interface.
String	getPrimaryPublicIPAddressId()
VirtualMachineInstanceView	instanceView() Get the virtual machine instance view.
boolean	isBootDiagnosticsEnabled()
boolean	isManagedDiskEnabled()
boolean	isManagedServiceIdentityEnabled()
String	licenseType()
Map<String,VirtualMachineExtension>	listExtensions()
Mono<List<VirtualMachineExtension>>	listExtensionsAsync()
ResourceIdentityType	managedServiceIdentityType()
CachingTypes	osDiskCachingType()
String	osDiskId()
int	osDiskSize()
StorageAccountTypes	osDiskStorageAccountType()
OSProfile	osProfile()
OperatingSystemTypes	osType()
String	osUnmanagedDiskVhdUri()
Plan	plan()
void	powerOff() Powers off (stops) the virtual machine.
Mono<Void>	powerOffAsync() Powers off (stops) the virtual machine asynchronously.
PowerState	powerState()
VirtualMachinePriorityTypes	priority()
String	provisioningState()
ProximityPlacementGroup	proximityPlacementGroup() Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
void	redeploy() Redeploys the virtual machine.
Mono<Void>	redeployAsync() Redeploys the virtual machine asynchronously.
VirtualMachineInstanceView	refreshInstanceView() Refreshes the virtual machine instance view to sync with Azure.
Mono<VirtualMachineInstanceView>	refreshInstanceViewAsync() Refreshes the virtual machine instance view to sync with Azure.
void	restart() Restarts the virtual machine.
Mono<Void>	restartAsync() Restarts the virtual machine asynchronously.
RunCommandResult	runCommand(RunCommandInput inputCommand) Run commands in the virtual machine.
Mono<RunCommandResult>	runCommandAsync(RunCommandInput inputCommand) Run commands in the virtual machine asynchronously.
RunCommandResult	runPowerShellScript(List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in a virtual machine.
Mono<RunCommandResult>	runPowerShellScriptAsync(List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in the virtual machine asynchronously.
RunCommandResult	runShellScript(List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in the virtual machine.
Mono<RunCommandResult>	runShellScriptAsync(List<String> scriptLines, List<RunCommandInputParameter> scriptParameters) Run shell script in the virtual machine asynchronously.
void	simulateEviction() Simulates the eviction of spot virtual machine.
Mono<Void>	simulateEvictionAsync() Simulates the eviction of spot virtual machine asynchronously.
VirtualMachineSizeTypes	size()
void	start() Starts the virtual machine.
Mono<Void>	startAsync() Starts the virtual machine asynchronously.
StorageProfile	storageProfile() Returns the storage profile of an Azure virtual machine.
String	systemAssignedManagedServiceIdentityPrincipalId()
String	systemAssignedManagedServiceIdentityTenantId()
Map<Integer,VirtualMachineUnmanagedDataDisk>	unmanagedDataDisks()
Set<String>	userAssignedManagedServiceIdentityIds()
String	vmId()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.azure.resourcemanager.network.models.HasNetworkInterfaces

getPrimaryNetworkInterface, networkInterfaceIds, primaryNetworkInterfaceId

Method Detail

deallocate

void deallocate()

Shuts down the virtual machine and releases the compute resources.

deallocateAsync

Mono<Void> deallocateAsync()

Shuts down the virtual machine and releases the compute resources asynchronously.

Returns:

a representation of the deferred computation of this call

generalize

void generalize()

Generalizes the virtual machine.

generalizeAsync

Mono<Void> generalizeAsync()

Generalizes the virtual machine asynchronously.

Returns:

a representation of the deferred computation of this call

powerOff

void powerOff()

Powers off (stops) the virtual machine.

powerOffAsync

Mono<Void> powerOffAsync()

Powers off (stops) the virtual machine asynchronously.

Returns:

a representation of the deferred computation of this call

restart

void restart()

Restarts the virtual machine.

restartAsync

Mono<Void> restartAsync()

Restarts the virtual machine asynchronously.

Returns:

a representation of the deferred computation of this call

start

void start()

Starts the virtual machine.

startAsync

Mono<Void> startAsync()

Starts the virtual machine asynchronously.

Returns:

a representation of the deferred computation of this call

redeploy

void redeploy()

Redeploys the virtual machine.

redeployAsync

Mono<Void> redeployAsync()

Redeploys the virtual machine asynchronously.

Returns:

a representation of the deferred computation of this call

simulateEviction

void simulateEviction()

Simulates the eviction of spot virtual machine. The eviction will occur with 30 minutes after calling this API.

simulateEvictionAsync

Mono<Void> simulateEvictionAsync()

Simulates the eviction of spot virtual machine asynchronously. The eviction will occur with 30 minutes after calling this API.

Returns:

a representation of the deferred computation of this call

diskEncryption

VirtualMachineEncryption diskEncryption()

Returns:

entry point to enabling, disabling and querying disk encryption

convertToManaged

void convertToManaged()

Converts (migrates) the virtual machine with un-managed disks to use managed disk.

convertToManagedAsync

Mono<Void> convertToManagedAsync()

Converts (migrates) the virtual machine with un-managed disks to use managed disk asynchronously.

Returns:

a representation of the deferred computation of this call

availableSizes

com.azure.core.http.rest.PagedIterable<VirtualMachineSize> availableSizes()

Lists all available virtual machine sizes this virtual machine can resized to.

Returns:

the virtual machine sizes

capture

String capture(String containerName,
               String vhdPrefix,
               boolean overwriteVhd)

Captures the virtual machine by copying virtual hard disks of the VM.

Parameters:

containerName - destination container name to store the captured VHD

vhdPrefix - the prefix for the VHD holding captured image

overwriteVhd - whether to overwrites destination VHD if it exists

Returns:

the JSON template for creating more such virtual machines

captureAsync

Mono<String> captureAsync(String containerName,
                          String vhdPrefix,
                          boolean overwriteVhd)

Captures the virtual machine by copying virtual hard disks of the VM asynchronously.

Parameters:

containerName - destination container name to store the captured VHD

vhdPrefix - the prefix for the VHD holding captured image

overwriteVhd - whether to overwrites destination VHD if it exists

Returns:

a representation of the deferred computation of this call

refreshInstanceView

VirtualMachineInstanceView refreshInstanceView()

Refreshes the virtual machine instance view to sync with Azure.

The instance view will be cached for later retrieval using instanceView.

Returns:

the refreshed instance view

refreshInstanceViewAsync

Mono<VirtualMachineInstanceView> refreshInstanceViewAsync()

Refreshes the virtual machine instance view to sync with Azure.

Returns:

an observable that emits the instance view of the virtual machine.

runPowerShellScript

RunCommandResult runPowerShellScript(List<String> scriptLines,
                                     List<RunCommandInputParameter> scriptParameters)

Run shell script in a virtual machine.

Parameters:

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

result of PowerShell script execution

runPowerShellScriptAsync

Mono<RunCommandResult> runPowerShellScriptAsync(List<String> scriptLines,
                                                List<RunCommandInputParameter> scriptParameters)

Run shell script in the virtual machine asynchronously.

Parameters:

scriptLines - PowerShell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runShellScript

RunCommandResult runShellScript(List<String> scriptLines,
                                List<RunCommandInputParameter> scriptParameters)

Run shell script in the virtual machine.

Parameters:

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

result of shell script execution

runShellScriptAsync

Mono<RunCommandResult> runShellScriptAsync(List<String> scriptLines,
                                           List<RunCommandInputParameter> scriptParameters)

Run shell script in the virtual machine asynchronously.

Parameters:

scriptLines - shell script lines

scriptParameters - script parameters

Returns:

handle to the asynchronous execution

runCommand

RunCommandResult runCommand(RunCommandInput inputCommand)

Run commands in the virtual machine.

Parameters:

inputCommand - command input

Returns:

result of execution

runCommandAsync

Mono<RunCommandResult> runCommandAsync(RunCommandInput inputCommand)

Run commands in the virtual machine asynchronously.

Parameters:

inputCommand - command input

Returns:

handle to the asynchronous execution

isManagedDiskEnabled

boolean isManagedDiskEnabled()

Returns:

true if managed disks are used for the virtual machine's disks (OS, data)

computerName

String computerName()

Returns:

name of this virtual machine

size

VirtualMachineSizeTypes size()

Returns:

the virtual machine size

osType

OperatingSystemTypes osType()

Returns:

the operating system of this virtual machine

osUnmanagedDiskVhdUri

String osUnmanagedDiskVhdUri()

Returns:

the URI to the VHD file backing this virtual machine's operating system disk

osDiskCachingType

CachingTypes osDiskCachingType()

Returns:

the operating system disk caching type

osDiskSize

int osDiskSize()

Returns:

the size of the operating system disk in GB

osDiskStorageAccountType

StorageAccountTypes osDiskStorageAccountType()

Returns:

the storage account type of the managed disk backing OS disk

osDiskId

String osDiskId()

Returns:

resource ID of the managed disk backing the OS disk

unmanagedDataDisks

Map<Integer,VirtualMachineUnmanagedDataDisk> unmanagedDataDisks()

Returns:

the unmanaged data disks associated with this virtual machine, indexed by LUN number

dataDisks

Map<Integer,VirtualMachineDataDisk> dataDisks()

Returns:

the managed data disks associated with this virtual machine, indexed by LUN

getPrimaryPublicIPAddress

PublicIpAddress getPrimaryPublicIPAddress()

Gets the public IP address associated with this virtual machine's primary network interface.

Note that this method makes a rest API call to fetch the resource.

Returns:

the public IP of the primary network interface

getPrimaryPublicIPAddressId

String getPrimaryPublicIPAddressId()

Returns:

the resource ID of the public IP address associated with this virtual machine's primary network interface

availabilitySetId

String availabilitySetId()

Returns:

the resource ID of the availability set associated with this virtual machine

provisioningState

String provisioningState()

Returns:

the provisioningState value

licenseType

String licenseType()

Returns:

the licenseType value

proximityPlacementGroup

ProximityPlacementGroup proximityPlacementGroup()

Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Returns:

the proximityPlacementGroup.

listExtensionsAsync

Mono<List<VirtualMachineExtension>> listExtensionsAsync()

Returns:

a representation of the deferred computation of this call, returning extensions attached to the virtual machine

listExtensions

Map<String,VirtualMachineExtension> listExtensions()

Returns:

extensions attached to the virtual machine

plan

Plan plan()

Returns:

the plan value

storageProfile

StorageProfile storageProfile()

Returns the storage profile of an Azure virtual machine.

Returns:

the storageProfile value

osProfile

OSProfile osProfile()

Returns:

the operating system profile

diagnosticsProfile

DiagnosticsProfile diagnosticsProfile()

Returns:

the diagnostics profile

vmId

String vmId()

Returns:

the virtual machine unique ID.

powerState

PowerState powerState()

Returns:

the power state of the virtual machine

instanceView

VirtualMachineInstanceView instanceView()

Get the virtual machine instance view.

The instance view will be cached for later retrieval using instanceView.

Returns:

the virtual machine's instance view

availabilityZones

Set<AvailabilityZoneId> availabilityZones()

Returns:

the availability zones assigned to the virtual machine

isBootDiagnosticsEnabled

boolean isBootDiagnosticsEnabled()

Returns:

true if boot diagnostics is enabled for the virtual machine

bootDiagnosticsStorageUri

String bootDiagnosticsStorageUri()

Returns:

the storage blob endpoint uri if boot diagnostics is enabled for the virtual machine

isManagedServiceIdentityEnabled

boolean isManagedServiceIdentityEnabled()

Returns:

true if Managed Service Identity is enabled for the virtual machine

systemAssignedManagedServiceIdentityTenantId

String systemAssignedManagedServiceIdentityTenantId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the virtual machine.

systemAssignedManagedServiceIdentityPrincipalId

String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the virtual machine.

managedServiceIdentityType

ResourceIdentityType managedServiceIdentityType()

Returns:

the type of Managed Service Identity used for the virtual machine.

userAssignedManagedServiceIdentityIds

Set<String> userAssignedManagedServiceIdentityIds()

Returns:

the resource ids of User Assigned Managed Service Identities associated with the virtual machine.

priority

VirtualMachinePriorityTypes priority()

Returns:

the priority for the virtual machine.

evictionPolicy

VirtualMachineEvictionPolicyTypes evictionPolicy()

Returns:

the eviction policy for the virtual machine.

billingProfile

BillingProfile billingProfile()

Returns:

the billing related details of a low priority virtual machine