VirtualMachineScaleSetVM (Microsoft Azure Libraries for Java)

All Superinterfaces:

ChildResource<VirtualMachineScaleSet>, HasId, HasInner<com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetVMInner>, HasName, HasParent<VirtualMachineScaleSet>, Indexable, Refreshable<VirtualMachineScaleSetVM>, Resource
```
public interface VirtualMachineScaleSetVM
extends Resource, ChildResource<VirtualMachineScaleSet>, Refreshable<VirtualMachineScaleSetVM>, HasInner<com.microsoft.azure.management.compute.implementation.VirtualMachineScaleSetVMInner>
```
An immutable client-side representation of a virtual machine instance in an Azure virtual machine scale set.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
  Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

All Methods Instance Methods Abstract Methods
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.
`rx.Completable`	`deallocateAsync()` Shuts down the virtual machine instance and releases the associated compute resources.
`void`	`delete()` Deletes the virtual machine instance.
`rx.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.
`boolean`	`isLatestScaleSetUpdateApplied()`
`boolean`	`isLinuxPasswordAuthenticationEnabled()`
`boolean`	`isManagedDiskEnabled()`
`boolean`	`isOSBasedOnCustomImage()`
`boolean`	`isOSBasedOnPlatformImage()`
`boolean`	`isOSBasedOnStoredImage()`
`boolean`	`isWindowsAutoUpdateEnabled()`
`boolean`	`isWindowsVMAgentProvisioned()`
`PagedList<VirtualMachineScaleSetNetworkInterface>`	`listNetworkInterfaces()`
`String`	`modelDefinitionApplied()`
`List<String>`	`networkInterfaceIds()`
`VirtualMachineScaleSetVMNetworkProfileConfiguration`	`networkProfileConfiguration()`
`CachingTypes`	`osDiskCachingType()`
`String`	`osDiskId()`
`String`	`osDiskName()`
`int`	`osDiskSizeInGB()`
`OSProfile`	`osProfile()`
`OperatingSystemTypes`	`osType()`
`String`	`osUnmanagedDiskVhdUri()`
`ImageReference`	`platformImageReference()`
`void`	`powerOff()` Stops the virtual machine instance.
`rx.Completable`	`powerOffAsync()` Stops the virtual machine instance.
`PowerState`	`powerState()`
`String`	`primaryNetworkInterfaceId()`
`VirtualMachineScaleSetVMProtectionPolicy`	`protectionPolicy()`
`VirtualMachineInstanceView`	`refreshInstanceView()` Refreshes the instance view.
`rx.Observable<VirtualMachineInstanceView>`	`refreshInstanceViewAsync()` Refreshes the instance view.
`void`	`reimage()` Updates the version of the installed operating system in the virtual machine instance.
`rx.Completable`	`reimageAsync()` Updates the version of the installed operating system in the virtual machine instance.
`void`	`restart()` Restarts the virtual machine instance.
`rx.Completable`	`restartAsync()` Restarts the virtual machine instance.
`VirtualMachineSizeTypes`	`size()`
`Sku`	`sku()`
`void`	`start()` Starts the virtual machine instance.
`rx.Completable`	`startAsync()` Starts the virtual machine instance.
`StorageProfile`	`storageProfile()`
`String`	`storedImageUnmanagedVhdUri()`
`Map<Integer,VirtualMachineUnmanagedDataDisk>`	`unmanagedDataDisks()`
`String`	`windowsTimeZone()`

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
region, regionName, tags, type

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

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

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

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

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

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

- Method Detail
  - instanceId
```
String instanceId()
```
    Returns:
    
    the instance ID assigned to this virtual machine instance
  - sku
```
Sku sku()
```
    Returns:
    
    the SKU of the virtual machine instance, this will be SKU used while creating the parent virtual machine scale set
  - size
```
VirtualMachineSizeTypes size()
```
    Returns:
    
    virtual machine instance size
  - isLatestScaleSetUpdateApplied
```
boolean isLatestScaleSetUpdateApplied()
```
    Returns:
    
    true if the latest scale set model changes are applied to the virtual machine instance
  - isOSBasedOnPlatformImage
```
boolean isOSBasedOnPlatformImage()
```
    Returns:
    
    true if the operating system of the virtual machine instance is based on platform image
  - isOSBasedOnCustomImage
```
boolean isOSBasedOnCustomImage()
```
    Returns:
    
    true if the operating system of the virtual machine instance is based on custom image
  - isOSBasedOnStoredImage
```
boolean isOSBasedOnStoredImage()
```
    Returns:
    
    true if the operating system of the virtual machine instance is based on stored image
  - platformImageReference
```
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
  - getOSPlatformImage
