pulumi-azure-kotlin/com.pulumi.azure.compute.kotlin/OrchestratedVirtualMachineScaleSetArgs

OrchestratedVirtualMachineScaleSetArgs

data class OrchestratedVirtualMachineScaleSetArgs(val additionalCapabilities: Output<OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null, val automaticInstanceRepair: Output<OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null, val bootDiagnostics: Output<OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs>? = null, val capacityReservationGroupId: Output<String>? = null, val dataDisks: Output<List<OrchestratedVirtualMachineScaleSetDataDiskArgs>>? = null, val encryptionAtHostEnabled: Output<Boolean>? = null, val evictionPolicy: Output<String>? = null, val extensionOperationsEnabled: Output<Boolean>? = null, val extensions: Output<List<OrchestratedVirtualMachineScaleSetExtensionArgs>>? = null, val extensionsTimeBudget: Output<String>? = null, val identity: Output<OrchestratedVirtualMachineScaleSetIdentityArgs>? = null, val instances: Output<Int>? = null, val licenseType: Output<String>? = null, val location: Output<String>? = null, val maxBidPrice: Output<Double>? = null, val name: Output<String>? = null, val networkInterfaces: Output<List<OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs>>? = null, val osDisk: Output<OrchestratedVirtualMachineScaleSetOsDiskArgs>? = null, val osProfile: Output<OrchestratedVirtualMachineScaleSetOsProfileArgs>? = null, val plan: Output<OrchestratedVirtualMachineScaleSetPlanArgs>? = null, val platformFaultDomainCount: Output<Int>? = null, val priority: Output<String>? = null, val priorityMix: Output<OrchestratedVirtualMachineScaleSetPriorityMixArgs>? = null, val proximityPlacementGroupId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val singlePlacementGroup: Output<Boolean>? = null, val skuName: Output<String>? = null, val sourceImageId: Output<String>? = null, val sourceImageReference: Output<OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs>? = null, val tags: Output<Map<String, String>>? = null, val terminationNotification: Output<OrchestratedVirtualMachineScaleSetTerminationNotificationArgs>? = null, val userDataBase64: Output<String>? = null, val zoneBalance: Output<Boolean>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<OrchestratedVirtualMachineScaleSetArgs>

Manages an Orchestrated Virtual Machine Scale Set.

Disclaimers

NOTE: As of the v2.86.0 (November 19, 2021) release of the provider this resource will only create Virtual Machine Scale Sets with the Flexible Orchestration Mode. NOTE: All arguments including the administrator login and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSet;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleOrchestratedVirtualMachineScaleSet = new OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", OrchestratedVirtualMachineScaleSetArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .platformFaultDomainCount(1)
            .zones("1")
            .build());
    }
}
Content copied to clipboard

Import

An Orchestrated Virtual Machine Scale Set can be imported using the resource id, e.g.

$ pulumi import azure:compute/orchestratedVirtualMachineScaleSet:OrchestratedVirtualMachineScaleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleset1
Content copied to clipboard

Constructors

Link copied to clipboard
fun OrchestratedVirtualMachineScaleSetArgs(additionalCapabilities: Output<OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null, automaticInstanceRepair: Output<OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null, bootDiagnostics: Output<OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs>? = null, capacityReservationGroupId: Output<String>? = null, dataDisks: Output<List<OrchestratedVirtualMachineScaleSetDataDiskArgs>>? = null, encryptionAtHostEnabled: Output<Boolean>? = null, evictionPolicy: Output<String>? = null, extensionOperationsEnabled: Output<Boolean>? = null, extensions: Output<List<OrchestratedVirtualMachineScaleSetExtensionArgs>>? = null, extensionsTimeBudget: Output<String>? = null, identity: Output<OrchestratedVirtualMachineScaleSetIdentityArgs>? = null, instances: Output<Int>? = null, licenseType: Output<String>? = null, location: Output<String>? = null, maxBidPrice: Output<Double>? = null, name: Output<String>? = null, networkInterfaces: Output<List<OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs>>? = null, osDisk: Output<OrchestratedVirtualMachineScaleSetOsDiskArgs>? = null, osProfile: Output<OrchestratedVirtualMachineScaleSetOsProfileArgs>? = null, plan: Output<OrchestratedVirtualMachineScaleSetPlanArgs>? = null, platformFaultDomainCount: Output<Int>? = null, priority: Output<String>? = null, priorityMix: Output<OrchestratedVirtualMachineScaleSetPriorityMixArgs>? = null, proximityPlacementGroupId: Output<String>? = null, resourceGroupName: Output<String>? = null, singlePlacementGroup: Output<Boolean>? = null, skuName: Output<String>? = null, sourceImageId: Output<String>? = null, sourceImageReference: Output<OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs>? = null, tags: Output<Map<String, String>>? = null, terminationNotification: Output<OrchestratedVirtualMachineScaleSetTerminationNotificationArgs>? = null, userDataBase64: Output<String>? = null, zoneBalance: Output<Boolean>? = null, zones: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): OrchestratedVirtualMachineScaleSetArgs

Properties

