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

WindowsVirtualMachineScaleSetArgs

data class WindowsVirtualMachineScaleSetArgs(val additionalCapabilities: Output<WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null, val additionalUnattendContents: Output<List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>>? = null, val adminPassword: Output<String>? = null, val adminUsername: Output<String>? = null, val automaticInstanceRepair: Output<WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null, val automaticOsUpgradePolicy: Output<WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs>? = null, val bootDiagnostics: Output<WindowsVirtualMachineScaleSetBootDiagnosticsArgs>? = null, val capacityReservationGroupId: Output<String>? = null, val computerNamePrefix: Output<String>? = null, val customData: Output<String>? = null, val dataDisks: Output<List<WindowsVirtualMachineScaleSetDataDiskArgs>>? = null, val doNotRunExtensionsOnOverprovisionedMachines: Output<Boolean>? = null, val edgeZone: Output<String>? = null, val enableAutomaticUpdates: Output<Boolean>? = null, val encryptionAtHostEnabled: Output<Boolean>? = null, val evictionPolicy: Output<String>? = null, val extensionOperationsEnabled: Output<Boolean>? = null, val extensions: Output<List<WindowsVirtualMachineScaleSetExtensionArgs>>? = null, val extensionsTimeBudget: Output<String>? = null, val galleryApplication: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null, val galleryApplications: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null, val healthProbeId: Output<String>? = null, val hostGroupId: Output<String>? = null, val identity: Output<WindowsVirtualMachineScaleSetIdentityArgs>? = 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<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>>? = null, val osDisk: Output<WindowsVirtualMachineScaleSetOsDiskArgs>? = null, val overprovision: Output<Boolean>? = null, val plan: Output<WindowsVirtualMachineScaleSetPlanArgs>? = null, val platformFaultDomainCount: Output<Int>? = null, val priority: Output<String>? = null, val provisionVmAgent: Output<Boolean>? = null, val proximityPlacementGroupId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val rollingUpgradePolicy: Output<WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs>? = null, val scaleIn: Output<WindowsVirtualMachineScaleSetScaleInArgs>? = null, val scaleInPolicy: Output<String>? = null, val secrets: Output<List<WindowsVirtualMachineScaleSetSecretArgs>>? = null, val secureBootEnabled: Output<Boolean>? = null, val singlePlacementGroup: Output<Boolean>? = null, val sku: Output<String>? = null, val sourceImageId: Output<String>? = null, val sourceImageReference: Output<WindowsVirtualMachineScaleSetSourceImageReferenceArgs>? = null, val spotRestore: Output<WindowsVirtualMachineScaleSetSpotRestoreArgs>? = null, val tags: Output<Map<String, String>>? = null, val terminateNotification: Output<WindowsVirtualMachineScaleSetTerminateNotificationArgs>? = null, val terminationNotification: Output<WindowsVirtualMachineScaleSetTerminationNotificationArgs>? = null, val timezone: Output<String>? = null, val upgradeMode: Output<String>? = null, val userData: Output<String>? = null, val vtpmEnabled: Output<Boolean>? = null, val winrmListeners: Output<List<WindowsVirtualMachineScaleSetWinrmListenerArgs>>? = null, val zoneBalance: Output<Boolean>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<WindowsVirtualMachineScaleSetArgs>

Manages a Windows Virtual Machine Scale Set.

Disclaimers

NOTE:: All arguments including the administrator login and password will be stored in the raw state as plain-text. NOTE: This provider will automatically update & reimage the nodes in the Scale Set (if Required) during an Update - this behaviour can be configured using the features setting within the Provider block. NOTE: This resource does not support Unmanaged Disks. If you need to use Unmanaged Disks you can continue to use the azure.compute.ScaleSet resource instead

Example Usage

This example provisions a basic Windows Virtual Machine Scale Set on an internal network.

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.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.compute.WindowsVirtualMachineScaleSet;
import com.pulumi.azure.compute.WindowsVirtualMachineScaleSetArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetSourceImageReferenceArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetOsDiskArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs;
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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .addressSpaces("10.0.0.0/16")
            .build());
        var internal = new Subnet("internal", SubnetArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());
        var exampleWindowsVirtualMachineScaleSet = new WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", WindowsVirtualMachineScaleSetArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .sku("Standard_F2")
            .instances(1)
            .adminPassword("P@55w0rd1234!")
            .adminUsername("adminuser")
            .sourceImageReference(WindowsVirtualMachineScaleSetSourceImageReferenceArgs.builder()
                .publisher("MicrosoftWindowsServer")
                .offer("WindowsServer")
                .sku("2016-Datacenter-Server-Core")
                .version("latest")
                .build())
            .osDisk(WindowsVirtualMachineScaleSetOsDiskArgs.builder()
                .storageAccountType("Standard_LRS")
                .caching("ReadWrite")
                .build())
            .networkInterfaces(WindowsVirtualMachineScaleSetNetworkInterfaceArgs.builder()
                .name("example")
                .primary(true)
                .ipConfigurations(WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
                    .name("internal")
                    .primary(true)
                    .subnetId(internal.id())
                    .build())
                .build())
            .build());
    }
}