```
VirtualMachineImage getOSPlatformImage()
```
    Returns:
    
    the platform image that the virtual machine instance operating system is based on, null be returned otherwise
  - getOSCustomImage
```
VirtualMachineCustomImage getOSCustomImage()
```
    Returns:
    
    the custom image that the virtual machine instance operating system is based on, null be returned otherwise
  - storedImageUnmanagedVhdUri
```
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
  - osDiskName
```
String osDiskName()
```
    Returns:
    
    the name of the operating system disk
  - osUnmanagedDiskVhdUri
```
String osUnmanagedDiskVhdUri()
```
    Returns:
    
    VHD URI to the operating system disk
  - osDiskId
```
String osDiskId()
```
    Returns:
    
    resource ID of the managed disk backing OS disk
  - unmanagedDataDisks
```
Map<Integer,VirtualMachineUnmanagedDataDisk> unmanagedDataDisks()
```
    Returns:
    
    the unmanaged data disks associated with this virtual machine instance, indexed by LUN
  - dataDisks
```
Map<Integer,VirtualMachineDataDisk> dataDisks()
```
    Returns:
    
    the managed data disks associated with this virtual machine instance, indexed by LUN
  - osDiskCachingType
```
CachingTypes osDiskCachingType()
```
    Returns:
    
    the caching type of the operating system disk
  - osDiskSizeInGB
```
int osDiskSizeInGB()
```
    Returns:
    
    the size of the operating system disk
  - computerName
```
String computerName()
```
    Returns:
    
    the virtual machine instance computer name with the VM scale set prefix.
  - administratorUserName
```
String administratorUserName()
```
    Returns:
    
    the name of the admin user
  - osType
```
OperatingSystemTypes osType()
```
    Returns:
    
    the operating system type
  - isLinuxPasswordAuthenticationEnabled
```
boolean isLinuxPasswordAuthenticationEnabled()
```
    Returns:
    
    true if this is a Linux virtual machine and password based login is enabled, false otherwise
  - isWindowsVMAgentProvisioned
```
boolean isWindowsVMAgentProvisioned()
```
    Returns:
    
    true if this is a Windows virtual machine and VM agent is provisioned, false otherwise
  - isWindowsAutoUpdateEnabled
```
boolean isWindowsAutoUpdateEnabled()
```
    Returns:
    
    true if this is a Windows virtual machine and automatic update is turned on, false otherwise
  - windowsTimeZone
```
String windowsTimeZone()
```
    Returns:
    
    the time zone of the Windows virtual machine
  - bootDiagnosticEnabled
```
boolean bootDiagnosticEnabled()
```
    Returns:
    
    true if the boot diagnostic is enabled, false otherwise
  - bootDiagnosticStorageAccountUri
```
String bootDiagnosticStorageAccountUri()
```
    Returns:
    
    the URI to the storage account storing boot diagnostics log
  - availabilitySetId
```
String availabilitySetId()
```
    Returns:
    
    the resource ID of the availability set that this virtual machine instance belongs to
  - networkInterfaceIds
```
List<String> networkInterfaceIds()
```
    Returns:
    
    the list of resource ID of network interface associated with the virtual machine instance
  - primaryNetworkInterfaceId
```
String primaryNetworkInterfaceId()
```
    Returns:
    
    resource ID of primary network interface associated with virtual machine instance
  - extensions
```
Map<String,VirtualMachineScaleSetVMInstanceExtension> extensions()
```
    Returns:
    
    the extensions associated with the virtual machine instance, indexed by name
  - storageProfile
```
StorageProfile storageProfile()
```
    Returns:
    
    the storage profile of the virtual machine instance
  - osProfile
```
OSProfile osProfile()
```
    Returns:
    
    the operating system profile of an virtual machine instance
  - diagnosticsProfile
```
DiagnosticsProfile diagnosticsProfile()
```
    Returns:
    
    the diagnostics profile of the virtual machine instance
  - isManagedDiskEnabled
```
boolean isManagedDiskEnabled()
```
    Returns:
    
    true if managed disk is used for the virtual machine's disks (os, data)
  - reimage
```
void reimage()
```
    Updates the version of the installed operating system in the virtual machine instance.
  - reimageAsync
```
rx.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
  - deallocate
