com.azure.resourcemanager.compute.models.VirtualMachineScaleSetVM Maven / Gradle / Ivy
Show all versions of azure-resourcemanager-compute Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.compute.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.http.rest.PagedFlux;
import com.azure.core.http.rest.PagedIterable;
import com.azure.resourcemanager.compute.fluent.models.VirtualMachineScaleSetVMInner;
import com.azure.resourcemanager.network.models.VirtualMachineScaleSetNetworkInterface;
import com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource;
import com.azure.resourcemanager.resources.fluentcore.arm.models.Resource;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;
import reactor.core.publisher.Mono;
/** An immutable client-side representation of a virtual machine instance in an Azure virtual machine scale set. */
@Fluent
public interface VirtualMachineScaleSetVM
extends Resource,
ChildResource,
Refreshable,
Updatable,
HasInnerModel {
/** @return the instance ID assigned to this virtual machine instance */
String instanceId();
/**
* @return the SKU of the virtual machine instance, this will be SKU used while creating the parent virtual machine
* scale set
*/
Sku sku();
/** @return virtual machine instance size */
VirtualMachineSizeTypes size();
/** @return true if the latest scale set model changes are applied to the virtual machine instance */
boolean isLatestScaleSetUpdateApplied();
/** @return true if the operating system of the virtual machine instance is based on platform image */
boolean isOSBasedOnPlatformImage();
/** @return true if the operating system of the virtual machine instance is based on custom image */
boolean isOSBasedOnCustomImage();
/** @return true if the operating system of the virtual machine instance is based on stored image */
boolean isOSBasedOnStoredImage();
/**
* @return 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
*/
ImageReference platformImageReference();
/**
* @return the platform image that the virtual machine instance operating system is based on, null be returned
* otherwise
*/
VirtualMachineImage getOSPlatformImage();
/**
* @return the custom image that the virtual machine instance operating system is based on, null be returned
* otherwise
*/
VirtualMachineCustomImage getOSCustomImage();
/**
* @return 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
*/
String storedImageUnmanagedVhdUri();
/** @return the name of the operating system disk */
String osDiskName();
/** @return VHD URI to the operating system disk */
String osUnmanagedDiskVhdUri();
/** @return resource ID of the managed disk backing OS disk */
String osDiskId();
/** @return the unmanaged data disks associated with this virtual machine instance, indexed by LUN */
Map unmanagedDataDisks();
/** @return the managed data disks associated with this virtual machine instance, indexed by LUN */
Map dataDisks();
/** @return the caching type of the operating system disk */
CachingTypes osDiskCachingType();
/** @return the size of the operating system disk */
int osDiskSizeInGB();
/** @return the virtual machine instance computer name with the VM scale set prefix. */
String computerName();
/** @return the name of the admin user */
String administratorUserName();
/** @return the operating system type */
OperatingSystemTypes osType();
/** @return true if this is a Linux virtual machine and password based login is enabled, false otherwise */
boolean isLinuxPasswordAuthenticationEnabled();
/** @return true if this is a Windows virtual machine and VM agent is provisioned, false otherwise */
boolean isWindowsVMAgentProvisioned();
/** @return true if this is a Windows virtual machine and automatic update is turned on, false otherwise */
boolean isWindowsAutoUpdateEnabled();
/** @return the time zone of the Windows virtual machine */
String windowsTimeZone();
/** @return true if the boot diagnostic is enabled, false otherwise */
boolean bootDiagnosticEnabled();
/** @return the URI to the storage account storing boot diagnostics log */
String bootDiagnosticStorageAccountUri();
/** @return the resource ID of the availability set that this virtual machine instance belongs to */
String availabilitySetId();
/** @return the list of resource ID of network interface associated with the virtual machine instance */
List networkInterfaceIds();
/** @return resource ID of primary network interface associated with virtual machine instance */
String primaryNetworkInterfaceId();
/** @return the extensions associated with the virtual machine instance, indexed by name */
Map extensions();
/** @return the storage profile of the virtual machine instance */
StorageProfile storageProfile();
/** @return the operating system profile of an virtual machine instance */
OSProfile osProfile();
/** @return the diagnostics profile of the virtual machine instance */
DiagnosticsProfile diagnosticsProfile();
/** @return true if managed disk is used for the virtual machine's disks (os, data) */
boolean isManagedDiskEnabled();
/** Shuts down the virtual machine instance, move them to new node, and powers them back on. */
void redeploy();
/**
* Shuts down the virtual machine instance, move them to new node, and powers them back on.
*
* @return a representation of the deferred computation of this call
*/
Mono redeployAsync();
/** Updates the version of the installed operating system in the virtual machine instance. */
void reimage();
/**
* Updates the version of the installed operating system in the virtual machine instance.
*
* @return a representation of the deferred computation of this call
*/
Mono reimageAsync();
/** Shuts down the virtual machine instance and releases the associated compute resources. */
void deallocate();
/**
* Shuts down the virtual machine instance and releases the associated compute resources.
*
* @return a representation of the deferred computation of this call
*/
Mono deallocateAsync();
/** Stops the virtual machine instance. */
void powerOff();
/**
* Stops the virtual machine instance.
*
* @return a representation of the deferred computation of this call
*/
Mono powerOffAsync();
/**
* Stops the virtual machine instance.
*
* @param skipShutdown power off without graceful shutdown
*/
void powerOff(boolean skipShutdown);
/**
* Stops the virtual machine instances.
*
* @param skipShutdown power off without graceful shutdown
* @return a representation of the deferred computation of this call.
*/
Mono powerOffAsync(boolean skipShutdown);
/** Starts the virtual machine instance. */
void start();
/**
* Starts the virtual machine instance.
*
* @return a representation of the deferred computation of this call
*/
Mono startAsync();
/** Restarts the virtual machine instance. */
void restart();
/**
* Restarts the virtual machine instance.
*
* @return a representation of the deferred computation of this call
*/
Mono restartAsync();
/** Deletes the virtual machine instance. */
void delete();
/**
* Deletes the virtual machine instance.
*
* @return a representation of the deferred computation of this call
*/
Mono deleteAsync();
/**
* Gets the instance view of the virtual machine instance.
*
* To get the latest instance view use refreshInstanceView().
*
* @return the instance view
*/
VirtualMachineInstanceView instanceView();
/**
* Refreshes the instance view.
*
* @return the instance view
*/
VirtualMachineInstanceView refreshInstanceView();
/**
* Refreshes the instance view.
*
* @return an observable that emits the instance view of the virtual machine instance.
*/
Mono refreshInstanceViewAsync();
/** @return the power state of the virtual machine instance */
PowerState powerState();
/**
* Gets a network interface associated with this virtual machine instance.
*
* @param name the name of the network interface
* @return the network interface
*/
VirtualMachineScaleSetNetworkInterface getNetworkInterface(String name);
/**
* Gets a network interface associated with this virtual machine instance.
*
* @param name the name of the network interface
* @return the network interface
*/
Mono getNetworkInterfaceAsync(String name);
/** @return the network interfaces associated with this virtual machine instance. */
PagedIterable listNetworkInterfaces();
/** @return the network interfaces associated with this virtual machine instance. */
PagedFlux listNetworkInterfacesAsync();
/**
* @return 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.
*/
String modelDefinitionApplied();
/** @return The specific protection policy for the vm. */
VirtualMachineScaleSetVMProtectionPolicy protectionPolicy();
/** @return The network profile config for the vm. */
VirtualMachineScaleSetVMNetworkProfileConfiguration networkProfileConfiguration();
/** @return the time at which the Virtual Machine resource was created */
OffsetDateTime timeCreated();
/** The template for an update operation, containing all the settings that can be modified. */
interface Update extends Appliable {
/**
* Attaches an existing data disk to this VMSS virtual machine.
*
* @param dataDisk data disk, need to be in DiskState.UNATTACHED state
* @param lun the disk LUN, cannot conflict with existing LUNs
* @param cachingTypes the caching type
* @return the next stage of the update
*/
Update withExistingDataDisk(Disk dataDisk, int lun, CachingTypes cachingTypes);
/**
* Attaches an existing data disk to this VMSS virtual machine.
*
* @param dataDisk data disk, need to be in DiskState.UNATTACHED state
* @param lun the disk LUN, cannot conflict with existing LUNs
* @param cachingTypes the caching type
* @param storageAccountTypes the storage account type
* @return the next stage of the update
*/
Update withExistingDataDisk(
Disk dataDisk, int lun, CachingTypes cachingTypes, StorageAccountTypes storageAccountTypes);
/**
* Detaches an existing data disk from this VMSS virtual machine.
*
* @param lun the disk LUN
* @return the next stage of the update
*/
Update withoutDataDisk(int lun);
}
}