VirtualMachineScaleSetVM Interface
Implements
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,Virtual |
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
Diagnostics |
diagnosticsProfile()
Gets the diagnostics profile of the virtual machine instance. |
|
abstract
Map<String,Virtual |
extensions()
Gets the extensions associated with the virtual machine instance, indexed by name. |
|
abstract
Virtual |
getNetworkInterface(String name)
Gets a network interface associated with this virtual machine instance. |
|
abstract
Mono<Virtual |
getNetworkInterfaceAsync(String name)
Gets a network interface associated with this virtual machine instance. |
|
abstract
Virtual |
getOSCustomImage()
Gets the custom image. |
|
abstract
Virtual |
getOSPlatformImage()
Gets the platform image. |
| abstract String |
instanceId()
Gets the instance ID assigned to this virtual machine instance. |
|
abstract
Virtual |
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
Paged |
listNetworkInterfaces()
Gets the network interfaces associated with this virtual machine instance. |
|
abstract
Paged |
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
Virtual |
networkProfileConfiguration()
Gets the network profile config for the vm. |
|
abstract
Caching |
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
Operating |
osType()
Gets the operating system type. |
| abstract String |
osUnmanagedDiskVhdUri()
Gets VHD URI to the operating system disk. |
|
abstract
Image |
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
Power |
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
Virtual |
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
Virtual |
refreshInstanceView()
Refreshes the instance view. |
|
abstract
Mono<Virtual |
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
Virtual |
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
Storage |
storageProfile()
Gets the storage profile of the virtual machine instance. |
| abstract String |
storedImageUnmanagedVhdUri()
Gets VHD URI of the custom image. |
|
abstract
Offset |
timeCreated()
Gets the time at which the Virtual Machine resource was created. |
|
abstract
Map<Integer,Virtual |
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:
availabilitySetId
public abstract String availabilitySetId()
Gets the resource ID of the availability set that this virtual machine instance belongs to.
Returns:
bootDiagnosticEnabled
public abstract boolean bootDiagnosticEnabled()
Checks whether the boot diagnostic is enabled.
Returns:
bootDiagnosticStorageAccountUri
public abstract String bootDiagnosticStorageAccountUri()
Gets the URI to the storage account storing boot diagnostics log.
Returns:
computerName
public abstract String computerName()
Gets the virtual machine instance computer name with the VM scale set prefix.
Returns:
dataDisks
public abstract Map
Gets the managed data disks associated with this virtual machine instance.
Returns:
deallocate
public abstract void deallocate()
Shuts down the virtual machine instance and releases the associated compute resources.
deallocateAsync
public abstract Mono
Shuts down the virtual machine instance and releases the associated compute resources.
Returns:
delete
public abstract void delete()
Deletes the virtual machine instance.
deleteAsync
public abstract Mono
Deletes the virtual machine instance.
Returns:
diagnosticsProfile
public abstract DiagnosticsProfile diagnosticsProfile()
Gets the diagnostics profile of the virtual machine instance.
Returns:
extensions
public abstract Map
Gets the extensions associated with the virtual machine instance, indexed by name.
Returns:
getNetworkInterface
public abstract VirtualMachineScaleSetNetworkInterface getNetworkInterface(String name)
Gets a network interface associated with this virtual machine instance.
Parameters:
Returns:
getNetworkInterfaceAsync
public abstract Mono
Gets a network interface associated with this virtual machine instance.
Parameters:
Returns:
getOSCustomImage
public abstract VirtualMachineCustomImage getOSCustomImage()
Gets the custom image.
Returns:
getOSPlatformImage
public abstract VirtualMachineImage getOSPlatformImage()
Gets the platform image.
Returns:
instanceId
public abstract String instanceId()
Gets the instance ID assigned to this virtual machine instance.
Returns:
instanceView
public abstract VirtualMachineInstanceView instanceView()
Gets the instance view of the virtual machine instance.
To get the latest instance view use refreshInstanceView().
Returns:
isLatestScaleSetUpdateApplied
public abstract boolean isLatestScaleSetUpdateApplied()
Checks whether the latest scale set model changes are applied to the virtual machine instance.
Returns:
isLinuxPasswordAuthenticationEnabled
public abstract boolean isLinuxPasswordAuthenticationEnabled()
Checks whether this is a Linux virtual machine and password based login is enabled.
Returns:
isManagedDiskEnabled
public abstract boolean isManagedDiskEnabled()
Checks whether managed disk is used for the virtual machine's disks (os, data).
Returns:
isOSBasedOnCustomImage
public abstract boolean isOSBasedOnCustomImage()
Checks whether the operating system of the virtual machine instance is based on custom image.
Returns:
isOSBasedOnPlatformImage
public abstract boolean isOSBasedOnPlatformImage()
Checks whether the operating system of the virtual machine instance is based on platform image.
Returns:
isOSBasedOnStoredImage
public abstract boolean isOSBasedOnStoredImage()
Checks whether the operating system of the virtual machine instance is based on stored image.
Returns:
isWindowsAutoUpdateEnabled
public abstract boolean isWindowsAutoUpdateEnabled()
Checks whether this is a Windows virtual machine and automatic update is turned on.
Returns:
isWindowsVMAgentProvisioned
public abstract boolean isWindowsVMAgentProvisioned()
Checks whether this is a Windows virtual machine and VM agent is provisioned.
Returns:
listNetworkInterfaces
public abstract PagedIterable
Gets the network interfaces associated with this virtual machine instance.
Returns:
listNetworkInterfacesAsync
public abstract PagedFlux
Gets the network interfaces associated with this virtual machine instance.
Returns:
modelDefinitionApplied
public abstract String modelDefinitionApplied()
Gets applied model from the virtual machine.
Returns:
networkInterfaceIds
public abstract List
Gets the list of resource ID of network interface associated with the virtual machine instance.
Returns:
networkProfileConfiguration
public abstract VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration()
Gets the network profile config for the vm.
Returns:
osDiskCachingType
public abstract CachingTypes osDiskCachingType()
Gets the caching type of the operating system disk.
Returns:
osDiskId
public abstract String osDiskId()
Gets resource ID of the managed disk backing OS disk.
Returns:
osDiskName
public abstract String osDiskName()
Gets the name of the operating system disk.
Returns:
osDiskSizeInGB
public abstract int osDiskSizeInGB()
Gets the size of the operating system disk.
Returns:
osProfile
public abstract OSProfile osProfile()
Gets the operating system profile of an virtual machine instance.
Returns:
osType
public abstract OperatingSystemTypes osType()
Gets the operating system type.
Returns:
osUnmanagedDiskVhdUri
public abstract String osUnmanagedDiskVhdUri()
Gets VHD URI to the operating system disk.
Returns:
platformImageReference
public abstract ImageReference platformImageReference()
Gets reference to the platform image.
Returns:
powerOff
public abstract void powerOff()
Stops the virtual machine instance.
powerOff
public abstract void powerOff(boolean skipShutdown)
Stops the virtual machine instance.
Parameters:
powerOffAsync
public abstract Mono
Stops the virtual machine instance.
Returns:
powerOffAsync
public abstract Mono
Stops the virtual machine instances.
Parameters:
Returns:
powerState
public abstract PowerState powerState()
Gets the power state of the virtual machine instance.
Returns:
primaryNetworkInterfaceId
public abstract String primaryNetworkInterfaceId()
Gets resource ID of primary network interface associated with virtual machine instance.
Returns:
protectionPolicy
public abstract VirtualMachineScaleSetVMProtectionPolicy protectionPolicy()
Gets the specific protection policy for the vm.
Returns:
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
Shuts down the virtual machine instance, move them to new node, and powers them back on.
Returns:
refreshInstanceView
public abstract VirtualMachineInstanceView refreshInstanceView()
Refreshes the instance view.
Returns:
refreshInstanceViewAsync
public abstract Mono
Refreshes the instance view.
Returns:
reimage
public abstract void reimage()
Updates the version of the installed operating system in the virtual machine instance.
reimageAsync
public abstract Mono
Updates the version of the installed operating system in the virtual machine instance.
Returns:
restart
public abstract void restart()
Restarts the virtual machine instance.
restartAsync
public abstract Mono
Restarts the virtual machine instance.
Returns:
size
public abstract VirtualMachineSizeTypes size()
Gets virtual machine instance size.
Returns:
sku
public abstract Sku sku()
Gets the SKU of the virtual machine instance.
Returns:
start
public abstract void start()
Starts the virtual machine instance.
startAsync
public abstract Mono
Starts the virtual machine instance.
Returns:
storageProfile
public abstract StorageProfile storageProfile()
Gets the storage profile of the virtual machine instance.
Returns:
storedImageUnmanagedVhdUri
public abstract String storedImageUnmanagedVhdUri()
Gets VHD URI of the custom image.
Returns:
timeCreated
public abstract OffsetDateTime timeCreated()
Gets the time at which the Virtual Machine resource was created.
Returns:
unmanagedDataDisks
public abstract Map
Gets the unmanaged data disks associated with this virtual machine instance.
Returns:
windowsTimeZone
public abstract String windowsTimeZone()
Gets the time zone of the Windows virtual machine.
Returns:
Applies to
Azure SDK for Java