VirtualMachineScaleSetVM Interface

Package:

com.microsoft.azure.management.compute

public interface VirtualMachineScaleSetVM extends Resource,ChildResource,Refreshable,HasInner

An immutable client-side representation of a virtual machine instance in an Azure virtual machine scale set.

Method Summary

Modifier and Type	Method and Description
String	administratorUserName()
String	availabilitySetId()
boolean	bootDiagnosticEnabled()
String	bootDiagnosticStorageAccountUri()
String	computerName()
Map<Integer, VirtualMachineDataDisk>	dataDisks()
void	deallocate() Shuts down the virtual machine instance and releases the associated compute resources.
Completable	deallocateAsync() Shuts down the virtual machine instance and releases the associated compute resources.
void	delete() Deletes the virtual machine instance.
Completable	deleteAsync() Deletes the virtual machine instance.
DiagnosticsProfile	diagnosticsProfile()
Map<String, VirtualMachineScaleSetVMInstanceExtension>	extensions()
VirtualMachineScaleSetNetworkInterface	getNetworkInterface(String name) Gets a network interface associated with this virtual machine instance.
VirtualMachineCustomImage	getOSCustomImage()
VirtualMachineImage	getOSPlatformImage()
String	instanceId()
VirtualMachineInstanceView	instanceView() Gets the instance view of the virtual machine instance. To get the latest instance view use .
boolean	isLatestScaleSetUpdateApplied()
boolean	isLinuxPasswordAuthenticationEnabled()
boolean	isManagedDiskEnabled()
boolean	isOSBasedOnCustomImage()
boolean	isOSBasedOnPlatformImage()
boolean	isOSBasedOnStoredImage()
boolean	isWindowsAutoUpdateEnabled()
boolean	isWindowsVMAgentProvisioned()
PagedList<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfaces()
List<String>	networkInterfaceIds()
CachingTypes	osDiskCachingType()
String	osDiskId()
String	osDiskName()
int	osDiskSizeInGB()
OSProfile	osProfile()
OperatingSystemTypes	osType()
String	osUnmanagedDiskVhdUri()
ImageReference	platformImageReference()
void	powerOff() Stops the virtual machine instance.
Completable	powerOffAsync() Stops the virtual machine instance.
PowerState	powerState()
String	primaryNetworkInterfaceId()
VirtualMachineInstanceView	refreshInstanceView() Refreshes the instance view.
Observable<VirtualMachineInstanceView>	refreshInstanceViewAsync() Refreshes the instance view.
void	reimage() Updates the version of the installed operating system in the virtual machine instance.
Completable	reimageAsync() Updates the version of the installed operating system in the virtual machine instance.
void	restart() Restarts the virtual machine instance.
Completable	restartAsync() Restarts the virtual machine instance.
VirtualMachineSizeTypes	size()
Sku	sku()
void	start() Starts the virtual machine instance.
Completable	startAsync() Starts the virtual machine instance.
StorageProfile	storageProfile()
String	storedImageUnmanagedVhdUri()
Map<Integer, VirtualMachineUnmanagedDataDisk>	unmanagedDataDisks()
String	windowsTimeZone()

Inherited Members

HasId.id() HasInner<T>.inner() Indexable.key() HasName.name() HasParent<ParentT>.parent() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() Resource.tags() Resource.type()

Method Details

administratorUserName

public String administratorUserName()

Returns:

the name of the admin user

availabilitySetId

public String availabilitySetId()

Returns:

the resource ID of the availability set that this virtual machine instance belongs to

bootDiagnosticEnabled

public boolean bootDiagnosticEnabled()

Returns:

true if the boot diagnostic is enabled, false otherwise

bootDiagnosticStorageAccountUri

public String bootDiagnosticStorageAccountUri()

Returns:

the URI to the storage account storing boot diagnostics log

computerName

public String computerName()

Returns:

the virtual machine instance computer name with the VM scale set prefix.

dataDisks

public Map dataDisks()

Returns:

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

deallocate

public void deallocate()

Shuts down the virtual machine instance and releases the associated compute resources.

deallocateAsync

public Completable deallocateAsync()

Shuts down the virtual machine instance and releases the associated compute resources.

Returns:

a representation of the deferred computation of this call

delete

public void delete()

Deletes the virtual machine instance.

deleteAsync

public Completable deleteAsync()

Deletes the virtual machine instance.

Returns:

a representation of the deferred computation of this call

diagnosticsProfile

public DiagnosticsProfile diagnosticsProfile()

Returns:

the diagnostics profile of the virtual machine instance

extensions

public Map extensions()

Returns:

the extensions associated with the virtual machine instance, indexed by name

getNetworkInterface

public VirtualMachineScaleSetNetworkInterface getNetworkInterface(String name)

Gets a network interface associated with this virtual machine instance.

Parameters:

name - the name of the network interface

Returns:

the network interface

