GetVirtualMachineScaleSetResult

data class GetVirtualMachineScaleSetResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val automaticRepairsPolicy: AutomaticRepairsPolicyResponse? = null, val constrainedMaximumCapacity: Boolean? = null, val doNotRunExtensionsOnOverprovisionedVMs: Boolean? = null, val extendedLocation: ExtendedLocationResponse? = null, val hostGroup: SubResourceResponse? = null, val id: String, val identity: VirtualMachineScaleSetIdentityResponse? = null, val location: String, val name: String, val orchestrationMode: String? = null, val overprovision: Boolean? = null, val plan: PlanResponse? = null, val platformFaultDomainCount: Int? = null, val priorityMixPolicy: PriorityMixPolicyResponse? = null, val provisioningState: String, val proximityPlacementGroup: SubResourceResponse? = null, val scaleInPolicy: ScaleInPolicyResponse? = null, val singlePlacementGroup: Boolean? = null, val sku: SkuResponse? = null, val spotRestorePolicy: SpotRestorePolicyResponse? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String, val upgradePolicy: UpgradePolicyResponse? = null, val virtualMachineProfile: VirtualMachineScaleSetVMProfileResponse? = null, val zoneBalance: Boolean? = null, val zones: List<String>? = null)

Describes a Virtual Machine Scale Set.

Constructors

Link copied to clipboard
constructor(additionalCapabilities: AdditionalCapabilitiesResponse? = null, automaticRepairsPolicy: AutomaticRepairsPolicyResponse? = null, constrainedMaximumCapacity: Boolean? = null, doNotRunExtensionsOnOverprovisionedVMs: Boolean? = null, extendedLocation: ExtendedLocationResponse? = null, hostGroup: SubResourceResponse? = null, id: String, identity: VirtualMachineScaleSetIdentityResponse? = null, location: String, name: String, orchestrationMode: String? = null, overprovision: Boolean? = null, plan: PlanResponse? = null, platformFaultDomainCount: Int? = null, priorityMixPolicy: PriorityMixPolicyResponse? = null, provisioningState: String, proximityPlacementGroup: SubResourceResponse? = null, scaleInPolicy: ScaleInPolicyResponse? = null, singlePlacementGroup: Boolean? = null, sku: SkuResponse? = null, spotRestorePolicy: SpotRestorePolicyResponse? = null, tags: Map<String, String>? = null, timeCreated: String, type: String, uniqueId: String, upgradePolicy: UpgradePolicyResponse? = null, virtualMachineProfile: VirtualMachineScaleSetVMProfileResponse? = null, zoneBalance: Boolean? = null, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

Policy for automatic repairs.

Link copied to clipboard

Optional property which must either be set to True or omitted.

Link copied to clipboard

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.

Link copied to clipboard

The extended location of the Virtual Machine Scale Set.

Link copied to clipboard

Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.

Link copied to clipboard
val id: String

Resource Id

Link copied to clipboard

The identity of the virtual machine scale set, if configured.

Link copied to clipboard

Resource location

Link copied to clipboard

Resource name

Link copied to clipboard

Specifies the orchestration mode for the virtual machine scale set.

Link copied to clipboard
val overprovision: Boolean? = null

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

Link copied to clipboard
val plan: PlanResponse? = null

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.

Link copied to clipboard

Fault Domain count for each placement group.

Link copied to clipboard

Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

Link copied to clipboard

The provisioning state, which only appears in the response.

Link copied to clipboard

Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.

Link copied to clipboard

Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

Link copied to clipboard

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.

Link copied to clipboard
val sku: SkuResponse? = null

The virtual machine scale set sku.

Link copied to clipboard

Specifies the Spot Restore properties for the virtual machine scale set.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags

Link copied to clipboard

Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.

Link copied to clipboard

Resource type

Link copied to clipboard

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

Link copied to clipboard

The upgrade policy.

Link copied to clipboard

The virtual machine profile.

Link copied to clipboard
val zoneBalance: Boolean? = null

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.

Link copied to clipboard
val zones: List<String>? = null

The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set