Import

Windows Virtual Machine Scale Sets can be imported using the resource id, e.g.

$ pulumi import azure:compute/windowsVirtualMachineScaleSet:WindowsVirtualMachineScaleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleset1

Constructors

WindowsVirtualMachineScaleSetArgs

fun WindowsVirtualMachineScaleSetArgs(additionalCapabilities: Output<WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null, additionalUnattendContents: Output<List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>>? = null, adminPassword: Output<String>? = null, adminUsername: Output<String>? = null, automaticInstanceRepair: Output<WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null, automaticOsUpgradePolicy: Output<WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs>? = null, bootDiagnostics: Output<WindowsVirtualMachineScaleSetBootDiagnosticsArgs>? = null, capacityReservationGroupId: Output<String>? = null, computerNamePrefix: Output<String>? = null, customData: Output<String>? = null, dataDisks: Output<List<WindowsVirtualMachineScaleSetDataDiskArgs>>? = null, doNotRunExtensionsOnOverprovisionedMachines: Output<Boolean>? = null, edgeZone: Output<String>? = null, enableAutomaticUpdates: Output<Boolean>? = null, encryptionAtHostEnabled: Output<Boolean>? = null, evictionPolicy: Output<String>? = null, extensionOperationsEnabled: Output<Boolean>? = null, extensions: Output<List<WindowsVirtualMachineScaleSetExtensionArgs>>? = null, extensionsTimeBudget: Output<String>? = null, galleryApplication: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null, galleryApplications: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null, healthProbeId: Output<String>? = null, hostGroupId: Output<String>? = null, identity: Output<WindowsVirtualMachineScaleSetIdentityArgs>? = null, instances: Output<Int>? = null, licenseType: Output<String>? = null, location: Output<String>? = null, maxBidPrice: Output<Double>? = null, name: Output<String>? = null, networkInterfaces: Output<List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>>? = null, osDisk: Output<WindowsVirtualMachineScaleSetOsDiskArgs>? = null, overprovision: Output<Boolean>? = null, plan: Output<WindowsVirtualMachineScaleSetPlanArgs>? = null, platformFaultDomainCount: Output<Int>? = null, priority: Output<String>? = null, provisionVmAgent: Output<Boolean>? = null, proximityPlacementGroupId: Output<String>? = null, resourceGroupName: Output<String>? = null, rollingUpgradePolicy: Output<WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs>? = null, scaleIn: Output<WindowsVirtualMachineScaleSetScaleInArgs>? = null, scaleInPolicy: Output<String>? = null, secrets: Output<List<WindowsVirtualMachineScaleSetSecretArgs>>? = null, secureBootEnabled: Output<Boolean>? = null, singlePlacementGroup: Output<Boolean>? = null, sku: Output<String>? = null, sourceImageId: Output<String>? = null, sourceImageReference: Output<WindowsVirtualMachineScaleSetSourceImageReferenceArgs>? = null, spotRestore: Output<WindowsVirtualMachineScaleSetSpotRestoreArgs>? = null, tags: Output<Map<String, String>>? = null, terminateNotification: Output<WindowsVirtualMachineScaleSetTerminateNotificationArgs>? = null, terminationNotification: Output<WindowsVirtualMachineScaleSetTerminationNotificationArgs>? = null, timezone: Output<String>? = null, upgradeMode: Output<String>? = null, userData: Output<String>? = null, vtpmEnabled: Output<Boolean>? = null, winrmListeners: Output<List<WindowsVirtualMachineScaleSetWinrmListenerArgs>>? = null, zoneBalance: Output<Boolean>? = null, zones: Output<List<String>>? = null)

Functions

toJava

open override fun toJava(): WindowsVirtualMachineScaleSetArgs

Properties

additionalCapabilities

val additionalCapabilities: Output<WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs>? = null

An additional_capabilities block as defined below.

additionalUnattendContents

val additionalUnattendContents: Output<List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>>? = null

One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.

adminPassword

val adminPassword: Output<String>? = null

The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.

adminUsername

val adminUsername: Output<String>? = null

The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.

automaticInstanceRepair

val automaticInstanceRepair: Output<WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs>? = null

An automatic_instance_repair block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a valid health_probe_id or an Application Health Extension.

automaticOsUpgradePolicy

val automaticOsUpgradePolicy: Output<WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs>? = null

An automatic_os_upgrade_policy block as defined below. This can only be specified when upgrade_mode is set to either Automatic or Rolling.

bootDiagnostics

val bootDiagnostics: Output<WindowsVirtualMachineScaleSetBootDiagnosticsArgs>? = null

