VirtualMachineScaleSetVM Interface

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.55.1

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() Gets the name of the admin user.
abstract String	availabilitySetId() Gets the resource ID of the availability set that this virtual machine instance belongs to.
abstract boolean	bootDiagnosticEnabled() Checks whether the boot diagnostic is enabled.
abstract String	bootDiagnosticStorageAccountUri() Gets the URI to the storage account storing boot diagnostics log.
abstract String	computerName() Gets the virtual machine instance computer name with the VM scale set prefix.
abstract Map<Integer,VirtualMachineDataDisk>	dataDisks() Gets the managed data disks associated with this virtual machine instance.
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() Gets the diagnostics profile of the virtual machine instance.
abstract Map<String,VirtualMachineScaleSetVMInstanceExtension>	extensions() Gets the extensions associated with the virtual machine instance, indexed by name.
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() Gets the custom image.
abstract VirtualMachineImage	getOSPlatformImage() Gets the platform image.
abstract String	instanceId() Gets the instance ID assigned to this virtual machine instance.
abstract VirtualMachineInstanceView	instanceView() Gets the instance view of the virtual machine instance.
abstract boolean	isLatestScaleSetUpdateApplied() Checks whether the latest scale set model changes are applied to the virtual machine instance.
abstract boolean	isLinuxPasswordAuthenticationEnabled() Checks whether this is a Linux virtual machine and password based login is enabled.
abstract boolean	isManagedDiskEnabled() Checks whether managed disk is used for the virtual machine's disks (os, data).
abstract boolean	isOSBasedOnCustomImage() Checks whether the operating system of the virtual machine instance is based on custom image.
abstract boolean	isOSBasedOnPlatformImage() Checks whether the operating system of the virtual machine instance is based on platform image.
abstract boolean	isOSBasedOnStoredImage() Checks whether the operating system of the virtual machine instance is based on stored image.
abstract boolean	isWindowsAutoUpdateEnabled() Checks whether this is a Windows virtual machine and automatic update is turned on.
abstract boolean	isWindowsVMAgentProvisioned() Checks whether this is a Windows virtual machine and VM agent is provisioned.
abstract PagedIterable<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfaces() Gets the network interfaces associated with this virtual machine instance.
abstract PagedFlux<VirtualMachineScaleSetNetworkInterface>	listNetworkInterfacesAsync() Gets the network interfaces associated with this virtual machine instance.
abstract String	modelDefinitionApplied() Gets applied model from the virtual machine.
abstract List<String>	networkInterfaceIds() Gets the list of resource ID of network interface associated with the virtual machine instance.
abstract VirtualMachineScaleSetVMNetworkProfileConfiguration	networkProfileConfiguration() Gets the network profile config for the vm.
abstract CachingTypes	osDiskCachingType() Gets the caching type of the operating system disk.
abstract String	osDiskId() Gets resource ID of the managed disk backing OS disk.
abstract String	osDiskName() Gets the name of the operating system disk.
abstract int	osDiskSizeInGB() Gets the size of the operating system disk.
abstract OSProfile	osProfile() Gets the operating system profile of an virtual machine instance.
abstract OperatingSystemTypes	osType() Gets the operating system type.
abstract String	osUnmanagedDiskVhdUri() Gets VHD URI to the operating system disk.
abstract ImageReference	platformImageReference() Gets reference to the platform image.
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() Gets the power state of the virtual machine instance.
abstract String	primaryNetworkInterfaceId() Gets resource ID of primary network interface associated with virtual machine instance.
abstract VirtualMachineScaleSetVMProtectionPolicy	protectionPolicy() Gets the specific protection policy for the vm.
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() Gets virtual machine instance size.
abstract Sku	sku() Gets the SKU of the virtual machine instance.
abstract void	start() Starts the virtual machine instance.
abstract Mono<Void>	startAsync() Starts the virtual machine instance.
abstract StorageProfile	storageProfile() Gets the storage profile of the virtual machine instance.
abstract String	storedImageUnmanagedVhdUri() Gets VHD URI of the custom image.
abstract OffsetDateTime	timeCreated() Gets the time at which the Virtual Machine resource was created.
abstract Map<Integer,VirtualMachineUnmanagedDataDisk>	unmanagedDataDisks() Gets the unmanaged data disks associated with this virtual machine instance.
abstract String	windowsTimeZone() Gets the time zone of the Windows virtual machine.

Method Details

administratorUserName

public abstract String administratorUserName()

Gets the name of the admin user.

Returns:

the name of the admin user

availabilitySetId

public abstract String availabilitySetId()

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

Returns:

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

bootDiagnosticEnabled

public abstract boolean bootDiagnosticEnabled()

Checks whether the boot diagnostic is enabled.

Returns:

true if the boot diagnostic is enabled, false otherwise

bootDiagnosticStorageAccountUri

public abstract String bootDiagnosticStorageAccountUri()

Gets the URI to the storage account storing boot diagnostics log.

Returns:

the URI to the storage account storing boot diagnostics log

computerName

public abstract String computerName()

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

Returns:

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

dataDisks

public abstract Map<Integer,VirtualMachineDataDisk> dataDisks()

Gets the managed data disks associated with this virtual machine instance.

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<Void> 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<Void> deleteAsync()

Deletes the virtual machine instance.

Returns:

a representation of the deferred computation of this call

diagnosticsProfile

public abstract DiagnosticsProfile diagnosticsProfile()

Gets the diagnostics profile of the virtual machine instance.

Returns:

the diagnostics profile of the virtual machine instance

