VirtualMachineScaleSetVM Interface

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.45.0

Implements

ChildResource<VirtualMachineScaleSet> Resource HasInnerModel<VirtualMachineScaleSetVMInner> Refreshable<VirtualMachineScaleSetVM> Updatable<Update>

public interface VirtualMachineScaleSetVM
extends Resource, ChildResource<VirtualMachineScaleSet>, Refreshable<VirtualMachineScaleSetVM>, Updatable<Update>, HasInnerModel<VirtualMachineScaleSetVMInner>

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
abstract String	administratorUserName()
abstract String	availabilitySetId()
abstract boolean	bootDiagnosticEnabled()
abstract String	bootDiagnosticStorageAccountUri()
abstract String	computerName()
abstract Map<Integer,VirtualMachineDataDisk>	dataDisks()
abstract void	deallocate() Shuts down the virtual machine instance and releases the associated compute resources.
abstract Mono<Void>	deallocateAsync() Shuts down the virtual machine instance and releases the associated compute resources.
abstract void	delete() Deletes the virtual machine instance.
abstract Mono<Void>	deleteAsync() Deletes the virtual machine instance.
abstract DiagnosticsProfile	diagnosticsProfile()
abstract Map<String,VirtualMachineScaleSetVMInstanceExtension>	extensions()
abstract VirtualMachineScaleSetNetworkInterface	getNetworkInterface(String name) Gets a network interface associated with this virtual machine instance.
abstract Mono<VirtualMachineScaleSetNetworkInterface>	getNetworkInterfaceAsync(String name) Gets a network interface associated with this virtual machine instance.
abstract VirtualMachineCustomImage	getOSCustomImage()
abstract VirtualMachineImage	getOSPlatformImage()
abstract String	instanceId()
abstract VirtualMachineInstanceView	instanceView() Gets the instance view of the virtual machine instance.
abstract boolean	isLatestScaleSetUpdateApplied()
abstract boolean	isLinuxPasswordAuthenticationEnabled()
abstract boolean	isManagedDiskEnabled()
abstract boolean	isOSBasedOnCustomImage()
abstract boolean	isOSBasedOnPlatformImage()
abstract boolean	isOSBasedOnStoredImage()
abstract boolean	isWindowsAutoUpdateEnabled()
abstract boolean	isWindowsVMAgentProvisioned()
abstract PagedIterable<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfaces()
abstract PagedFlux<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfacesAsync()
abstract String	modelDefinitionApplied()
abstract List<String>	networkInterfaceIds()
abstract VirtualMachineScaleSetVMNetworkProfileConfiguration	networkProfileConfiguration()
abstract CachingTypes	osDiskCachingType()
abstract String	osDiskId()
abstract String	osDiskName()
abstract int	osDiskSizeInGB()
abstract OSProfile	osProfile()
abstract OperatingSystemTypes	osType()
abstract String	osUnmanagedDiskVhdUri()
abstract ImageReference	platformImageReference()
abstract void	powerOff() Stops the virtual machine instance.
abstract void	powerOff(boolean skipShutdown) Stops the virtual machine instance.
abstract Mono<Void>	powerOffAsync() Stops the virtual machine instance.
abstract Mono<Void>	powerOffAsync(boolean skipShutdown) Stops the virtual machine instances.
abstract PowerState	powerState()
abstract String	primaryNetworkInterfaceId()
abstract VirtualMachineScaleSetVMProtectionPolicy	protectionPolicy()
abstract void	redeploy() Shuts down the virtual machine instance, move them to new node, and powers them back on.
abstract Mono<Void>	redeployAsync() Shuts down the virtual machine instance, move them to new node, and powers them back on.
abstract VirtualMachineInstanceView	refreshInstanceView() Refreshes the instance view.
abstract Mono<VirtualMachineInstanceView>	refreshInstanceViewAsync() Refreshes the instance view.
abstract void	reimage() Updates the version of the installed operating system in the virtual machine instance.
abstract Mono<Void>	reimageAsync() Updates the version of the installed operating system in the virtual machine instance.
abstract void	restart() Restarts the virtual machine instance.
abstract Mono<Void>	restartAsync() Restarts the virtual machine instance.
abstract VirtualMachineSizeTypes	size()
abstract Sku	sku()
abstract void	start() Starts the virtual machine instance.
abstract Mono<Void>	startAsync() Starts the virtual machine instance.
abstract StorageProfile	storageProfile()
abstract String	storedImageUnmanagedVhdUri()
abstract OffsetDateTime	timeCreated()
abstract Map<Integer,VirtualMachineUnmanagedDataDisk>	unmanagedDataDisks()
abstract String	windowsTimeZone()

Method Details

administratorUserName

public abstract String administratorUserName()

Returns:

the name of the admin user

availabilitySetId

public abstract String availabilitySetId()

Returns:

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

bootDiagnosticEnabled

public abstract boolean bootDiagnosticEnabled()

Returns:

true if the boot diagnostic is enabled, false otherwise

bootDiagnosticStorageAccountUri

public abstract String bootDiagnosticStorageAccountUri()

Returns:

the URI to the storage account storing boot diagnostics log

computerName

public abstract String computerName()

Returns:

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

dataDisks

public abstract Map dataDisks()

Returns:

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

deallocate

public abstract void deallocate()

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

deallocateAsync

public abstract Mono 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 abstract void delete()

Deletes the virtual machine instance.

deleteAsync

public abstract Mono deleteAsync()

Deletes the virtual machine instance.

Returns:

