VirtualMachineScaleSetInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. core. management. Resource - com.
azure. resourcemanager. compute. fluent. models. VirtualMachineScaleSetInner
- com.
- com.
- com.
public final class VirtualMachineScaleSetInner
extends Resource
Describes a Virtual Machine Scale Set.
Constructor Summary
Constructor | Description |
---|---|
VirtualMachineScaleSetInner() |
Creates an instance of Virtual |
Method Summary
Modifier and Type | Method and Description |
---|---|
Additional |
additionalCapabilities()
Get the additional |
Automatic |
automaticRepairsPolicy()
Get the automatic |
Boolean |
constrainedMaximumCapacity()
Get the constrained |
Boolean |
doNotRunExtensionsOnOverprovisionedVMs()
Get the do |
String |
etag()
Get the etag property: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates. |
Extended |
extendedLocation()
Get the extended |
static
Virtual |
fromJson(JsonReader jsonReader)
Reads an instance of Virtual |
Sub |
hostGroup()
Get the host |
String |
id()
Get the id property: Fully qualified resource Id for the resource. |
Virtual |
identity()
Get the identity property: The identity of the virtual machine scale set, if configured. |
String |
name()
Get the name property: The name of the resource. |
Orchestration |
orchestrationMode()
Get the orchestration |
Boolean |
overprovision()
Get the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
Plan |
plan()
Get the plan property: Specifies information about the marketplace image used to create the virtual machine. |
Integer |
platformFaultDomainCount()
Get the platform |
Priority |
priorityMixPolicy()
Get the priority |
String |
provisioningState()
Get the provisioning |
Sub |
proximityPlacementGroup()
Get the proximity |
Resiliency |
resiliencyPolicy()
Get the resiliency |
Scale |
scaleInPolicy()
Get the scale |
Scheduled |
scheduledEventsPolicy()
Get the scheduled |
Boolean |
singlePlacementGroup()
Get the single |
Sku |
sku()
Get the sku property: The virtual machine scale set sku. |
Sku |
skuProfile()
Get the sku |
Spot |
spotRestorePolicy()
Get the spot |
Offset |
timeCreated()
Get the time |
Json |
toJson(JsonWriter jsonWriter) |
String |
type()
Get the type property: The type of the resource. |
String |
uniqueId()
Get the unique |
Upgrade |
upgradePolicy()
Get the upgrade |
void |
validate()
Validates the instance. |
Virtual |
virtualMachineProfile()
Get the virtual |
Virtual |
withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)
Set the additional |
Virtual |
withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy)
Set the automatic |
Virtual |
withConstrainedMaximumCapacity(Boolean constrainedMaximumCapacity)
Set the constrained |
Virtual |
withDoNotRunExtensionsOnOverprovisionedVMs(Boolean doNotRunExtensionsOnOverprovisionedVMs)
Set the do |
Virtual |
withExtendedLocation(ExtendedLocation extendedLocation)
Set the extended |
Virtual |
withHostGroup(SubResource hostGroup)
Set the host |
Virtual |
withIdentity(VirtualMachineScaleSetIdentity identity)
Set the identity property: The identity of the virtual machine scale set, if configured. |
Virtual |
withLocation(String location) |
Virtual |
withOrchestrationMode(OrchestrationMode orchestrationMode)
Set the orchestration |
Virtual |
withOverprovision(Boolean overprovision)
Set the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
Virtual |
withPlan(Plan plan)
Set the plan property: Specifies information about the marketplace image used to create the virtual machine. |
Virtual |
withPlatformFaultDomainCount(Integer platformFaultDomainCount)
Set the platform |
Virtual |
withPriorityMixPolicy(PriorityMixPolicy priorityMixPolicy)
Set the priority |
Virtual |
withProximityPlacementGroup(SubResource proximityPlacementGroup)
Set the proximity |
Virtual |
withResiliencyPolicy(ResiliencyPolicy resiliencyPolicy)
Set the resiliency |
Virtual |
withScaleInPolicy(ScaleInPolicy scaleInPolicy)
Set the scale |
Virtual |
withScheduledEventsPolicy(ScheduledEventsPolicy scheduledEventsPolicy)
Set the scheduled |
Virtual |
withSinglePlacementGroup(Boolean singlePlacementGroup)
Set the single |
Virtual |
withSku(Sku sku)
Set the sku property: The virtual machine scale set sku. |
Virtual |
withSkuProfile(SkuProfile skuProfile)
Set the sku |
Virtual |
withSpotRestorePolicy(SpotRestorePolicy spotRestorePolicy)
Set the spot |
Virtual |
withTags(Map<String,String> tags) |
Virtual |
withUpgradePolicy(UpgradePolicy upgradePolicy)
Set the upgrade |
Virtual |
withVirtualMachineProfile(VirtualMachineScaleSetVMProfile virtualMachineProfile)
Set the virtual |
Virtual |
withZonalPlatformFaultDomainAlignMode(ZonalPlatformFaultDomainAlignMode zonalPlatformFaultDomainAlignMode)
Set the zonal |
Virtual |
withZoneBalance(Boolean zoneBalance)
Set the zone |
Virtual |
withZones(List<String> zones)
Set the zones property: The virtual machine scale set zones. |
Zonal |
zonalPlatformFaultDomainAlignMode()
Get the zonal |
Boolean |
zoneBalance()
Get the zone |
List<String> |
zones()
Get the zones property: The virtual machine scale set zones. |
Methods inherited from ProxyResource
Methods inherited from Resource
Methods inherited from java.lang.Object
Constructor Details
VirtualMachineScaleSetInner
public VirtualMachineScaleSetInner()
Creates an instance of VirtualMachineScaleSetInner class.
Method Details
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:
automaticRepairsPolicy
public AutomaticRepairsPolicy automaticRepairsPolicy()
Get the automaticRepairsPolicy property: Policy for automatic repairs.
Returns:
constrainedMaximumCapacity
public Boolean constrainedMaximumCapacity()
Get the constrainedMaximumCapacity property: Optional property which must either be set to True or omitted.
Returns:
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:
etag
public String etag()
Get the etag property: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates.
Returns:
extendedLocation
public ExtendedLocation extendedLocation()
Get the extendedLocation property: The extended location of the Virtual Machine Scale Set.
Returns:
fromJson
public static VirtualMachineScaleSetInner fromJson(JsonReader jsonReader)
Reads an instance of VirtualMachineScaleSetInner from the JsonReader.
Parameters:
Returns:
Throws:
hostGroup
public SubResource hostGroup()
Get the hostGroup property: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
Returns:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
VirtualMachineScaleSetInner.id()Returns:
identity
public VirtualMachineScaleSetIdentity identity()
Get the identity property: The identity of the virtual machine scale set, if configured.
Returns:
name
public String name()
Get the name property: The name of the resource.
Overrides:
VirtualMachineScaleSetInner.name()Returns:
orchestrationMode
public OrchestrationMode orchestrationMode()
Get the orchestrationMode property: Specifies the orchestration mode for the virtual machine scale set.
Returns:
overprovision
public Boolean overprovision()
Get the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Returns:
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:
platformFaultDomainCount
public Integer platformFaultDomainCount()
Get the platformFaultDomainCount property: Fault Domain count for each placement group.
Returns:
priorityMixPolicy
public PriorityMixPolicy priorityMixPolicy()
Get the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
Returns:
provisioningState
public String provisioningState()
Get the provisioningState property: The provisioning state, which only appears in the response.
Returns:
proximityPlacementGroup
public SubResource proximityPlacementGroup()
Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
Returns:
resiliencyPolicy
public ResiliencyPolicy resiliencyPolicy()
Get the resiliencyPolicy property: Policy for Resiliency.
Returns:
scaleInPolicy
public ScaleInPolicy scaleInPolicy()
Get the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
Returns:
scheduledEventsPolicy
public ScheduledEventsPolicy scheduledEventsPolicy()
Get the scheduledEventsPolicy property: The ScheduledEventsPolicy.
Returns:
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:
sku
public Sku sku()
Get the sku property: The virtual machine scale set sku.
Returns:
skuProfile
public SkuProfile skuProfile()
Get the skuProfile property: Specifies the sku profile for the virtual machine scale set.
Returns:
spotRestorePolicy
public SpotRestorePolicy spotRestorePolicy()
Get the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.
Returns:
timeCreated
public OffsetDateTime timeCreated()
Get the timeCreated property: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
Returns:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
VirtualMachineScaleSetInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
VirtualMachineScaleSetInner.type()Returns:
uniqueId
public String uniqueId()
Get the uniqueId property: Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
Returns:
upgradePolicy
public UpgradePolicy upgradePolicy()
Get the upgradePolicy property: The upgrade policy.
Returns:
validate
public void validate()
Validates the instance.
virtualMachineProfile
public VirtualMachineScaleSetVMProfile virtualMachineProfile()
Get the virtualMachineProfile property: The virtual machine profile.
Returns:
withAdditionalCapabilities
public VirtualMachineScaleSetInner 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:
Returns:
withAutomaticRepairsPolicy
public VirtualMachineScaleSetInner withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy)
Set the automaticRepairsPolicy property: Policy for automatic repairs.
Parameters:
Returns:
withConstrainedMaximumCapacity
public VirtualMachineScaleSetInner withConstrainedMaximumCapacity(Boolean constrainedMaximumCapacity)
Set the constrainedMaximumCapacity property: Optional property which must either be set to True or omitted.
Parameters:
Returns:
withDoNotRunExtensionsOnOverprovisionedVMs
public VirtualMachineScaleSetInner 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:
Returns:
withExtendedLocation
public VirtualMachineScaleSetInner withExtendedLocation(ExtendedLocation extendedLocation)
Set the extendedLocation property: The extended location of the Virtual Machine Scale Set.
Parameters:
Returns:
withHostGroup
public VirtualMachineScaleSetInner withHostGroup(SubResource hostGroup)
Set the hostGroup property: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
Parameters:
Returns:
withIdentity
public VirtualMachineScaleSetInner withIdentity(VirtualMachineScaleSetIdentity identity)
Set the identity property: The identity of the virtual machine scale set, if configured.
Parameters:
Returns:
withLocation
public VirtualMachineScaleSetInner withLocation(String location)
Overrides:
VirtualMachineScaleSetInner.withLocation(String location)Parameters:
withOrchestrationMode
public VirtualMachineScaleSetInner withOrchestrationMode(OrchestrationMode orchestrationMode)
Set the orchestrationMode property: Specifies the orchestration mode for the virtual machine scale set.
Parameters:
Returns:
withOverprovision
public VirtualMachineScaleSetInner withOverprovision(Boolean overprovision)
Set the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Parameters:
Returns:
withPlan
public VirtualMachineScaleSetInner 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:
Returns:
withPlatformFaultDomainCount
public VirtualMachineScaleSetInner withPlatformFaultDomainCount(Integer platformFaultDomainCount)
Set the platformFaultDomainCount property: Fault Domain count for each placement group.
Parameters:
Returns:
withPriorityMixPolicy
public VirtualMachineScaleSetInner withPriorityMixPolicy(PriorityMixPolicy priorityMixPolicy)
Set the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
Parameters:
Returns:
withProximityPlacementGroup
public VirtualMachineScaleSetInner withProximityPlacementGroup(SubResource proximityPlacementGroup)
Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
Parameters:
Returns:
withResiliencyPolicy
public VirtualMachineScaleSetInner withResiliencyPolicy(ResiliencyPolicy resiliencyPolicy)
Set the resiliencyPolicy property: Policy for Resiliency.
Parameters:
Returns:
withScaleInPolicy
public VirtualMachineScaleSetInner withScaleInPolicy(ScaleInPolicy scaleInPolicy)
Set the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
Parameters:
Returns:
withScheduledEventsPolicy
public VirtualMachineScaleSetInner withScheduledEventsPolicy(ScheduledEventsPolicy scheduledEventsPolicy)
Set the scheduledEventsPolicy property: The ScheduledEventsPolicy.
Parameters:
Returns:
withSinglePlacementGroup
public VirtualMachineScaleSetInner 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:
Returns:
withSku
public VirtualMachineScaleSetInner withSku(Sku sku)
Set the sku property: The virtual machine scale set sku.
Parameters:
Returns:
withSkuProfile
public VirtualMachineScaleSetInner withSkuProfile(SkuProfile skuProfile)
Set the skuProfile property: Specifies the sku profile for the virtual machine scale set.
Parameters:
Returns:
withSpotRestorePolicy
public VirtualMachineScaleSetInner withSpotRestorePolicy(SpotRestorePolicy spotRestorePolicy)
Set the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.
Parameters:
Returns:
withTags
public VirtualMachineScaleSetInner withTags(Map
Overrides:
VirtualMachineScaleSetInner.withTags(Map<String,String> tags)Parameters:
withUpgradePolicy
public VirtualMachineScaleSetInner withUpgradePolicy(UpgradePolicy upgradePolicy)
Set the upgradePolicy property: The upgrade policy.
Parameters:
Returns:
withVirtualMachineProfile
public VirtualMachineScaleSetInner withVirtualMachineProfile(VirtualMachineScaleSetVMProfile virtualMachineProfile)
Set the virtualMachineProfile property: The virtual machine profile.
Parameters:
Returns:
withZonalPlatformFaultDomainAlignMode
public VirtualMachineScaleSetInner withZonalPlatformFaultDomainAlignMode(ZonalPlatformFaultDomainAlignMode zonalPlatformFaultDomainAlignMode)
Set the zonalPlatformFaultDomainAlignMode property: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
Parameters:
Returns:
withZoneBalance
public VirtualMachineScaleSetInner withZoneBalance(Boolean zoneBalance)
Set the zoneBalance property: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
Parameters:
Returns:
withZones
public VirtualMachineScaleSetInner withZones(List
Set the zones property: The virtual machine scale set zones.
Parameters:
Returns:
zonalPlatformFaultDomainAlignMode
public ZonalPlatformFaultDomainAlignMode zonalPlatformFaultDomainAlignMode()
Get the zonalPlatformFaultDomainAlignMode property: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
Returns:
zoneBalance
public Boolean zoneBalance()
Get the zoneBalance property: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
Returns:
zones
public List
Get the zones property: The virtual machine scale set zones.
Returns:
Applies to
Azure SDK for Java