com.microsoft.azure.management.compute

Interface VirtualMachine

All Superinterfaces:

com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource, com.microsoft.azure.management.network.model.HasNetworkInterfaces, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<VirtualMachine>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource, com.microsoft.azure.management.resources.fluentcore.model.Updatable<VirtualMachine.Update>, com.microsoft.azure.management.resources.fluentcore.model.Wrapper<com.microsoft.azure.management.compute.implementation.VirtualMachineInner>

public interface VirtualMachine
extends com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<VirtualMachine>, com.microsoft.azure.management.resources.fluentcore.model.Wrapper<com.microsoft.azure.management.compute.implementation.VirtualMachineInner>, com.microsoft.azure.management.resources.fluentcore.model.Updatable<VirtualMachine.Update>, com.microsoft.azure.management.network.model.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.Definition The entirety of the virtual machine definition.
static interface	VirtualMachine.DefinitionStages Grouping of virtual machine definition stages.
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.microsoft.azure.management.resources.fluentcore.arm.models.Resource

com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Method Summary

Methods

Modifier and Type	Method and Description
String	availabilitySetId() Returns id to the availability set this virtual machine associated with.
com.microsoft.azure.PagedList<VirtualMachineSize>	availableSizes() List of all available virtual machine sizes this virtual machine can resized to.
String	capture(String containerName, boolean overwriteVhd) Captures the virtual machine by copying virtual hard disks of the VM and returns template as json string that can be used to create similar VMs.
String	computerName()
List<VirtualMachineDataDisk>	dataDisks()
void	deallocate() Shuts down the Virtual Machine and releases the compute resources.
DiagnosticsProfile	diagnosticsProfile() Returns the diagnostics profile of an Azure virtual machine.
Map<String,VirtualMachineExtension>	extensions()
void	generalize() Generalize the Virtual Machine.
com.microsoft.azure.management.network.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.
String	licenseType()
CachingTypes	osDiskCachingType()
int	osDiskSize()
String	osDiskVhdUri()
OSProfile	osProfile() Gets the operating system profile of an Azure virtual machine.
OperatingSystemTypes	osType()
Plan	plan()
void	powerOff() Power off (stop) the virtual machine.
PowerState	powerState()
String	provisioningState()
void	redeploy() Redeploy the virtual machine.
VirtualMachineInstanceView	refreshInstanceView() Refreshes the virtual machine instance view to sync with Azure.
void	restart() Restart the virtual machine.
VirtualMachineSizeTypes	size()
void	start() Start the virtual machine.
StorageProfile	storageProfile() Returns the storage profile of an Azure virtual machine.
String	vmId()

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource

resourceGroupName

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

id, name, region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Wrapper

inner, setInner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.microsoft.azure.management.network.model.HasNetworkInterfaces

getPrimaryNetworkInterface, networkInterfaceIds, primaryNetworkInterfaceId

Method Detail

deallocate

void deallocate()

Shuts down the Virtual Machine and releases the compute resources.

You are not billed for the compute resources that this Virtual Machine uses

generalize

void generalize()

Generalize the Virtual Machine.

powerOff

void powerOff()

Power off (stop) the virtual machine.

You will be billed for the compute resources that this Virtual Machine uses.

restart

void restart()

Restart the virtual machine. =

start

void start()

Start the virtual machine.

redeploy

void redeploy()

Redeploy the virtual machine.

availableSizes

com.microsoft.azure.PagedList<VirtualMachineSize> availableSizes()

List of all available virtual machine sizes this virtual machine can resized to.

Returns:

the virtual machine sizes

capture

String capture(String containerName,
             boolean overwriteVhd)

Captures the virtual machine by copying virtual hard disks of the VM and returns template as json string that can be used to create similar VMs.

Parameters:

containerName - destination container name to store the captured Vhd

overwriteVhd - whether to overwrites destination vhd if it exists

Returns:

the template as json string

refreshInstanceView

VirtualMachineInstanceView refreshInstanceView()

Refreshes the virtual machine instance view to sync with Azure.

this will caches the instance view which can be later retrieved using instanceView().

Returns:

the refreshed instance view

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

osDiskVhdUri

String osDiskVhdUri()

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, valid values are 'None', 'ReadOnly', 'ReadWrite'

osDiskSize

int osDiskSize()

Returns:

the size of the operating system disk in GB

dataDisks

List<VirtualMachineDataDisk> dataDisks()

Returns:

the list of data disks attached to this virtual machine

getPrimaryPublicIpAddress

com.microsoft.azure.management.network.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 id to the availability set this virtual machine associated with.

Having a set of virtual machines in an availability set ensures that during maintenance event at least one virtual machine will be available.

Returns:

the availabilitySet reference id

provisioningState

String provisioningState()

Returns:

the provisioningState value

licenseType

String licenseType()

Returns:

the licenseType value

extensions

Map<String,VirtualMachineExtension> extensions()

Returns:

the extensions attached to the Azure Virtual Machine

plan

Plan plan()

Returns:

the plan value

storageProfile

StorageProfile storageProfile()

Returns the storage profile of an Azure virtual machine.

The storage profile contains information such as the details of the VM image or user image from which this virtual machine is created, the Azure storage account where the operating system disk is stored, details of the data disk attached to the virtual machine.

Returns:

the storageProfile value

osProfile

OSProfile osProfile()

Gets the operating system profile of an Azure virtual machine.

Returns:

the osProfile value

diagnosticsProfile

DiagnosticsProfile diagnosticsProfile()

Returns the diagnostics profile of an Azure virtual machine.

Enabling diagnostic features in a virtual machine enable you to easily diagnose and recover virtual machine from boot failures.

Returns:

the diagnosticsProfile value

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.

this method returns the cached instance view, to refresh the cache call refreshInstanceView().

Returns:

the virtual machine instance view