a representation of the deferred computation of this call

diagnosticsProfile

public abstract DiagnosticsProfile diagnosticsProfile()

Returns:

the diagnostics profile of the virtual machine instance

extensions

public abstract Map extensions()

Returns:

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

getNetworkInterface

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

getNetworkInterfaceAsync

public abstract Mono getNetworkInterfaceAsync(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 abstract VirtualMachineCustomImage getOSCustomImage()

Returns:

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

getOSPlatformImage

public abstract VirtualMachineImage getOSPlatformImage()

Returns:

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

instanceId

public abstract String instanceId()

Returns:

the instance ID assigned to this virtual machine instance

instanceView

public abstract VirtualMachineInstanceView instanceView()

Gets the instance view of the virtual machine instance.

To get the latest instance view use refreshInstanceView().

Returns:

the instance view

isLatestScaleSetUpdateApplied

public abstract boolean isLatestScaleSetUpdateApplied()

Returns:

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

isLinuxPasswordAuthenticationEnabled

public abstract boolean isLinuxPasswordAuthenticationEnabled()

Returns:

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

isManagedDiskEnabled

public abstract boolean isManagedDiskEnabled()

Returns:

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

isOSBasedOnCustomImage

public abstract boolean isOSBasedOnCustomImage()

Returns:

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

isOSBasedOnPlatformImage

public abstract boolean isOSBasedOnPlatformImage()

Returns:

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

isOSBasedOnStoredImage

public abstract boolean isOSBasedOnStoredImage()

Returns:

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

isWindowsAutoUpdateEnabled

public abstract boolean isWindowsAutoUpdateEnabled()

Returns:

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

isWindowsVMAgentProvisioned

public abstract boolean isWindowsVMAgentProvisioned()

Returns:

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

listNetworkInterfaces

public abstract PagedIterable listNetworkInterfaces()

Returns:

the network interfaces associated with this virtual machine instance.

listNetworkInterfacesAsync

public abstract PagedFlux listNetworkInterfacesAsync()

Returns:

the network interfaces associated with this virtual machine instance.

modelDefinitionApplied

public abstract String modelDefinitionApplied()

Returns:

Get specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.

networkInterfaceIds

public abstract List networkInterfaceIds()

Returns:

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

networkProfileConfiguration

public abstract VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration()

Returns:

The network profile config for the vm.

osDiskCachingType

public abstract CachingTypes osDiskCachingType()

Returns:

the caching type of the operating system disk

osDiskId

public abstract String osDiskId()

Returns:

resource ID of the managed disk backing OS disk

osDiskName

public abstract String osDiskName()

Returns:

the name of the operating system disk

osDiskSizeInGB

public abstract int osDiskSizeInGB()

Returns:

the size of the operating system disk

osProfile

public abstract OSProfile osProfile()

Returns:

the operating system profile of an virtual machine instance

osType

public abstract OperatingSystemTypes osType()

Returns:

the operating system type

osUnmanagedDiskVhdUri

public abstract String osUnmanagedDiskVhdUri()

Returns:

VHD URI to the operating system disk

platformImageReference

public abstract 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 abstract void powerOff()

Stops the virtual machine instance.

powerOff

public abstract void powerOff(boolean skipShutdown)

Stops the virtual machine instance.

Parameters:

skipShutdown - power off without graceful shutdown

powerOffAsync

public abstract Mono powerOffAsync()

Stops the virtual machine instance.

Returns:

a representation of the deferred computation of this call

powerOffAsync

public abstract Mono powerOffAsync(boolean skipShutdown)

Stops the virtual machine instances.

Parameters:

skipShutdown - power off without graceful shutdown

Returns:

a representation of the deferred computation of this call.

powerState

public abstract PowerState powerState()

Returns:

the power state of the virtual machine instance

primaryNetworkInterfaceId

public abstract String primaryNetworkInterfaceId()

Returns:

resource ID of primary network interface associated with virtual machine instance

protectionPolicy

public abstract VirtualMachineScaleSetVMProtectionPolicy protectionPolicy()

Returns:

The specific protection policy for the vm.

redeploy

public abstract void redeploy()

Shuts down the virtual machine instance, move them to new node, and powers them back on.

redeployAsync

public abstract Mono redeployAsync()

Shuts down the virtual machine instance, move them to new node, and powers them back on.

Returns:

a representation of the deferred computation of this call

refreshInstanceView

public abstract VirtualMachineInstanceView refreshInstanceView()

Refreshes the instance view.

Returns:

the instance view

refreshInstanceViewAsync

public abstract Mono refreshInstanceViewAsync()

Refreshes the instance view.

Returns:

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

reimage

public abstract void reimage()

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

reimageAsync

public abstract Mono 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 abstract void restart()

Restarts the virtual machine instance.

restartAsync

public abstract Mono restartAsync()

Restarts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

size

public abstract VirtualMachineSizeTypes size()

Returns:

virtual machine instance size

sku

public abstract 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 abstract void start()

Starts the virtual machine instance.

startAsync

public abstract Mono startAsync()

Starts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

storageProfile

public abstract StorageProfile storageProfile()

Returns:

the storage profile of the virtual machine instance

storedImageUnmanagedVhdUri

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

timeCreated

public abstract OffsetDateTime timeCreated()

Returns:

the time at which the Virtual Machine resource was created

unmanagedDataDisks

public abstract Map unmanagedDataDisks()

Returns:

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

windowsTimeZone

public abstract String windowsTimeZone()

Returns:

the time zone of the Windows virtual machine