Package com.microsoft.azure.management.compute

Class VirtualMachineUpdate

java.lang.Object
com.microsoft.azure.management.compute.UpdateResource
com.microsoft.azure.management.compute.VirtualMachineUpdate
public class VirtualMachineUpdate extends UpdateResource
Describes a Virtual Machine Update.

  • Constructor Details

    • VirtualMachineUpdate

      public VirtualMachineUpdate()

  • Method Details

    • plan

      public Plan plan()
      Get 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 VirtualMachineUpdate withPlan(Plan plan)
      Set 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 VirtualMachineUpdate object itself.

    • hardwareProfile

      public HardwareProfile hardwareProfile()
      Get specifies the hardware settings for the virtual machine.
      Returns:
      the hardwareProfile value

    • withHardwareProfile

      public VirtualMachineUpdate withHardwareProfile(HardwareProfile hardwareProfile)
      Set specifies the hardware settings for the virtual machine.
      Parameters:
      hardwareProfile - the hardwareProfile value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • storageProfile

      public StorageProfile storageProfile()
      Get specifies the storage settings for the virtual machine disks.
      Returns:
      the storageProfile value

    • withStorageProfile

      public VirtualMachineUpdate withStorageProfile(StorageProfile storageProfile)
      Set specifies the storage settings for the virtual machine disks.
      Parameters:
      storageProfile - the storageProfile value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • additionalCapabilities

      public AdditionalCapabilities additionalCapabilities()
      Get specifies additional capabilities enabled or disabled on the virtual machine.
      Returns:
      the additionalCapabilities value

    • withAdditionalCapabilities

      public VirtualMachineUpdate withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)
      Set specifies additional capabilities enabled or disabled on the virtual machine.
      Parameters:
      additionalCapabilities - the additionalCapabilities value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • osProfile

      public OSProfile osProfile()
      Get 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 VirtualMachineUpdate withOsProfile(OSProfile osProfile)
      Set 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 VirtualMachineUpdate object itself.

    • networkProfile

      public NetworkProfile networkProfile()
      Get specifies the network interfaces of the virtual machine.
      Returns:
      the networkProfile value

    • withNetworkProfile

      public VirtualMachineUpdate withNetworkProfile(NetworkProfile networkProfile)
      Set specifies the network interfaces of the virtual machine.
      Parameters:
      networkProfile - the networkProfile value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • securityProfile

      public SecurityProfile securityProfile()
      Get specifies the Security related profile settings for the virtual machine.
      Returns:
      the securityProfile value

    • withSecurityProfile

      public VirtualMachineUpdate withSecurityProfile(SecurityProfile securityProfile)
      Set specifies the Security related profile settings for the virtual machine.
      Parameters:
      securityProfile - the securityProfile value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • diagnosticsProfile

      public DiagnosticsProfile diagnosticsProfile()
      Get specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
      Returns:
      the diagnosticsProfile value

    • withDiagnosticsProfile

      public VirtualMachineUpdate withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile)
      Set specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
      Parameters:
      diagnosticsProfile - the diagnosticsProfile value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • availabilitySet

      public com.microsoft.azure.SubResource availabilitySet()
      Get 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 VirtualMachineUpdate withAvailabilitySet(com.microsoft.azure.SubResource availabilitySet)
      Set 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 VirtualMachineUpdate object itself.

    • virtualMachineScaleSet

      public com.microsoft.azure.SubResource virtualMachineScaleSet()
      Get 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 VirtualMachineUpdate withVirtualMachineScaleSet(com.microsoft.azure.SubResource virtualMachineScaleSet)
      Set 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 VirtualMachineUpdate object itself.

    • proximityPlacementGroup

      public com.microsoft.azure.SubResource proximityPlacementGroup()
      Get 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 VirtualMachineUpdate withProximityPlacementGroup(com.microsoft.azure.SubResource proximityPlacementGroup)
      Set 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 VirtualMachineUpdate object itself.

    • priority

      public VirtualMachinePriorityTypes priority()
      Get specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'.
      Returns:
      the priority value

    • withPriority

      public VirtualMachineUpdate withPriority(VirtualMachinePriorityTypes priority)
      Set specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'Regular', 'Low', 'Spot'.
      Parameters:
      priority - the priority value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • evictionPolicy

      public VirtualMachineEvictionPolicyTypes evictionPolicy()
      Get 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. Possible values include: 'Deallocate', 'Delete'.
      Returns:
      the evictionPolicy value

    • withEvictionPolicy

      public VirtualMachineUpdate withEvictionPolicy(VirtualMachineEvictionPolicyTypes evictionPolicy)
      Set 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. Possible values include: 'Deallocate', 'Delete'.
      Parameters:
      evictionPolicy - the evictionPolicy value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • billingProfile

      public BillingProfile billingProfile()
      Get 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 VirtualMachineUpdate withBillingProfile(BillingProfile billingProfile)
      Set 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 VirtualMachineUpdate object itself.

    • host

      public com.microsoft.azure.SubResource host()
      Get 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 VirtualMachineUpdate withHost(com.microsoft.azure.SubResource host)
      Set 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 VirtualMachineUpdate object itself.

    • hostGroup

      public com.microsoft.azure.SubResource hostGroup()
      Get specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.
      Returns:
      the hostGroup value

    • withHostGroup

      public VirtualMachineUpdate withHostGroup(com.microsoft.azure.SubResource hostGroup)
      Set specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.
      Parameters:
      hostGroup - the hostGroup value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioning state, which only appears in the response.
      Returns:
      the provisioningState value

    • instanceView

      public com.microsoft.azure.management.compute.implementation.VirtualMachineInstanceViewInner instanceView()
      Get the virtual machine instance view.
      Returns:
      the instanceView value

    • licenseType

      public String licenseType()
      Get specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15.
      Returns:
      the licenseType value

    • withLicenseType

      public VirtualMachineUpdate withLicenseType(String licenseType)
      Set specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15.
      Parameters:
      licenseType - the licenseType value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • vmId

      public String vmId()
      Get 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

    • extensionsTimeBudget

      public String extensionsTimeBudget()
      Get specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01.
      Returns:
      the extensionsTimeBudget value

    • withExtensionsTimeBudget

      public VirtualMachineUpdate withExtensionsTimeBudget(String extensionsTimeBudget)
      Set specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01.
      Parameters:
      extensionsTimeBudget - the extensionsTimeBudget value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • platformFaultDomain

      public Integer platformFaultDomain()
      Get specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01.
      Returns:
      the platformFaultDomain value

    • withPlatformFaultDomain

      public VirtualMachineUpdate withPlatformFaultDomain(Integer platformFaultDomain)
      Set specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01.
      Parameters:
      platformFaultDomain - the platformFaultDomain value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • identity

      public VirtualMachineIdentity identity()
      Get the identity of the virtual machine, if configured.
      Returns:
      the identity value

    • withIdentity

      public VirtualMachineUpdate withIdentity(VirtualMachineIdentity identity)
      Set the identity of the virtual machine, if configured.
      Parameters:
      identity - the identity value to set
      Returns:
      the VirtualMachineUpdate object itself.

    • zones

      public List<String> zones()
      Get the virtual machine zones.
      Returns:
      the zones value

    • withZones

      public VirtualMachineUpdate withZones(List<String> zones)
      Set the virtual machine zones.
      Parameters:
      zones - the zones value to set
      Returns:
      the VirtualMachineUpdate object itself.