com.azure.resourcemanager.compute.fluent.models

Class VirtualMachineInner

java.lang.Object

com.azure.core.management.ProxyResource

com.azure.core.management.Resource

com.azure.resourcemanager.compute.fluent.models.VirtualMachineInner

public class VirtualMachineInner
extends com.azure.core.management.Resource

Describes a Virtual Machine.

Constructor Summary

Constructors

Constructor and Description
VirtualMachineInner()

Method Summary

Modifier and Type	Method and Description
AdditionalCapabilities	additionalCapabilities() Get the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine.
com.azure.core.management.SubResource	availabilitySet() Get the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to.
BillingProfile	billingProfile() Get the billingProfile property: Specifies the billing related details of a Azure Spot virtual machine.
DiagnosticsProfile	diagnosticsProfile() Get the diagnosticsProfile property: Specifies the boot diagnostic settings state.
VirtualMachineEvictionPolicyTypes	evictionPolicy() Get the evictionPolicy property: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
HardwareProfile	hardwareProfile() Get the hardwareProfile property: Specifies the hardware settings for the virtual machine.
com.azure.core.management.SubResource	host() Get the host property: Specifies information about the dedicated host that the virtual machine resides in.
VirtualMachineIdentity	identity() Get the identity property: The identity of the virtual machine, if configured.
VirtualMachineInstanceViewInner	instanceView() Get the instanceView property: The virtual machine instance view.
String	licenseType() Get the licenseType property: Specifies that the image or disk that is being used was licensed on-premises.
NetworkProfile	networkProfile() Get the networkProfile property: Specifies the network interfaces of the virtual machine.
OSProfile	osProfile() Get the osProfile property: Specifies the operating system settings used while creating the virtual machine.
Plan	plan() Get the plan property: Specifies information about the marketplace image used to create the virtual machine.
VirtualMachinePriorityTypes	priority() Get the priority property: Specifies the priority for the virtual machine.
String	provisioningState() Get the provisioningState property: The provisioning state, which only appears in the response.
com.azure.core.management.SubResource	proximityPlacementGroup() Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine should be assigned to.
List<VirtualMachineExtensionInner>	resources() Get the resources property: The virtual machine child extension resources.
StorageProfile	storageProfile() Get the storageProfile property: Specifies the storage settings for the virtual machine disks.
void	validate() Validates the instance.
com.azure.core.management.SubResource	virtualMachineScaleSet() Get the virtualMachineScaleSet property: Specifies information about the virtual machine scale set that the virtual machine should be assigned to.
String	vmId() Get the vmId property: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
VirtualMachineInner	withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities) Set the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine.
VirtualMachineInner	withAvailabilitySet(com.azure.core.management.SubResource availabilitySet) Set the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to.
VirtualMachineInner	withBillingProfile(BillingProfile billingProfile) Set the billingProfile property: Specifies the billing related details of a Azure Spot virtual machine.
VirtualMachineInner	withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile) Set the diagnosticsProfile property: Specifies the boot diagnostic settings state.
VirtualMachineInner	withEvictionPolicy(VirtualMachineEvictionPolicyTypes evictionPolicy) Set the evictionPolicy property: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
VirtualMachineInner	withHardwareProfile(HardwareProfile hardwareProfile) Set the hardwareProfile property: Specifies the hardware settings for the virtual machine.
VirtualMachineInner	withHost(com.azure.core.management.SubResource host) Set the host property: Specifies information about the dedicated host that the virtual machine resides in.
VirtualMachineInner	withIdentity(VirtualMachineIdentity identity) Set the identity property: The identity of the virtual machine, if configured.
VirtualMachineInner	withLicenseType(String licenseType) Set the licenseType property: Specifies that the image or disk that is being used was licensed on-premises.
VirtualMachineInner	withNetworkProfile(NetworkProfile networkProfile) Set the networkProfile property: Specifies the network interfaces of the virtual machine.
VirtualMachineInner	withOsProfile(OSProfile osProfile) Set the osProfile property: Specifies the operating system settings used while creating the virtual machine.
VirtualMachineInner	withPlan(Plan plan) Set the plan property: Specifies information about the marketplace image used to create the virtual machine.
VirtualMachineInner	withPriority(VirtualMachinePriorityTypes priority) Set the priority property: Specifies the priority for the virtual machine.
VirtualMachineInner	withProximityPlacementGroup(com.azure.core.management.SubResource proximityPlacementGroup) Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine should be assigned to.
VirtualMachineInner	withStorageProfile(StorageProfile storageProfile) Set the storageProfile property: Specifies the storage settings for the virtual machine disks.
VirtualMachineInner	withVirtualMachineScaleSet(com.azure.core.management.SubResource virtualMachineScaleSet) Set the virtualMachineScaleSet property: Specifies information about the virtual machine scale set that the virtual machine should be assigned to.
VirtualMachineInner	withZones(List<String> zones) Set the zones property: The virtual machine zones.
List<String>	zones() Get the zones property: The virtual machine zones.

