Class VirtualMachineScaleSetUpdateProperties


  • public final class VirtualMachineScaleSetUpdateProperties
    extends Object
    Describes the properties of a Virtual Machine Scale Set.
    • Constructor Detail

      • VirtualMachineScaleSetUpdateProperties

        public VirtualMachineScaleSetUpdateProperties()
    • Method Detail

      • upgradePolicy

        public UpgradePolicy upgradePolicy()
        Get the upgradePolicy property: The upgrade policy.
        Returns:
        the upgradePolicy value.
      • withUpgradePolicy

        public VirtualMachineScaleSetUpdateProperties withUpgradePolicy​(UpgradePolicy upgradePolicy)
        Set the upgradePolicy property: The upgrade policy.
        Parameters:
        upgradePolicy - the upgradePolicy value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • automaticRepairsPolicy

        public AutomaticRepairsPolicy automaticRepairsPolicy()
        Get the automaticRepairsPolicy property: Policy for automatic repairs.
        Returns:
        the automaticRepairsPolicy value.
      • withAutomaticRepairsPolicy

        public VirtualMachineScaleSetUpdateProperties withAutomaticRepairsPolicy​(AutomaticRepairsPolicy automaticRepairsPolicy)
        Set the automaticRepairsPolicy property: Policy for automatic repairs.
        Parameters:
        automaticRepairsPolicy - the automaticRepairsPolicy value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • virtualMachineProfile

        public VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile()
        Get the virtualMachineProfile property: The virtual machine profile.
        Returns:
        the virtualMachineProfile value.
      • withVirtualMachineProfile

        public VirtualMachineScaleSetUpdateProperties withVirtualMachineProfile​(VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile)
        Set the virtualMachineProfile property: The virtual machine profile.
        Parameters:
        virtualMachineProfile - the virtualMachineProfile value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • overprovision

        public Boolean overprovision()
        Get the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
        Returns:
        the overprovision value.
      • withOverprovision

        public VirtualMachineScaleSetUpdateProperties withOverprovision​(Boolean overprovision)
        Set the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
        Parameters:
        overprovision - the overprovision value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • doNotRunExtensionsOnOverprovisionedVMs

        public Boolean doNotRunExtensionsOnOverprovisionedVMs()
        Get the doNotRunExtensionsOnOverprovisionedVMs property: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
        Returns:
        the doNotRunExtensionsOnOverprovisionedVMs value.
      • withDoNotRunExtensionsOnOverprovisionedVMs

        public VirtualMachineScaleSetUpdateProperties withDoNotRunExtensionsOnOverprovisionedVMs​(Boolean doNotRunExtensionsOnOverprovisionedVMs)
        Set the doNotRunExtensionsOnOverprovisionedVMs property: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
        Parameters:
        doNotRunExtensionsOnOverprovisionedVMs - the doNotRunExtensionsOnOverprovisionedVMs value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • singlePlacementGroup

        public Boolean singlePlacementGroup()
        Get the singlePlacementGroup property: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
        Returns:
        the singlePlacementGroup value.
      • withSinglePlacementGroup

        public VirtualMachineScaleSetUpdateProperties withSinglePlacementGroup​(Boolean singlePlacementGroup)
        Set the singlePlacementGroup property: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
        Parameters:
        singlePlacementGroup - the singlePlacementGroup value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • additionalCapabilities

        public AdditionalCapabilities additionalCapabilities()
        Get the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
        Returns:
        the additionalCapabilities value.
      • withAdditionalCapabilities

        public VirtualMachineScaleSetUpdateProperties withAdditionalCapabilities​(AdditionalCapabilities additionalCapabilities)
        Set the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
        Parameters:
        additionalCapabilities - the additionalCapabilities value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • scaleInPolicy

        public ScaleInPolicy scaleInPolicy()
        Get the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
        Returns:
        the scaleInPolicy value.
      • withScaleInPolicy

        public VirtualMachineScaleSetUpdateProperties withScaleInPolicy​(ScaleInPolicy scaleInPolicy)
        Set the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
        Parameters:
        scaleInPolicy - the scaleInPolicy value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties 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 scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
        Returns:
        the proximityPlacementGroup value.
      • withProximityPlacementGroup

        public VirtualMachineScaleSetUpdateProperties withProximityPlacementGroup​(com.azure.core.management.SubResource proximityPlacementGroup)
        Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
        Parameters:
        proximityPlacementGroup - the proximityPlacementGroup value to set.
        Returns:
        the VirtualMachineScaleSetUpdateProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.