getOSCustomImage

public VirtualMachineCustomImage getOSCustomImage()

Returns:

the custom image that the virtual machine instance operating system is based on, null be returned otherwise

getOSPlatformImage

public VirtualMachineImage getOSPlatformImage()

Returns:

the platform image that the virtual machine instance operating system is based on, null be returned otherwise

instanceId

public String instanceId()

Returns:

the instance ID assigned to this virtual machine instance

instanceView

public VirtualMachineInstanceView instanceView()

Gets the instance view of the virtual machine instance.

To get the latest instance view use .

Returns:

the instance view

isLatestScaleSetUpdateApplied

public boolean isLatestScaleSetUpdateApplied()

Returns:

true if the latest scale set model changes are applied to the virtual machine instance

isLinuxPasswordAuthenticationEnabled

public boolean isLinuxPasswordAuthenticationEnabled()

Returns:

true if this is a Linux virtual machine and password based login is enabled, false otherwise

isManagedDiskEnabled

public boolean isManagedDiskEnabled()

Returns:

true if managed disk is used for the virtual machine's disks (os, data)

isOSBasedOnCustomImage

public boolean isOSBasedOnCustomImage()

Returns:

true if the operating system of the virtual machine instance is based on custom image

isOSBasedOnPlatformImage

public boolean isOSBasedOnPlatformImage()

Returns:

true if the operating system of the virtual machine instance is based on platform image

isOSBasedOnStoredImage

public boolean isOSBasedOnStoredImage()

Returns:

true if the operating system of the virtual machine instance is based on stored image

isWindowsAutoUpdateEnabled

public boolean isWindowsAutoUpdateEnabled()

Returns:

true if this is a Windows virtual machine and automatic update is turned on, false otherwise

isWindowsVMAgentProvisioned

public boolean isWindowsVMAgentProvisioned()

Returns:

true if this is a Windows virtual machine and VM agent is provisioned, false otherwise

listNetworkInterfaces

public PagedList listNetworkInterfaces()

Returns:

the network interfaces associated with this virtual machine instance.

networkInterfaceIds

public List networkInterfaceIds()

Returns:

the list of resource ID of network interface associated with the virtual machine instance

osDiskCachingType

public CachingTypes osDiskCachingType()

Returns:

the caching type of the operating system disk

osDiskId

public String osDiskId()

Returns:

resource ID of the managed disk backing OS disk

osDiskName

public String osDiskName()

Returns:

the name of the operating system disk

osDiskSizeInGB

public int osDiskSizeInGB()

Returns:

the size of the operating system disk

osProfile

public OSProfile osProfile()

Returns:

the operating system profile of an virtual machine instance

osType

public OperatingSystemTypes osType()

Returns:

the operating system type

osUnmanagedDiskVhdUri

public String osUnmanagedDiskVhdUri()

Returns:

VHD URI to the operating system disk

platformImageReference

public ImageReference platformImageReference()

Returns:

reference to the platform image that the virtual machine instance operating system is based on, null will be returned if the operating system is based on custom image

powerOff

public void powerOff()

Stops the virtual machine instance.

powerOffAsync

public Completable powerOffAsync()

Stops the virtual machine instance.

Returns:

a representation of the deferred computation of this call

powerState

public PowerState powerState()

Returns:

the power state of the virtual machine instance

primaryNetworkInterfaceId

public String primaryNetworkInterfaceId()

Returns:

resource ID of primary network interface associated with virtual machine instance

refreshInstanceView

public VirtualMachineInstanceView refreshInstanceView()

Refreshes the instance view.

Returns:

the instance view

refreshInstanceViewAsync

public Observable refreshInstanceViewAsync()

Refreshes the instance view.

Returns:

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

reimage

public void reimage()

Updates the version of the installed operating system in the virtual machine instance.

reimageAsync

public Completable reimageAsync()

Updates the version of the installed operating system in the virtual machine instance.

Returns:

a representation of the deferred computation of this call

restart

public void restart()

Restarts the virtual machine instance.

restartAsync

public Completable restartAsync()

Restarts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

size

public VirtualMachineSizeTypes size()

Returns:

virtual machine instance size

sku

public Sku sku()

Returns:

the SKU of the virtual machine instance, this will be SKU used while creating the parent virtual machine scale set

start

public void start()

Starts the virtual machine instance.

startAsync

public Completable startAsync()

Starts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

storageProfile

public StorageProfile storageProfile()

Returns:

the storage profile of the virtual machine instance

storedImageUnmanagedVhdUri

public String storedImageUnmanagedVhdUri()

Returns:

VHD URI of the custom image that the virtual machine instance operating system is based on, null will be returned if the operating system is based on platform image

unmanagedDataDisks

public Map unmanagedDataDisks()

Returns:

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

windowsTimeZone

public String windowsTimeZone()

Returns:

the time zone of the Windows virtual machine