Methods inherited from class com.azure.core.management.Resource

location, tags, withLocation, withTags

Methods inherited from class com.azure.core.management.ProxyResource

id, name, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualMachineInner

public VirtualMachineInner()

Method Detail

plan

public Plan plan()

Get the plan property: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.

Returns:

the plan value.

withPlan

public VirtualMachineInner withPlan(Plan plan)

Set the plan property: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.

Parameters:

plan - the plan value to set.

Returns:

the VirtualMachineInner object itself.

resources

public List<VirtualMachineExtensionInner> resources()

Get the resources property: The virtual machine child extension resources.

Returns:

the resources value.

identity

public VirtualMachineIdentity identity()

Get the identity property: The identity of the virtual machine, if configured.

Returns:

the identity value.

withIdentity

public VirtualMachineInner withIdentity(VirtualMachineIdentity identity)

Set the identity property: The identity of the virtual machine, if configured.

Parameters:

identity - the identity value to set.

Returns:

the VirtualMachineInner object itself.

zones

public List<String> zones()

Get the zones property: The virtual machine zones.

Returns:

the zones value.

withZones

public VirtualMachineInner withZones(List<String> zones)

Set the zones property: The virtual machine zones.

Parameters:

zones - the zones value to set.

Returns:

the VirtualMachineInner object itself.

hardwareProfile

public HardwareProfile hardwareProfile()

Get the hardwareProfile property: Specifies the hardware settings for the virtual machine.

Returns:

the hardwareProfile value.

withHardwareProfile

public VirtualMachineInner withHardwareProfile(HardwareProfile hardwareProfile)

Set the hardwareProfile property: Specifies the hardware settings for the virtual machine.

Parameters:

hardwareProfile - the hardwareProfile value to set.

Returns:

the VirtualMachineInner object itself.

storageProfile

public StorageProfile storageProfile()

Get the storageProfile property: Specifies the storage settings for the virtual machine disks.

Returns:

the storageProfile value.

withStorageProfile

public VirtualMachineInner withStorageProfile(StorageProfile storageProfile)

Set the storageProfile property: Specifies the storage settings for the virtual machine disks.

Parameters:

storageProfile - the storageProfile value to set.

Returns:

the VirtualMachineInner object itself.

additionalCapabilities

public AdditionalCapabilities additionalCapabilities()

Get the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine.

Returns:

the additionalCapabilities value.

withAdditionalCapabilities

public VirtualMachineInner withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)

Set the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the virtual machine.

Parameters:

additionalCapabilities - the additionalCapabilities value to set.

Returns:

the VirtualMachineInner object itself.

osProfile

public OSProfile osProfile()

Get the osProfile property: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Returns:

the osProfile value.

withOsProfile

public VirtualMachineInner withOsProfile(OSProfile osProfile)

Set the osProfile property: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Parameters:

osProfile - the osProfile value to set.

Returns:

the VirtualMachineInner object itself.

networkProfile

public NetworkProfile networkProfile()

Get the networkProfile property: Specifies the network interfaces of the virtual machine.

Returns:

the networkProfile value.

withNetworkProfile