A boot_diagnostics block as defined below.

capacityReservationGroupId

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.

computerNamePrefix

val computerNamePrefix: Output<String>? = null

The prefix which should be used for the name of the Virtual Machines in this Scale Set. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name_prefix, then you must specify computer_name_prefix. Changing this forces a new resource to be created.

customData

val customData: Output<String>? = null

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

dataDisks

val dataDisks: Output<List<WindowsVirtualMachineScaleSetDataDiskArgs>>? = null

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines

val doNotRunExtensionsOnOverprovisionedMachines: Output<Boolean>? = null

Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to false.

edgeZone

val edgeZone: Output<String>? = null

Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.

enableAutomaticUpdates

val enableAutomaticUpdates: Output<Boolean>? = null

Are automatic updates enabled for this Virtual Machine? Defaults to true.

encryptionAtHostEnabled

val encryptionAtHostEnabled: Output<Boolean>? = null

Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?

evictionPolicy

val evictionPolicy: Output<String>? = null

Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

extensionOperationsEnabled

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 Windows Virtual Machine Scale Set to be created.

extensions

val extensions: Output<List<WindowsVirtualMachineScaleSetExtensionArgs>>? = null

One or more extension blocks as defined below

extensionsTimeBudget

val extensionsTimeBudget: Output<String>? = null

Specifies the duration allocated 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. Defaults to 90 minutes (PT1H30M).

galleryApplication

val galleryApplication: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null

One or more gallery_application blocks as defined below.

galleryApplications

val ~~galleryApplications~~: Output<List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>>? = null

healthProbeId

val healthProbeId: Output<String>? = null

The ID of a Load Balancer Probe which should be used to determine the health of an instance. This is Required and can only be specified when upgrade_mode is set to Automatic or Rolling.

hostGroupId

val hostGroupId: Output<String>? = null

Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.

identity

val identity: Output<WindowsVirtualMachineScaleSetIdentityArgs>? = null

An identity block as defined below.

instances

val instances: Output<Int>? = null

The number of Virtual Machines in the Scale Set.

licenseType

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 Virtual Machine Scale Set. Possible values are None, Windows_Client and Windows_Server.

location

val location: Output<String>? = null

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

maxBidPrice

val maxBidPrice: Output<Double>? = null

The maximum price you're willing to pay for each 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 Scale Set should not be evicted for price reasons.

name

val name: Output<String>? = null

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

networkInterfaces

val networkInterfaces: Output<List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>>? = null

One or more network_interface blocks as defined below.

osDisk

val osDisk: Output<WindowsVirtualMachineScaleSetOsDiskArgs>? = null

An os_disk block as defined below.

overprovision

val overprovision: Output<Boolean>? = null

Should Azure over-provision Virtual Machines in this Scale Set? This means that multiple Virtual Machines will be provisioned and Azure will keep the instances which become available first - which improves provisioning success rates and improves deployment time. You're not billed for these over-provisioned VM's and they don't count towards the Subscription Quota. Defaults to true.

plan

val plan: Output<WindowsVirtualMachineScaleSetPlanArgs>? = null

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

platformFaultDomainCount

val platformFaultDomainCount: Output<Int>? = null

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

priority

val priority: Output<String>? = null

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

provisionVmAgent

val provisionVmAgent: Output<Boolean>? = null

Should the Azure VM Agent be provisioned on each Virtual Machine in the Scale Set? Defaults to true. Changing this value forces a new resource to be created.

proximityPlacementGroupId

val proximityPlacementGroupId: Output<String>? = null

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

resourceGroupName

val resourceGroupName: Output<String>? = null

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

rollingUpgradePolicy

val rollingUpgradePolicy: Output<WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs>? = null

A rolling_upgrade_policy block as defined below. This is Required and can only be specified when upgrade_mode is set to Automatic or Rolling. Changing this forces a new resource to be created.

scaleIn

val scaleIn: Output<WindowsVirtualMachineScaleSetScaleInArgs>? = null

A scale_in block as defined below.

scaleInPolicy

val ~~scaleInPolicy~~: Output<String>? = null

secrets

val secrets: Output<List<WindowsVirtualMachineScaleSetSecretArgs>>? = null

One or more secret blocks as defined below.

secureBootEnabled

val secureBootEnabled: Output<Boolean>? = null

Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

singlePlacementGroup

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. Defaults to true.

sku

val sku: Output<String>? = null

The Virtual Machine SKU for the Scale Set, such as Standard_F2.

sourceImageId

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.

sourceImageReference

val sourceImageReference: Output<WindowsVirtualMachineScaleSetSourceImageReferenceArgs>? = null

A source_image_reference block as defined below.

spotRestore

val spotRestore: Output<WindowsVirtualMachineScaleSetSpotRestoreArgs>? = null

A spot_restore block as defined below.