extensions

public abstract Map<String,VirtualMachineScaleSetVMInstanceExtension> extensions()

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

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<VirtualMachineScaleSetNetworkInterface> 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()

Gets the custom image.

Returns:

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

getOSPlatformImage

public abstract VirtualMachineImage getOSPlatformImage()

Gets the platform image.

Returns:

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

instanceId

public abstract String instanceId()

Gets the instance ID assigned to this virtual machine instance.

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()

Checks whether the latest scale set model changes are applied to the virtual machine instance.

Returns:

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

isLinuxPasswordAuthenticationEnabled

public abstract boolean isLinuxPasswordAuthenticationEnabled()

Checks whether this is a Linux virtual machine and password based login is enabled.

Returns:

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

isManagedDiskEnabled

public abstract boolean isManagedDiskEnabled()

Checks whether managed disk is used for the virtual machine's disks (os, data).

Returns:

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

isOSBasedOnCustomImage

public abstract boolean isOSBasedOnCustomImage()

Checks whether the operating system of the virtual machine instance is based on custom image.

Returns:

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

isOSBasedOnPlatformImage

public abstract boolean isOSBasedOnPlatformImage()

Checks whether the operating system of the virtual machine instance is based on platform image.

Returns:

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

isOSBasedOnStoredImage

public abstract boolean isOSBasedOnStoredImage()

Checks whether the operating system of the virtual machine instance is based on stored image.

Returns:

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

isWindowsAutoUpdateEnabled

public abstract boolean isWindowsAutoUpdateEnabled()

Checks whether this is a Windows virtual machine and automatic update is turned on.

Returns:

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

isWindowsVMAgentProvisioned

public abstract boolean isWindowsVMAgentProvisioned()

Checks whether this is a Windows virtual machine and VM agent is provisioned.

Returns:

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

listNetworkInterfaces

public abstract PagedIterable<VirtualMachineScaleSetNetworkInterface> listNetworkInterfaces()

Gets the network interfaces associated with this virtual machine instance.

Returns:

the network interfaces associated with this virtual machine instance.

listNetworkInterfacesAsync

public abstract PagedFlux<VirtualMachineScaleSetNetworkInterface> listNetworkInterfacesAsync()

Gets the network interfaces associated with this virtual machine instance.

Returns:

the network interfaces associated with this virtual machine instance.

modelDefinitionApplied

public abstract String modelDefinitionApplied()

Gets applied model from the virtual machine.

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<String> networkInterfaceIds()

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

Returns:

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

networkProfileConfiguration

public abstract VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration()

Gets the network profile config for the vm.

Returns:

The network profile config for the vm.

osDiskCachingType

public abstract CachingTypes osDiskCachingType()

Gets the caching type of the operating system disk.

Returns:

the caching type of the operating system disk

osDiskId

public abstract String osDiskId()

Gets resource ID of the managed disk backing OS disk.

Returns:

resource ID of the managed disk backing OS disk

osDiskName

public abstract String osDiskName()

Gets the name of the operating system disk.

Returns:

the name of the operating system disk

osDiskSizeInGB

public abstract int osDiskSizeInGB()

Gets the size of the operating system disk.

Returns:

the size of the operating system disk

osProfile

public abstract OSProfile osProfile()

Gets the operating system profile of an virtual machine instance.

Returns:

the operating system profile of an virtual machine instance

osType

public abstract OperatingSystemTypes osType()

Gets the operating system type.

Returns:

the operating system type

osUnmanagedDiskVhdUri

public abstract String osUnmanagedDiskVhdUri()

Gets VHD URI to the operating system disk.

Returns:

VHD URI to the operating system disk

platformImageReference

public abstract ImageReference platformImageReference()

Gets reference to the platform image.

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<Void> powerOffAsync()

Stops the virtual machine instance.

Returns:

a representation of the deferred computation of this call

powerOffAsync

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

Gets the power state of the virtual machine instance.

Returns:

the power state of the virtual machine instance

primaryNetworkInterfaceId

public abstract String primaryNetworkInterfaceId()

Gets resource ID of primary network interface associated with virtual machine instance.

Returns:

resource ID of primary network interface associated with virtual machine instance

protectionPolicy

public abstract VirtualMachineScaleSetVMProtectionPolicy protectionPolicy()

Gets the specific protection policy for the vm.

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<Void> 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<VirtualMachineInstanceView> 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<Void> 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<Void> restartAsync()

Restarts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

size

public abstract VirtualMachineSizeTypes size()

Gets virtual machine instance size.

Returns:

virtual machine instance size

sku

public abstract Sku sku()

Gets the SKU of the virtual machine instance.

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<Void> startAsync()

Starts the virtual machine instance.

Returns:

a representation of the deferred computation of this call

storageProfile

public abstract StorageProfile storageProfile()

Gets the storage profile of the virtual machine instance.

Returns:

the storage profile of the virtual machine instance

storedImageUnmanagedVhdUri

public abstract String storedImageUnmanagedVhdUri()

Gets VHD URI of the custom image.

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()

Gets the time at which the Virtual Machine resource was created.

Returns:

the time at which the Virtual Machine resource was created

unmanagedDataDisks

public abstract Map<Integer,VirtualMachineUnmanagedDataDisk> unmanagedDataDisks()

Gets the unmanaged data disks associated with this virtual machine instance.

Returns:

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

windowsTimeZone

public abstract String windowsTimeZone()

Gets the time zone of the Windows virtual machine.

Returns:

the time zone of the Windows virtual machine