Link copied to clipboard
val additionalCapabilities: Output<OrchestratedVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null

An additional_capabilities block as defined below.

Link copied to clipboard
val automaticInstanceRepair: Output<OrchestratedVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null

An automatic_instance_repair block as defined below.

Link copied to clipboard
val bootDiagnostics: Output<OrchestratedVirtualMachineScaleSetBootDiagnosticsArgs>? = null

A boot_diagnostics block as defined below.

Link copied to clipboard
val capacityReservationGroupId: Output<String>? = null

Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.

Link copied to clipboard
val dataDisks: Output<List<OrchestratedVirtualMachineScaleSetDataDiskArgs>>? = null

One or more data_disk blocks as defined below.

Link copied to clipboard
val encryptionAtHostEnabled: Output<Boolean>? = null

Should disks attached to this Virtual Machine Scale Set be encrypted by enabling Encryption at Host?

Link copied to clipboard
val evictionPolicy: Output<String>? = null

The Policy which should be used Virtual Machines are Evicted from the Scale Set. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

Link copied to clipboard
val extensionOperationsEnabled: Output<Boolean>? = null

Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are true or false. Defaults to true. Changing this forces a new Orchestrated Virtual Machine Scale Set to be created.

Link copied to clipboard
val extensions: Output<List<OrchestratedVirtualMachineScaleSetExtensionArgs>>? = null

One or more extension blocks as defined below

Link copied to clipboard
val extensionsTimeBudget: Output<String>? = null

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).

Link copied to clipboard
val identity: Output<OrchestratedVirtualMachineScaleSetIdentityArgs>? = null

An identity block as defined below.

Link copied to clipboard
val instances: Output<Int>? = null

The number of Virtual Machines in the Orcestrated Virtual Machine Scale Set.

Link copied to clipboard
val licenseType: Output<String>? = null

Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Orchestrated Virtual Machine Scale Set. Possible values are None, Windows_Client and Windows_Server.

Link copied to clipboard
val location: Output<String>? = null

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val maxBidPrice: Output<Double>? = null

The maximum price you're willing to pay for each Orchestrated Virtual Machine in this Scale Set, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machines in the Scale Set will be evicted using the eviction_policy. Defaults to -1, which means that each Virtual Machine in the Orchestrated Scale Set should not be evicted for price reasons.

Link copied to clipboard
val name: Output<String>? = null

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

Link copied to clipboard
val networkInterfaces: Output<List<OrchestratedVirtualMachineScaleSetNetworkInterfaceArgs>>? = null

One or more network_interface blocks as defined below.

Link copied to clipboard
val osDisk: Output<OrchestratedVirtualMachineScaleSetOsDiskArgs>? = null

An os_disk block as defined below.

Link copied to clipboard
val osProfile: Output<OrchestratedVirtualMachineScaleSetOsProfileArgs>? = null

An os_profile block as defined below.

Link copied to clipboard
val plan: Output<OrchestratedVirtualMachineScaleSetPlanArgs>? = null

A plan block as documented below. Changing this forces a new resource to be created.

Link copied to clipboard
val platformFaultDomainCount: Output<Int>? = null

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

Link copied to clipboard
val priority: Output<String>? = null

The Priority of this Orchestrated Virtual Machine Scale Set. Possible values are Regular and Spot. Defaults to Regular. Changing this value forces a new resource.

Link copied to clipboard
val priorityMix: Output<OrchestratedVirtualMachineScaleSetPriorityMixArgs>? = null

a priority_mix block as defined below

Link copied to clipboard
val proximityPlacementGroupId: Output<String>? = null

The ID of the Proximity Placement Group which the Orchestrated Virtual Machine should be assigned to. Changing this forces a new resource to be created.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val singlePlacementGroup: Output<Boolean>? = null

Should this Virtual Machine Scale Set be limited to a Single Placement Group, which means the number of instances will be capped at 100 Virtual Machines. Possible values are true or false.

Link copied to clipboard
val skuName: Output<String>? = null

The name of the SKU to be used by this Orcestrated Virtual Machine Scale Set. Valid values include: any of the General purpose, Compute optimized, Memory optimized, Storage optimized, GPU optimized, FPGA optimized, High performance, or Previous generation virtual machine SKUs.

Link copied to clipboard
val sourceImageId: Output<String>? = null

The ID of an Image which each Virtual Machine in this Scale Set should be based on. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

Link copied to clipboard
val sourceImageReference: Output<OrchestratedVirtualMachineScaleSetSourceImageReferenceArgs>? = null

A source_image_reference block as defined below.

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

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

Link copied to clipboard
val terminationNotification: Output<OrchestratedVirtualMachineScaleSetTerminationNotificationArgs>? = null

A termination_notification block as defined below.

Link copied to clipboard
val userDataBase64: Output<String>? = null

The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.

Link copied to clipboard
val zoneBalance: Output<Boolean>? = null

Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to false. Changing this forces a new resource to be created.

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

Specifies a list of Availability Zones in which this Orchestrated Virtual Machine should be located. Changing this forces a new Orchestrated Virtual Machine to be created.