```
void deallocate()
```
    Shuts down the virtual machine instance and releases the associated compute resources.
  - deallocateAsync
```
rx.Completable deallocateAsync()
```
    Shuts down the virtual machine instance and releases the associated compute resources.
    
    Returns:
    
    a representation of the deferred computation of this call
  - powerOff
```
void powerOff()
```
    Stops the virtual machine instance.
  - powerOffAsync
```
rx.Completable powerOffAsync()
```
    Stops the virtual machine instance.
    
    Returns:
    
    a representation of the deferred computation of this call
  - start
```
void start()
```
    Starts the virtual machine instance.
  - startAsync
```
rx.Completable startAsync()
```
    Starts the virtual machine instance.
    
    Returns:
    
    a representation of the deferred computation of this call
  - restart
```
void restart()
```
    Restarts the virtual machine instance.
  - restartAsync
```
rx.Completable restartAsync()
```
    Restarts the virtual machine instance.
    
    Returns:
    
    a representation of the deferred computation of this call
  - delete
```
void delete()
```
    Deletes the virtual machine instance.
  - deleteAsync
```
rx.Completable deleteAsync()
```
    Deletes the virtual machine instance.
    
    Returns:
    
    a representation of the deferred computation of this call
  - instanceView
```
VirtualMachineInstanceView instanceView()
```
    Gets the instance view of the virtual machine instance.
    To get the latest instance view use refreshInstanceView().
    
    Returns:
    
    the instance view
  - refreshInstanceView
```
VirtualMachineInstanceView refreshInstanceView()
```
    Refreshes the instance view.
    
    Returns:
    
    the instance view
  - refreshInstanceViewAsync
```
rx.Observable<VirtualMachineInstanceView> refreshInstanceViewAsync()
```
    Refreshes the instance view.
    
    Returns:
    
    an observable that emits the instance view of the virtual machine instance.
  - powerState
```
PowerState powerState()
```
    Returns:
    
    the power state of the virtual machine instance
  - getNetworkInterface
```
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
  - listNetworkInterfaces
```
PagedList<VirtualMachineScaleSetNetworkInterface> listNetworkInterfaces()
```
    Returns:
    
    the network interfaces associated with this virtual machine instance.
  - modelDefinitionApplied
```
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.
  - protectionPolicy
```
VirtualMachineScaleSetVMProtectionPolicy protectionPolicy()
```
    Returns:
    
    The specific protection policy for the vm.
  - networkProfileConfiguration
```
VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration()
```
    Returns:
    
    The network profile config for the vm.

Interface VirtualMachineScaleSetVM

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Method Summary

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

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

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

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

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

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

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

Method Detail

instanceId

sku

size

isLatestScaleSetUpdateApplied

isOSBasedOnPlatformImage

isOSBasedOnCustomImage

isOSBasedOnStoredImage

platformImageReference

getOSPlatformImage

getOSCustomImage

storedImageUnmanagedVhdUri

osDiskName

osUnmanagedDiskVhdUri

osDiskId

unmanagedDataDisks

dataDisks

osDiskCachingType

osDiskSizeInGB

computerName

administratorUserName

osType

isLinuxPasswordAuthenticationEnabled

isWindowsVMAgentProvisioned

isWindowsAutoUpdateEnabled

windowsTimeZone

bootDiagnosticEnabled

bootDiagnosticStorageAccountUri

availabilitySetId

networkInterfaceIds

primaryNetworkInterfaceId

extensions

storageProfile

osProfile

diagnosticsProfile

isManagedDiskEnabled

reimage

reimageAsync

deallocate

deallocateAsync

powerOff

powerOffAsync

start

startAsync

restart

restartAsync

delete

deleteAsync

instanceView

refreshInstanceView

refreshInstanceViewAsync

powerState

getNetworkInterface

listNetworkInterfaces

modelDefinitionApplied

protectionPolicy

networkProfileConfiguration