public VirtualMachineInner withNetworkProfile(NetworkProfile networkProfile)

Set the networkProfile property: Specifies the network interfaces of the virtual machine.

Parameters:

networkProfile - the networkProfile value to set.

Returns:

the VirtualMachineInner object itself.

diagnosticsProfile

public DiagnosticsProfile diagnosticsProfile()

Get the diagnosticsProfile property: Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

Returns:

the diagnosticsProfile value.

withDiagnosticsProfile

public VirtualMachineInner withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile)

Set the diagnosticsProfile property: Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

Parameters:

diagnosticsProfile - the diagnosticsProfile value to set.

Returns:

the VirtualMachineInner object itself.

availabilitySet

public com.azure.core.management.SubResource availabilitySet()

Get the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

Returns:

the availabilitySet value.

withAvailabilitySet

public VirtualMachineInner withAvailabilitySet(com.azure.core.management.SubResource availabilitySet)

Set the availabilitySet property: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

Parameters:

availabilitySet - the availabilitySet value to set.

Returns:

the VirtualMachineInner object itself.

virtualMachineScaleSet

public com.azure.core.management.SubResource virtualMachineScaleSet()

Get the virtualMachineScaleSet property: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01.

Returns:

the virtualMachineScaleSet value.

withVirtualMachineScaleSet

public VirtualMachineInner withVirtualMachineScaleSet(com.azure.core.management.SubResource virtualMachineScaleSet)

Set the virtualMachineScaleSet property: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01.

Parameters:

virtualMachineScaleSet - the virtualMachineScaleSet value to set.

Returns:

the VirtualMachineInner object itself.

proximityPlacementGroup

public com.azure.core.management.SubResource proximityPlacementGroup()

Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

Returns:

the proximityPlacementGroup value.

withProximityPlacementGroup

public VirtualMachineInner withProximityPlacementGroup(com.azure.core.management.SubResource proximityPlacementGroup)

Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.

Parameters:

proximityPlacementGroup - the proximityPlacementGroup value to set.

Returns:

the VirtualMachineInner object itself.

priority

public VirtualMachinePriorityTypes priority()

Get the priority property: Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01.

Returns:

the priority value.

withPriority

public VirtualMachineInner withPriority(VirtualMachinePriorityTypes priority)

Set the priority property: Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01.

Parameters:

priority - the priority value to set.

Returns:

the VirtualMachineInner object itself.

evictionPolicy

public VirtualMachineEvictionPolicyTypes evictionPolicy()

Get the evictionPolicy property: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.

Returns:

the evictionPolicy value.

withEvictionPolicy

public VirtualMachineInner withEvictionPolicy(VirtualMachineEvictionPolicyTypes evictionPolicy)

Set the evictionPolicy property: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.

Parameters:

evictionPolicy - the evictionPolicy value to set.

Returns:

the VirtualMachineInner object itself.

billingProfile

public BillingProfile billingProfile()

Get the billingProfile property: Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

Returns:

the billingProfile value.

withBillingProfile

public VirtualMachineInner withBillingProfile(BillingProfile billingProfile)

Set the billingProfile property: Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.

Parameters:

billingProfile - the billingProfile value to set.

Returns:

the VirtualMachineInner object itself.

host

public com.azure.core.management.SubResource host()

Get the host property: Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

Returns:

the host value.

withHost

public VirtualMachineInner withHost(com.azure.core.management.SubResource host)

Set the host property: Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.

Parameters:

host - the host value to set.

Returns:

the VirtualMachineInner object itself.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

Returns:

the provisioningState value.

instanceView

public VirtualMachineInstanceViewInner instanceView()

Get the instanceView property: The virtual machine instance view.

Returns:

the instanceView value.

licenseType

public String licenseType()

Get the licenseType property: Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15.

Returns:

the licenseType value.

withLicenseType

public VirtualMachineInner withLicenseType(String licenseType)

Set the licenseType property: Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15.

Parameters:

licenseType - the licenseType value to set.

Returns:

the VirtualMachineInner object itself.

vmId

public String vmId()

Get the vmId property: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

Returns:

the vmId value.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.