Package com.azure.resourcemanager.compute.models

Interface VirtualMachineScaleSetVM

    • 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

      • 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

      • 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

      • 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

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

      • redeploy

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

      • redeployAsync

        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

      • reimage

        void reimage()
        Updates the version of the installed operating system in the virtual machine instance.

      • reimageAsync

        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

      • deallocate

        void deallocate()
        Shuts down the virtual machine instance and releases the associated compute resources.

      • deallocateAsync

        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

      • powerOff

        void powerOff()
        Stops the virtual machine instance.

      • powerOffAsync

        Mono<Void> powerOffAsync()
        Stops the virtual machine instance.
        Returns:
        a representation of the deferred computation of this call

      • powerOff

        void powerOff​(boolean skipShutdown)
        Stops the virtual machine instance.
        Parameters:
        skipShutdown - power off without graceful shutdown

      • powerOffAsync

        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.

      • start

        void start()
        Starts the virtual machine instance.

      • startAsync

        Mono<Void> 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

        Mono<Void> 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

        Mono<Void> 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

      • refreshInstanceViewAsync

        Mono<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

      • getNetworkInterfaceAsync

        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

      • listNetworkInterfaces

        com.azure.core.http.rest.PagedIterable<VirtualMachineScaleSetNetworkInterface> listNetworkInterfaces()
        Returns:
        the network interfaces associated with this virtual machine instance.

      • listNetworkInterfacesAsync

        com.azure.core.http.rest.PagedFlux<VirtualMachineScaleSetNetworkInterface> listNetworkInterfacesAsync()
        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.