Azure Classic v5.43.0, May 6 23

azure.compute.WindowsVirtualMachineScaleSet

Explore with Pulumi AI

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.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });

    var @internal = new Azure.Network.Subnet("internal", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
    });

    var exampleWindowsVirtualMachineScaleSet = new Azure.Compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Sku = "Standard_F2",
        Instances = 1,
        AdminPassword = "P@55w0rd1234!",
        AdminUsername = "adminuser",
        SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetSourceImageReferenceArgs
        {
            Publisher = "MicrosoftWindowsServer",
            Offer = "WindowsServer",
            Sku = "2016-Datacenter-Server-Core",
            Version = "latest",
        },
        OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetOsDiskArgs
        {
            StorageAccountType = "Standard_LRS",
            Caching = "ReadWrite",
        },
        NetworkInterfaces = new[]
        {
            new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs
            {
                Name = "example",
                Primary = true,
                IpConfigurations = new[]
                {
                    new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
                    {
                        Name = "internal",
                        Primary = true,
                        SubnetId = @internal.Id,
                    },
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		internal, err := network.NewSubnet(ctx, "internal", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewWindowsVirtualMachineScaleSet(ctx, "exampleWindowsVirtualMachineScaleSet", &compute.WindowsVirtualMachineScaleSetArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Sku:               pulumi.String("Standard_F2"),
			Instances:         pulumi.Int(1),
			AdminPassword:     pulumi.String("P@55w0rd1234!"),
			AdminUsername:     pulumi.String("adminuser"),
			SourceImageReference: &compute.WindowsVirtualMachineScaleSetSourceImageReferenceArgs{
				Publisher: pulumi.String("MicrosoftWindowsServer"),
				Offer:     pulumi.String("WindowsServer"),
				Sku:       pulumi.String("2016-Datacenter-Server-Core"),
				Version:   pulumi.String("latest"),
			},
			OsDisk: &compute.WindowsVirtualMachineScaleSetOsDiskArgs{
				StorageAccountType: pulumi.String("Standard_LRS"),
				Caching:            pulumi.String("ReadWrite"),
			},
			NetworkInterfaces: compute.WindowsVirtualMachineScaleSetNetworkInterfaceArray{
				&compute.WindowsVirtualMachineScaleSetNetworkInterfaceArgs{
					Name:    pulumi.String("example"),
					Primary: pulumi.Bool(true),
					IpConfigurations: compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
						&compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
							Name:     pulumi.String("internal"),
							Primary:  pulumi.Bool(true),
							SubnetId: internal.ID(),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    address_spaces=["10.0.0.0/16"])
internal = azure.network.Subnet("internal",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"])
example_windows_virtual_machine_scale_set = azure.compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku="Standard_F2",
    instances=1,
    admin_password="P@55w0rd1234!",
    admin_username="adminuser",
    source_image_reference=azure.compute.WindowsVirtualMachineScaleSetSourceImageReferenceArgs(
        publisher="MicrosoftWindowsServer",
        offer="WindowsServer",
        sku="2016-Datacenter-Server-Core",
        version="latest",
    ),
    os_disk=azure.compute.WindowsVirtualMachineScaleSetOsDiskArgs(
        storage_account_type="Standard_LRS",
        caching="ReadWrite",
    ),
    network_interfaces=[azure.compute.WindowsVirtualMachineScaleSetNetworkInterfaceArgs(
        name="example",
        primary=True,
        ip_configurations=[azure.compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs(
            name="internal",
            primary=True,
            subnet_id=internal.id,
        )],
    )])

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    addressSpaces: ["10.0.0.0/16"],
});
const internal = new azure.network.Subnet("internal", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
});
const exampleWindowsVirtualMachineScaleSet = new azure.compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: "Standard_F2",
    instances: 1,
    adminPassword: "P@55w0rd1234!",
    adminUsername: "adminuser",
    sourceImageReference: {
        publisher: "MicrosoftWindowsServer",
        offer: "WindowsServer",
        sku: "2016-Datacenter-Server-Core",
        version: "latest",
    },
    osDisk: {
        storageAccountType: "Standard_LRS",
        caching: "ReadWrite",
    },
    networkInterfaces: [{
        name: "example",
        primary: true,
        ipConfigurations: [{
            name: "internal",
            primary: true,
            subnetId: internal.id,
        }],
    }],
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      addressSpaces:
        - 10.0.0.0/16
  internal:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
  exampleWindowsVirtualMachineScaleSet:
    type: azure:compute:WindowsVirtualMachineScaleSet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      sku: Standard_F2
      instances: 1
      adminPassword: P@55w0rd1234!
      adminUsername: adminuser
      sourceImageReference:
        publisher: MicrosoftWindowsServer
        offer: WindowsServer
        sku: 2016-Datacenter-Server-Core
        version: latest
      osDisk:
        storageAccountType: Standard_LRS
        caching: ReadWrite
      networkInterfaces:
        - name: example
          primary: true
          ipConfigurations:
            - name: internal
              primary: true
              subnetId: ${internal.id}

Create WindowsVirtualMachineScaleSet Resource

new WindowsVirtualMachineScaleSet(name: string, args: WindowsVirtualMachineScaleSetArgs, opts?: CustomResourceOptions);

@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  additional_capabilities: Optional[WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
                                  additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]] = None,
                                  admin_password: Optional[str] = None,
                                  admin_username: Optional[str] = None,
                                  automatic_instance_repair: Optional[WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
                                  automatic_os_upgrade_policy: Optional[WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs] = None,
                                  boot_diagnostics: Optional[WindowsVirtualMachineScaleSetBootDiagnosticsArgs] = None,
                                  capacity_reservation_group_id: Optional[str] = None,
                                  computer_name_prefix: Optional[str] = None,
                                  custom_data: Optional[str] = None,
                                  data_disks: Optional[Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]] = None,
                                  do_not_run_extensions_on_overprovisioned_machines: Optional[bool] = None,
                                  edge_zone: Optional[str] = None,
                                  enable_automatic_updates: Optional[bool] = None,
                                  encryption_at_host_enabled: Optional[bool] = None,
                                  eviction_policy: Optional[str] = None,
                                  extension_operations_enabled: Optional[bool] = None,
                                  extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
                                  extensions_time_budget: Optional[str] = None,
                                  gallery_application: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
                                  gallery_applications: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
                                  health_probe_id: Optional[str] = None,
                                  host_group_id: Optional[str] = None,
                                  identity: Optional[WindowsVirtualMachineScaleSetIdentityArgs] = None,
                                  instances: Optional[int] = None,
                                  license_type: Optional[str] = None,
                                  location: Optional[str] = None,
                                  max_bid_price: Optional[float] = None,
                                  name: Optional[str] = None,
                                  network_interfaces: Optional[Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
                                  os_disk: Optional[WindowsVirtualMachineScaleSetOsDiskArgs] = None,
                                  overprovision: Optional[bool] = None,
                                  plan: Optional[WindowsVirtualMachineScaleSetPlanArgs] = None,
                                  platform_fault_domain_count: Optional[int] = None,
                                  priority: Optional[str] = None,
                                  provision_vm_agent: Optional[bool] = None,
                                  proximity_placement_group_id: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  rolling_upgrade_policy: Optional[WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs] = None,
                                  scale_in: Optional[WindowsVirtualMachineScaleSetScaleInArgs] = None,
                                  scale_in_policy: Optional[str] = None,
                                  secrets: Optional[Sequence[WindowsVirtualMachineScaleSetSecretArgs]] = None,
                                  secure_boot_enabled: Optional[bool] = None,
                                  single_placement_group: Optional[bool] = None,
                                  sku: Optional[str] = None,
                                  source_image_id: Optional[str] = None,
                                  source_image_reference: Optional[WindowsVirtualMachineScaleSetSourceImageReferenceArgs] = None,
                                  spot_restore: Optional[WindowsVirtualMachineScaleSetSpotRestoreArgs] = None,
                                  tags: Optional[Mapping[str, str]] = None,
                                  terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = None,
                                  termination_notification: Optional[WindowsVirtualMachineScaleSetTerminationNotificationArgs] = None,
                                  timezone: Optional[str] = None,
                                  upgrade_mode: Optional[str] = None,
                                  user_data: Optional[str] = None,
                                  vtpm_enabled: Optional[bool] = None,
                                  winrm_listeners: Optional[Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]] = None,
                                  zone_balance: Optional[bool] = None,
                                  zones: Optional[Sequence[str]] = None)
@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
                                  args: WindowsVirtualMachineScaleSetArgs,
                                  opts: Optional[ResourceOptions] = None)

func NewWindowsVirtualMachineScaleSet(ctx *Context, name string, args WindowsVirtualMachineScaleSetArgs, opts ...ResourceOption) (*WindowsVirtualMachineScaleSet, error)

public WindowsVirtualMachineScaleSet(string name, WindowsVirtualMachineScaleSetArgs args, CustomResourceOptions? opts = null)

public WindowsVirtualMachineScaleSet(String name, WindowsVirtualMachineScaleSetArgs args)
public WindowsVirtualMachineScaleSet(String name, WindowsVirtualMachineScaleSetArgs args, CustomResourceOptions options)

type: azure:compute:WindowsVirtualMachineScaleSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WindowsVirtualMachineScaleSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WindowsVirtualMachineScaleSetArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WindowsVirtualMachineScaleSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WindowsVirtualMachineScaleSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WindowsVirtualMachineScaleSetArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

WindowsVirtualMachineScaleSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The WindowsVirtualMachineScaleSet resource accepts the following input properties:

AdminPassword string

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

AdminUsername string

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

Instances int

The number of Virtual Machines in the Scale Set.

NetworkInterfaces List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>

One or more network_interface blocks as defined below.

OsDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

ResourceGroupName string

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.

Sku string

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

AdditionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

AdditionalUnattendContents List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>

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

AutomaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

CapacityReservationGroupId string

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 string

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 string

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

DataDisks List<WindowsVirtualMachineScaleSetDataDiskArgs>

One or more data_disk blocks as defined below.

DoNotRunExtensionsOnOverprovisionedMachines bool

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

EdgeZone string

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 bool

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

EncryptionAtHostEnabled bool

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

EvictionPolicy string

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 bool

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 List<WindowsVirtualMachineScaleSetExtensionArgs>

One or more extension blocks as defined below

ExtensionsTimeBudget string

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 List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

One or more gallery_application blocks as defined below.

GalleryApplications List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

HealthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

LicenseType string

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 string

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

MaxBidPrice double

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 string

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

Overprovision bool

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 WindowsVirtualMachineScaleSetPlanArgs

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

PlatformFaultDomainCount int

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 string

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 bool

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 string

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.

RollingUpgradePolicy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

ScaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

Secrets List<WindowsVirtualMachineScaleSetSecretArgs>

One or more secret blocks as defined below.

SecureBootEnabled bool

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

SinglePlacementGroup bool

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.

SourceImageId string

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 WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

SpotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

Tags Dictionary<string, string>

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

TerminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

TerminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

UpgradeMode string

Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are Automatic, Manual and Rolling. Defaults to Manual. Changing this forces a new resource to be created.

UserData string

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

VtpmEnabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

WinrmListeners List<WindowsVirtualMachineScaleSetWinrmListenerArgs>

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

ZoneBalance bool

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.

Zones List<string>

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

AdminPassword string

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

AdminUsername string

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

Instances int

The number of Virtual Machines in the Scale Set.

NetworkInterfaces []WindowsVirtualMachineScaleSetNetworkInterfaceArgs

One or more network_interface blocks as defined below.

OsDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

ResourceGroupName string

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.

Sku string

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

AdditionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

AdditionalUnattendContents []WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs

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

AutomaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

CapacityReservationGroupId string

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 string

CustomData string

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

DataDisks []WindowsVirtualMachineScaleSetDataDiskArgs

One or more data_disk blocks as defined below.

DoNotRunExtensionsOnOverprovisionedMachines bool

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

EdgeZone string

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 bool

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

EncryptionAtHostEnabled bool

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

EvictionPolicy string

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 bool

Extensions []WindowsVirtualMachineScaleSetExtensionArgs

One or more extension blocks as defined below

ExtensionsTimeBudget string

GalleryApplication []WindowsVirtualMachineScaleSetGalleryApplicationArgs

One or more gallery_application blocks as defined below.

GalleryApplications []WindowsVirtualMachineScaleSetGalleryApplicationArgs

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

HealthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

LicenseType string

Location string

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

MaxBidPrice float64

Name string

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

Overprovision bool

Plan WindowsVirtualMachineScaleSetPlanArgs

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

PlatformFaultDomainCount int

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 string

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 bool

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 string

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.

RollingUpgradePolicy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

ScaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

ScaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

Secrets []WindowsVirtualMachineScaleSetSecretArgs

One or more secret blocks as defined below.

SecureBootEnabled bool

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

SinglePlacementGroup bool

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.

SourceImageId string

SourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

SpotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

Tags map[string]string

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

TerminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

TerminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

UpgradeMode string

UserData string

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

VtpmEnabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

WinrmListeners []WindowsVirtualMachineScaleSetWinrmListenerArgs

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

ZoneBalance bool

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.

Zones []string

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

adminPassword String

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

adminUsername String

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

instances Integer

The number of Virtual Machines in the Scale Set.

networkInterfaces List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>

One or more network_interface blocks as defined below.

osDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

resourceGroupName String

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.

sku String

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

additionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additionalUnattendContents List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>

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

automaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacityReservationGroupId String

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 String

customData String

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

dataDisks List<WindowsVirtualMachineScaleSetDataDiskArgs>

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines Boolean

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

edgeZone String

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 Boolean

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

encryptionAtHostEnabled Boolean

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

evictionPolicy String

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 Boolean

extensions List<WindowsVirtualMachineScaleSetExtensionArgs>

One or more extension blocks as defined below

extensionsTimeBudget String

galleryApplication List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

One or more gallery_application blocks as defined below.

galleryApplications List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId String

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 String

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

licenseType String

location String

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

maxBidPrice Double

name String

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

overprovision Boolean

plan WindowsVirtualMachineScaleSetPlanArgs

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

platformFaultDomainCount Integer

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 String

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 Boolean

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 String

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.

rollingUpgradePolicy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scaleInPolicy String

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets List<WindowsVirtualMachineScaleSetSecretArgs>

One or more secret blocks as defined below.

secureBootEnabled Boolean

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

singlePlacementGroup Boolean

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.

sourceImageId String

sourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags Map<String,String>

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

terminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone String

Specifies the time zone of the virtual machine, the possible values are defined here.

upgradeMode String

userData String

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

vtpmEnabled Boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners List<WindowsVirtualMachineScaleSetWinrmListenerArgs>

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

zoneBalance Boolean

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.

zones List<String>

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

adminPassword string

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

adminUsername string

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

instances number

The number of Virtual Machines in the Scale Set.

networkInterfaces WindowsVirtualMachineScaleSetNetworkInterfaceArgs[]

One or more network_interface blocks as defined below.

osDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

resourceGroupName string

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.

sku string

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

additionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additionalUnattendContents WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs[]

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

automaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacityReservationGroupId string

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 string

customData string

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

dataDisks WindowsVirtualMachineScaleSetDataDiskArgs[]

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines boolean

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

edgeZone string

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 boolean

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

encryptionAtHostEnabled boolean

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

evictionPolicy string

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 boolean

extensions WindowsVirtualMachineScaleSetExtensionArgs[]

One or more extension blocks as defined below

extensionsTimeBudget string

galleryApplication WindowsVirtualMachineScaleSetGalleryApplicationArgs[]

One or more gallery_application blocks as defined below.

galleryApplications WindowsVirtualMachineScaleSetGalleryApplicationArgs[]

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

licenseType string

location string

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

maxBidPrice number

name string

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

overprovision boolean

plan WindowsVirtualMachineScaleSetPlanArgs

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

platformFaultDomainCount number

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 string

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 boolean

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 string

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.

rollingUpgradePolicy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets WindowsVirtualMachineScaleSetSecretArgs[]

One or more secret blocks as defined below.

secureBootEnabled boolean

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

singlePlacementGroup boolean

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.

sourceImageId string

sourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags {[key: string]: string}

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

terminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

upgradeMode string

userData string

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

vtpmEnabled boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners WindowsVirtualMachineScaleSetWinrmListenerArgs[]

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

zoneBalance boolean

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.

zones string[]

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

admin_password str

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

admin_username str

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

instances int

The number of Virtual Machines in the Scale Set.

network_interfaces Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]

One or more network_interface blocks as defined below.

os_disk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

resource_group_name str

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.

sku str

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

additional_capabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additional_unattend_contents Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]

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

automatic_instance_repair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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.

automatic_os_upgrade_policy WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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

boot_diagnostics WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacity_reservation_group_id str

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.

computer_name_prefix str

custom_data str

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

data_disks Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]

One or more data_disk blocks as defined below.

do_not_run_extensions_on_overprovisioned_machines bool

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

edge_zone str

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.

enable_automatic_updates bool

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

encryption_at_host_enabled bool

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

eviction_policy str

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.

extension_operations_enabled bool

extensions Sequence[WindowsVirtualMachineScaleSetExtensionArgs]

One or more extension blocks as defined below

extensions_time_budget str

gallery_application Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]

One or more gallery_application blocks as defined below.

gallery_applications Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

health_probe_id str

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.

host_group_id str

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

license_type str

location str

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

max_bid_price float

name str

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

overprovision bool

plan WindowsVirtualMachineScaleSetPlanArgs

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

platform_fault_domain_count int

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 str

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

provision_vm_agent bool

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.

proximity_placement_group_id str

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.

rolling_upgrade_policy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scale_in WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scale_in_policy str

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets Sequence[WindowsVirtualMachineScaleSetSecretArgs]

One or more secret blocks as defined below.

secure_boot_enabled bool

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

single_placement_group bool

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.

source_image_id str

source_image_reference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spot_restore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags Mapping[str, str]

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

terminate_notification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

termination_notification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone str

Specifies the time zone of the virtual machine, the possible values are defined here.

upgrade_mode str

user_data str

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

vtpm_enabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrm_listeners Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]

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

zone_balance bool

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.

zones Sequence[str]

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

adminPassword String

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

adminUsername String

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

instances Number

The number of Virtual Machines in the Scale Set.

networkInterfaces List<Property Map>

One or more network_interface blocks as defined below.

osDisk Property Map

An os_disk block as defined below.

resourceGroupName String

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.

sku String

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

additionalCapabilities Property Map

An additional_capabilities block as defined below.

additionalUnattendContents List<Property Map>

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

automaticInstanceRepair Property Map

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 Property Map

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 Property Map

A boot_diagnostics block as defined below.

capacityReservationGroupId String

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 String

customData String

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

dataDisks List<Property Map>

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines Boolean

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

edgeZone String

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 Boolean

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

encryptionAtHostEnabled Boolean

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

evictionPolicy String

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 Boolean

extensions List<Property Map>

One or more extension blocks as defined below

extensionsTimeBudget String

galleryApplication List<Property Map>

One or more gallery_application blocks as defined below.

galleryApplications List<Property Map>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId String

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 String

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 Property Map

An identity block as defined below.

licenseType String

location String

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

maxBidPrice Number

name String

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

overprovision Boolean

plan Property Map

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

platformFaultDomainCount Number

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 String

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 Boolean

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 String

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.

rollingUpgradePolicy Property Map

scaleIn Property Map

A scale_in block as defined below.

scaleInPolicy String

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets List<Property Map>

One or more secret blocks as defined below.

secureBootEnabled Boolean

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

singlePlacementGroup Boolean

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.

sourceImageId String

sourceImageReference Property Map

A source_image_reference block as defined below.

spotRestore Property Map

A spot_restore block as defined below.

tags Map<String>

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

terminateNotification Property Map

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification Property Map

A termination_notification block as defined below.

timezone String

Specifies the time zone of the virtual machine, the possible values are defined here.

upgradeMode String

userData String

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

vtpmEnabled Boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners List<Property Map>

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

zoneBalance Boolean

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.

zones List<String>

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

Outputs

All input properties are implicitly available as output properties. Additionally, the WindowsVirtualMachineScaleSet resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
UniqueId string: The Unique ID for this Windows Virtual Machine Scale Set.

Id string: The provider-assigned unique ID for this managed resource.
UniqueId string: The Unique ID for this Windows Virtual Machine Scale Set.

id String: The provider-assigned unique ID for this managed resource.
uniqueId String: The Unique ID for this Windows Virtual Machine Scale Set.

id string: The provider-assigned unique ID for this managed resource.
uniqueId string: The Unique ID for this Windows Virtual Machine Scale Set.

id str: The provider-assigned unique ID for this managed resource.
unique_id str: The Unique ID for this Windows Virtual Machine Scale Set.

id String: The provider-assigned unique ID for this managed resource.
uniqueId String: The Unique ID for this Windows Virtual Machine Scale Set.

Look up Existing WindowsVirtualMachineScaleSet Resource

Get an existing WindowsVirtualMachineScaleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WindowsVirtualMachineScaleSetState, opts?: CustomResourceOptions): WindowsVirtualMachineScaleSet

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_capabilities: Optional[WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
        additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]] = None,
        admin_password: Optional[str] = None,
        admin_username: Optional[str] = None,
        automatic_instance_repair: Optional[WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
        automatic_os_upgrade_policy: Optional[WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs] = None,
        boot_diagnostics: Optional[WindowsVirtualMachineScaleSetBootDiagnosticsArgs] = None,
        capacity_reservation_group_id: Optional[str] = None,
        computer_name_prefix: Optional[str] = None,
        custom_data: Optional[str] = None,
        data_disks: Optional[Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]] = None,
        do_not_run_extensions_on_overprovisioned_machines: Optional[bool] = None,
        edge_zone: Optional[str] = None,
        enable_automatic_updates: Optional[bool] = None,
        encryption_at_host_enabled: Optional[bool] = None,
        eviction_policy: Optional[str] = None,
        extension_operations_enabled: Optional[bool] = None,
        extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
        extensions_time_budget: Optional[str] = None,
        gallery_application: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
        gallery_applications: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
        health_probe_id: Optional[str] = None,
        host_group_id: Optional[str] = None,
        identity: Optional[WindowsVirtualMachineScaleSetIdentityArgs] = None,
        instances: Optional[int] = None,
        license_type: Optional[str] = None,
        location: Optional[str] = None,
        max_bid_price: Optional[float] = None,
        name: Optional[str] = None,
        network_interfaces: Optional[Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
        os_disk: Optional[WindowsVirtualMachineScaleSetOsDiskArgs] = None,
        overprovision: Optional[bool] = None,
        plan: Optional[WindowsVirtualMachineScaleSetPlanArgs] = None,
        platform_fault_domain_count: Optional[int] = None,
        priority: Optional[str] = None,
        provision_vm_agent: Optional[bool] = None,
        proximity_placement_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        rolling_upgrade_policy: Optional[WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs] = None,
        scale_in: Optional[WindowsVirtualMachineScaleSetScaleInArgs] = None,
        scale_in_policy: Optional[str] = None,
        secrets: Optional[Sequence[WindowsVirtualMachineScaleSetSecretArgs]] = None,
        secure_boot_enabled: Optional[bool] = None,
        single_placement_group: Optional[bool] = None,
        sku: Optional[str] = None,
        source_image_id: Optional[str] = None,
        source_image_reference: Optional[WindowsVirtualMachineScaleSetSourceImageReferenceArgs] = None,
        spot_restore: Optional[WindowsVirtualMachineScaleSetSpotRestoreArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = None,
        termination_notification: Optional[WindowsVirtualMachineScaleSetTerminationNotificationArgs] = None,
        timezone: Optional[str] = None,
        unique_id: Optional[str] = None,
        upgrade_mode: Optional[str] = None,
        user_data: Optional[str] = None,
        vtpm_enabled: Optional[bool] = None,
        winrm_listeners: Optional[Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]] = None,
        zone_balance: Optional[bool] = None,
        zones: Optional[Sequence[str]] = None) -> WindowsVirtualMachineScaleSet

func GetWindowsVirtualMachineScaleSet(ctx *Context, name string, id IDInput, state *WindowsVirtualMachineScaleSetState, opts ...ResourceOption) (*WindowsVirtualMachineScaleSet, error)

public static WindowsVirtualMachineScaleSet Get(string name, Input<string> id, WindowsVirtualMachineScaleSetState? state, CustomResourceOptions? opts = null)

public static WindowsVirtualMachineScaleSet get(String name, Output<String> id, WindowsVirtualMachineScaleSetState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

AdditionalUnattendContents List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>

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

AdminPassword string

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

AdminUsername string

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

AutomaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

CapacityReservationGroupId string

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 string

CustomData string

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

DataDisks List<WindowsVirtualMachineScaleSetDataDiskArgs>

One or more data_disk blocks as defined below.

DoNotRunExtensionsOnOverprovisionedMachines bool

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

EdgeZone string

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 bool

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

EncryptionAtHostEnabled bool

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

EvictionPolicy string

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 bool

Extensions List<WindowsVirtualMachineScaleSetExtensionArgs>

One or more extension blocks as defined below

ExtensionsTimeBudget string

GalleryApplication List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

One or more gallery_application blocks as defined below.

GalleryApplications List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

HealthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

Instances int

The number of Virtual Machines in the Scale Set.

LicenseType string

Location string

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

MaxBidPrice double

Name string

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

NetworkInterfaces List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>

One or more network_interface blocks as defined below.

OsDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

Overprovision bool

Plan WindowsVirtualMachineScaleSetPlanArgs

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

PlatformFaultDomainCount int

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 string

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 bool

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 string

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 string

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 WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

ScaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

ScaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

Secrets List<WindowsVirtualMachineScaleSetSecretArgs>

One or more secret blocks as defined below.

SecureBootEnabled bool

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

SinglePlacementGroup bool

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 string

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

SourceImageId string

SourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

SpotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

Tags Dictionary<string, string>

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

TerminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

TerminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

UniqueId string

The Unique ID for this Windows Virtual Machine Scale Set.

UpgradeMode string

UserData string

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

VtpmEnabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

WinrmListeners List<WindowsVirtualMachineScaleSetWinrmListenerArgs>

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

ZoneBalance bool

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.

Zones List<string>

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

AdditionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

AdditionalUnattendContents []WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs

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

AdminPassword string

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

AdminUsername string

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

AutomaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

CapacityReservationGroupId string

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 string

CustomData string

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

DataDisks []WindowsVirtualMachineScaleSetDataDiskArgs

One or more data_disk blocks as defined below.

DoNotRunExtensionsOnOverprovisionedMachines bool

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

EdgeZone string

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 bool

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

EncryptionAtHostEnabled bool

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

EvictionPolicy string

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 bool

Extensions []WindowsVirtualMachineScaleSetExtensionArgs

One or more extension blocks as defined below

ExtensionsTimeBudget string

GalleryApplication []WindowsVirtualMachineScaleSetGalleryApplicationArgs

One or more gallery_application blocks as defined below.

GalleryApplications []WindowsVirtualMachineScaleSetGalleryApplicationArgs

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

HealthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

Instances int

The number of Virtual Machines in the Scale Set.

LicenseType string

Location string

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

MaxBidPrice float64

Name string

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

NetworkInterfaces []WindowsVirtualMachineScaleSetNetworkInterfaceArgs

One or more network_interface blocks as defined below.

OsDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

Overprovision bool

Plan WindowsVirtualMachineScaleSetPlanArgs

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

PlatformFaultDomainCount int

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 string

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 bool

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 string

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 string

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 WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

ScaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

ScaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

Secrets []WindowsVirtualMachineScaleSetSecretArgs

One or more secret blocks as defined below.

SecureBootEnabled bool

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

SinglePlacementGroup bool

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 string

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

SourceImageId string

SourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

SpotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

Tags map[string]string

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

TerminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

TerminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

UniqueId string

The Unique ID for this Windows Virtual Machine Scale Set.

UpgradeMode string

UserData string

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

VtpmEnabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

WinrmListeners []WindowsVirtualMachineScaleSetWinrmListenerArgs

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

ZoneBalance bool

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.

Zones []string

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

additionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additionalUnattendContents List<WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs>

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

adminPassword String

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

adminUsername String

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

automaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacityReservationGroupId String

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 String

customData String

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

dataDisks List<WindowsVirtualMachineScaleSetDataDiskArgs>

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines Boolean

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

edgeZone String

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 Boolean

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

encryptionAtHostEnabled Boolean

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

evictionPolicy String

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 Boolean

extensions List<WindowsVirtualMachineScaleSetExtensionArgs>

One or more extension blocks as defined below

extensionsTimeBudget String

galleryApplication List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

One or more gallery_application blocks as defined below.

galleryApplications List<WindowsVirtualMachineScaleSetGalleryApplicationArgs>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId String

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 String

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

instances Integer

The number of Virtual Machines in the Scale Set.

licenseType String

location String

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

maxBidPrice Double

name String

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

networkInterfaces List<WindowsVirtualMachineScaleSetNetworkInterfaceArgs>

One or more network_interface blocks as defined below.

osDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

overprovision Boolean

plan WindowsVirtualMachineScaleSetPlanArgs

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

platformFaultDomainCount Integer

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 String

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 Boolean

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 String

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 String

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 WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scaleInPolicy String

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets List<WindowsVirtualMachineScaleSetSecretArgs>

One or more secret blocks as defined below.

secureBootEnabled Boolean

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

singlePlacementGroup Boolean

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 String

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

sourceImageId String

sourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags Map<String,String>

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

terminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone String

Specifies the time zone of the virtual machine, the possible values are defined here.

uniqueId String

The Unique ID for this Windows Virtual Machine Scale Set.

upgradeMode String

userData String

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

vtpmEnabled Boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners List<WindowsVirtualMachineScaleSetWinrmListenerArgs>

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

zoneBalance Boolean

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.

zones List<String>

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

additionalCapabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additionalUnattendContents WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs[]

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

adminPassword string

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

adminUsername string

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

automaticInstanceRepair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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 WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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 WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacityReservationGroupId string

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 string

customData string

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

dataDisks WindowsVirtualMachineScaleSetDataDiskArgs[]

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines boolean

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

edgeZone string

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 boolean

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

encryptionAtHostEnabled boolean

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

evictionPolicy string

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 boolean

extensions WindowsVirtualMachineScaleSetExtensionArgs[]

One or more extension blocks as defined below

extensionsTimeBudget string

galleryApplication WindowsVirtualMachineScaleSetGalleryApplicationArgs[]

One or more gallery_application blocks as defined below.

galleryApplications WindowsVirtualMachineScaleSetGalleryApplicationArgs[]

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId string

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 string

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

instances number

The number of Virtual Machines in the Scale Set.

licenseType string

location string

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

maxBidPrice number

name string

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

networkInterfaces WindowsVirtualMachineScaleSetNetworkInterfaceArgs[]

One or more network_interface blocks as defined below.

osDisk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

overprovision boolean

plan WindowsVirtualMachineScaleSetPlanArgs

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

platformFaultDomainCount number

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 string

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 boolean

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 string

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 string

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 WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scaleIn WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scaleInPolicy string

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets WindowsVirtualMachineScaleSetSecretArgs[]

One or more secret blocks as defined below.

secureBootEnabled boolean

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

singlePlacementGroup boolean

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 string

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

sourceImageId string

sourceImageReference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spotRestore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags {[key: string]: string}

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

terminateNotification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

uniqueId string

The Unique ID for this Windows Virtual Machine Scale Set.

upgradeMode string

userData string

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

vtpmEnabled boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners WindowsVirtualMachineScaleSetWinrmListenerArgs[]

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

zoneBalance boolean

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.

zones string[]

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

additional_capabilities WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs

An additional_capabilities block as defined below.

additional_unattend_contents Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]

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

admin_password str

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

admin_username str

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

automatic_instance_repair WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs

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.

automatic_os_upgrade_policy WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs

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

boot_diagnostics WindowsVirtualMachineScaleSetBootDiagnosticsArgs

A boot_diagnostics block as defined below.

capacity_reservation_group_id str

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.

computer_name_prefix str

custom_data str

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

data_disks Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]

One or more data_disk blocks as defined below.

do_not_run_extensions_on_overprovisioned_machines bool

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

edge_zone str

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.

enable_automatic_updates bool

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

encryption_at_host_enabled bool

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

eviction_policy str

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.

extension_operations_enabled bool

extensions Sequence[WindowsVirtualMachineScaleSetExtensionArgs]

One or more extension blocks as defined below

extensions_time_budget str

gallery_application Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]

One or more gallery_application blocks as defined below.

gallery_applications Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

health_probe_id str

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.

host_group_id str

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 WindowsVirtualMachineScaleSetIdentityArgs

An identity block as defined below.

instances int

The number of Virtual Machines in the Scale Set.

license_type str

location str

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

max_bid_price float

name str

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

network_interfaces Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]

One or more network_interface blocks as defined below.

os_disk WindowsVirtualMachineScaleSetOsDiskArgs

An os_disk block as defined below.

overprovision bool

plan WindowsVirtualMachineScaleSetPlanArgs

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

platform_fault_domain_count int

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 str

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

provision_vm_agent bool

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.

proximity_placement_group_id str

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.

resource_group_name str

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.

rolling_upgrade_policy WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs

scale_in WindowsVirtualMachineScaleSetScaleInArgs

A scale_in block as defined below.

scale_in_policy str

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets Sequence[WindowsVirtualMachineScaleSetSecretArgs]

One or more secret blocks as defined below.

secure_boot_enabled bool

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

single_placement_group bool

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 str

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

source_image_id str

source_image_reference WindowsVirtualMachineScaleSetSourceImageReferenceArgs

A source_image_reference block as defined below.

spot_restore WindowsVirtualMachineScaleSetSpotRestoreArgs

A spot_restore block as defined below.

tags Mapping[str, str]

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

terminate_notification WindowsVirtualMachineScaleSetTerminateNotificationArgs

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

termination_notification WindowsVirtualMachineScaleSetTerminationNotificationArgs

A termination_notification block as defined below.

timezone str

Specifies the time zone of the virtual machine, the possible values are defined here.

unique_id str

The Unique ID for this Windows Virtual Machine Scale Set.

upgrade_mode str

user_data str

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

vtpm_enabled bool

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrm_listeners Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]

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

zone_balance bool

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.

zones Sequence[str]

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

additionalCapabilities Property Map

An additional_capabilities block as defined below.

additionalUnattendContents List<Property Map>

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

adminPassword String

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

adminUsername String

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

automaticInstanceRepair Property Map

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 Property Map

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 Property Map

A boot_diagnostics block as defined below.

capacityReservationGroupId String

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 String

customData String

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

dataDisks List<Property Map>

One or more data_disk blocks as defined below.

doNotRunExtensionsOnOverprovisionedMachines Boolean

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

edgeZone String

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 Boolean

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

encryptionAtHostEnabled Boolean

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

evictionPolicy String

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 Boolean

extensions List<Property Map>

One or more extension blocks as defined below

extensionsTimeBudget String

galleryApplication List<Property Map>

One or more gallery_application blocks as defined below.

galleryApplications List<Property Map>

Deprecated:

gallery_applications has been renamed to gallery_application and will be deprecated in 4.0

healthProbeId String

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 String

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 Property Map

An identity block as defined below.

instances Number

The number of Virtual Machines in the Scale Set.

licenseType String

location String

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

maxBidPrice Number

name String

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

networkInterfaces List<Property Map>

One or more network_interface blocks as defined below.

osDisk Property Map

An os_disk block as defined below.

overprovision Boolean

plan Property Map

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

platformFaultDomainCount Number

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 String

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 Boolean

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 String

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 String

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 Property Map

scaleIn Property Map

A scale_in block as defined below.

scaleInPolicy String

Deprecated:

scale_in_policy will be removed in favour of the scale_in code block in version 4.0 of the AzureRM Provider.

secrets List<Property Map>

One or more secret blocks as defined below.

secureBootEnabled Boolean

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

singlePlacementGroup Boolean

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 String

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

sourceImageId String

sourceImageReference Property Map

A source_image_reference block as defined below.

spotRestore Property Map

A spot_restore block as defined below.

tags Map<String>

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

terminateNotification Property Map

A terminate_notification block as defined below.

Deprecated:

terminate_notification has been renamed to termination_notification and will be removed in 4.0.

terminationNotification Property Map

A termination_notification block as defined below.

timezone String

Specifies the time zone of the virtual machine, the possible values are defined here.

uniqueId String

The Unique ID for this Windows Virtual Machine Scale Set.

upgradeMode String

userData String

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

vtpmEnabled Boolean

Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrmListeners List<Property Map>

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

zoneBalance Boolean

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.

zones List<String>

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

Supporting Types

WindowsVirtualMachineScaleSetAdditionalCapabilities

UltraSsdEnabled bool: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

UltraSsdEnabled bool: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

ultraSsdEnabled Boolean: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

ultraSsdEnabled boolean: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

ultra_ssd_enabled bool: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

ultraSsdEnabled Boolean: Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetAdditionalUnattendContent

Content string: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
Setting string: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

Content string: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
Setting string: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

content String: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
setting String: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

content string: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
setting string: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

content str: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
setting str: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

content String: The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
setting String: The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetAutomaticInstanceRepair

Enabled bool: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
GracePeriod string: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

Enabled bool: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
GracePeriod string: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

enabled Boolean: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
gracePeriod String: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

enabled boolean: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
gracePeriod string: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

enabled bool: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
grace_period str: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

enabled Boolean: Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
gracePeriod String: Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to PT30M.

WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy

DisableAutomaticRollback bool: Should automatic rollbacks be disabled?
EnableAutomaticOsUpgrade bool: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

DisableAutomaticRollback bool: Should automatic rollbacks be disabled?
EnableAutomaticOsUpgrade bool: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

disableAutomaticRollback Boolean: Should automatic rollbacks be disabled?
enableAutomaticOsUpgrade Boolean: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

disableAutomaticRollback boolean: Should automatic rollbacks be disabled?
enableAutomaticOsUpgrade boolean: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

disable_automatic_rollback bool: Should automatic rollbacks be disabled?
enable_automatic_os_upgrade bool: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

disableAutomaticRollback Boolean: Should automatic rollbacks be disabled?
enableAutomaticOsUpgrade Boolean: Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available?

WindowsVirtualMachineScaleSetBootDiagnostics

StorageAccountUri string: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

StorageAccountUri string: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

storageAccountUri String: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

storageAccountUri string: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

storage_account_uri str: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

storageAccountUri String: The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

WindowsVirtualMachineScaleSetDataDisk

Caching string: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
DiskSizeGb int: The size of the Data Disk which should be created.
Lun int: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
StorageAccountType string: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
CreateOption string: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
DiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
Name string: The name of the Data Disk.
UltraSsdDiskIopsReadWrite int: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
UltraSsdDiskMbpsReadWrite int: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
WriteAcceleratorEnabled bool: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

Caching string: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
DiskSizeGb int: The size of the Data Disk which should be created.
Lun int: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
StorageAccountType string: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
CreateOption string: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
DiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
Name string: The name of the Data Disk.
UltraSsdDiskIopsReadWrite int: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
UltraSsdDiskMbpsReadWrite int: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
WriteAcceleratorEnabled bool: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

caching String: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
diskSizeGb Integer: The size of the Data Disk which should be created.
lun Integer: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
storageAccountType String: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
createOption String: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
diskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
name String: The name of the Data Disk.
ultraSsdDiskIopsReadWrite Integer: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
ultraSsdDiskMbpsReadWrite Integer: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
writeAcceleratorEnabled Boolean: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

caching string: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
diskSizeGb number: The size of the Data Disk which should be created.
lun number: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
storageAccountType string: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
createOption string: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
diskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
name string: The name of the Data Disk.
ultraSsdDiskIopsReadWrite number: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
ultraSsdDiskMbpsReadWrite number: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
writeAcceleratorEnabled boolean: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

caching str: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
disk_size_gb int: The size of the Data Disk which should be created.
lun int: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
storage_account_type str: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
create_option str: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
disk_encryption_set_id str: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
name str: The name of the Data Disk.
ultra_ssd_disk_iops_read_write int: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
ultra_ssd_disk_mbps_read_write int: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
write_accelerator_enabled bool: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

caching String: The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.
diskSizeGb Number: The size of the Data Disk which should be created.
lun Number: The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.
storageAccountType String: The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS and UltraSSD_LRS.
createOption String: The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).
diskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to encrypt this Data Disk. Changing this forces a new resource to be created.
name String: The name of the Data Disk.
ultraSsdDiskIopsReadWrite Number: Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
ultraSsdDiskMbpsReadWrite Number: Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
writeAcceleratorEnabled Boolean: Should Write Accelerator be enabled for this Data Disk? Defaults to false.

WindowsVirtualMachineScaleSetExtension

Name string: The name for the Virtual Machine Scale Set Extension.
Publisher string: Specifies the Publisher of the Extension.
Type string: Specifies the Type of the Extension.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
AutoUpgradeMinorVersion bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
AutomaticUpgradeEnabled bool: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProtectedSettingsFromKeyVault WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
ProvisionAfterExtensions List<string>: An ordered list of Extension names which this should be provisioned after.
Settings string: A JSON String which specifies Settings for the Extension.

Name string: The name for the Virtual Machine Scale Set Extension.
Publisher string: Specifies the Publisher of the Extension.
Type string: Specifies the Type of the Extension.
TypeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
AutoUpgradeMinorVersion bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
AutomaticUpgradeEnabled bool: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
ForceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
ProtectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
ProtectedSettingsFromKeyVault WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
ProvisionAfterExtensions []string: An ordered list of Extension names which this should be provisioned after.
Settings string: A JSON String which specifies Settings for the Extension.

name String: The name for the Virtual Machine Scale Set Extension.
publisher String: Specifies the Publisher of the Extension.
type String: Specifies the Type of the Extension.
typeHandlerVersion String: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
autoUpgradeMinorVersion Boolean: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
automaticUpgradeEnabled Boolean: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
forceUpdateTag String: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
protectedSettings String: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
protectedSettingsFromKeyVault WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
provisionAfterExtensions List<String>: An ordered list of Extension names which this should be provisioned after.
settings String: A JSON String which specifies Settings for the Extension.

name string: The name for the Virtual Machine Scale Set Extension.
publisher string: Specifies the Publisher of the Extension.
type string: Specifies the Type of the Extension.
typeHandlerVersion string: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
autoUpgradeMinorVersion boolean: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
automaticUpgradeEnabled boolean: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
forceUpdateTag string: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
protectedSettings string: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
protectedSettingsFromKeyVault WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
provisionAfterExtensions string[]: An ordered list of Extension names which this should be provisioned after.
settings string: A JSON String which specifies Settings for the Extension.

name str: The name for the Virtual Machine Scale Set Extension.
publisher str: Specifies the Publisher of the Extension.
type str: Specifies the Type of the Extension.
type_handler_version str: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
auto_upgrade_minor_version bool: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
automatic_upgrade_enabled bool: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
force_update_tag str: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
protected_settings str: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
protected_settings_from_key_vault WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
provision_after_extensions Sequence[str]: An ordered list of Extension names which this should be provisioned after.
settings str: A JSON String which specifies Settings for the Extension.

name String: The name for the Virtual Machine Scale Set Extension.
publisher String: Specifies the Publisher of the Extension.
type String: Specifies the Type of the Extension.
typeHandlerVersion String: Specifies the version of the extension to use, available versions can be found using the Azure CLI.
autoUpgradeMinorVersion Boolean: Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true.
automaticUpgradeEnabled Boolean: Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension?
forceUpdateTag String: A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed.
protectedSettings String: A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
protectedSettingsFromKeyVault Property Map
provisionAfterExtensions List<String>: An ordered list of Extension names which this should be provisioned after.
settings String: A JSON String which specifies Settings for the Extension.

WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault

SecretUrl string: The URL to the Key Vault Secret which stores the protected settings.
SourceVaultId string: The ID of the source Key Vault.

SecretUrl string: The URL to the Key Vault Secret which stores the protected settings.
SourceVaultId string: The ID of the source Key Vault.

secretUrl String: The URL to the Key Vault Secret which stores the protected settings.
sourceVaultId String: The ID of the source Key Vault.

secretUrl string: The URL to the Key Vault Secret which stores the protected settings.
sourceVaultId string: The ID of the source Key Vault.

secret_url str: The URL to the Key Vault Secret which stores the protected settings.
source_vault_id str: The ID of the source Key Vault.

secretUrl String: The URL to the Key Vault Secret which stores the protected settings.
sourceVaultId String: The ID of the source Key Vault.

WindowsVirtualMachineScaleSetGalleryApplication

PackageReferenceId string

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

ConfigurationReferenceBlobUri string

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

Order int

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

Tag string

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

PackageReferenceId string

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

ConfigurationReferenceBlobUri string

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

Order int

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

Tag string

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

packageReferenceId String

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

configurationReferenceBlobUri String

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

order Integer

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

tag String

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

packageReferenceId string

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

configurationReferenceBlobUri string

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

order number

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

tag string

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

package_reference_id str

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

configuration_reference_blob_uri str

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

order int

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

tag str

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

packageReferenceId String

Deprecated:

package_reference_id has been renamed to version_id and will be deprecated in 4.0

configurationReferenceBlobUri String

Deprecated:

configuration_reference_blob_uri has been renamed to configuration_blob_uri and will be deprecated in 4.0

order Number

Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647. Changing this forces a new resource to be created.

tag String

Specifies a passthrough value for more generic context. This field can be any valid string value. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetIdentity

Type string: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
IdentityIds List<string>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
PrincipalId string: The Principal ID associated with this Managed Service Identity.
TenantId string: The Tenant ID associated with this Managed Service Identity.

Type string: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
IdentityIds []string: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
PrincipalId string: The Principal ID associated with this Managed Service Identity.
TenantId string: The Tenant ID associated with this Managed Service Identity.

type String: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds List<String>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
principalId String: The Principal ID associated with this Managed Service Identity.
tenantId String: The Tenant ID associated with this Managed Service Identity.

type string: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds string[]: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
principalId string: The Principal ID associated with this Managed Service Identity.
tenantId string: The Tenant ID associated with this Managed Service Identity.

type str: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identity_ids Sequence[str]: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
principal_id str: The Principal ID associated with this Managed Service Identity.
tenant_id str: The Tenant ID associated with this Managed Service Identity.

type String: Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds List<String>: Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
principalId String: The Principal ID associated with this Managed Service Identity.
tenantId String: The Tenant ID associated with this Managed Service Identity.

WindowsVirtualMachineScaleSetNetworkInterface

IpConfigurations List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration>: One or more ip_configuration blocks as defined above.
Name string: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
DnsServers List<string>: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
EnableAcceleratedNetworking bool: Does this Network Interface support Accelerated Networking? Defaults to false.
EnableIpForwarding bool: Does this Network Interface support IP Forwarding? Defaults to false.
NetworkSecurityGroupId string: The ID of a Network Security Group which should be assigned to this Network Interface.
Primary bool: Is this the Primary IP Configuration?

IpConfigurations []WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration: One or more ip_configuration blocks as defined above.
Name string: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
DnsServers []string: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
EnableAcceleratedNetworking bool: Does this Network Interface support Accelerated Networking? Defaults to false.
EnableIpForwarding bool: Does this Network Interface support IP Forwarding? Defaults to false.
NetworkSecurityGroupId string: The ID of a Network Security Group which should be assigned to this Network Interface.
Primary bool: Is this the Primary IP Configuration?

ipConfigurations List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration>: One or more ip_configuration blocks as defined above.
name String: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
dnsServers List<String>: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
enableAcceleratedNetworking Boolean: Does this Network Interface support Accelerated Networking? Defaults to false.
enableIpForwarding Boolean: Does this Network Interface support IP Forwarding? Defaults to false.
networkSecurityGroupId String: The ID of a Network Security Group which should be assigned to this Network Interface.
primary Boolean: Is this the Primary IP Configuration?

ipConfigurations WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration[]: One or more ip_configuration blocks as defined above.
name string: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
dnsServers string[]: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
enableAcceleratedNetworking boolean: Does this Network Interface support Accelerated Networking? Defaults to false.
enableIpForwarding boolean: Does this Network Interface support IP Forwarding? Defaults to false.
networkSecurityGroupId string: The ID of a Network Security Group which should be assigned to this Network Interface.
primary boolean: Is this the Primary IP Configuration?

ip_configurations Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration]: One or more ip_configuration blocks as defined above.
name str: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
dns_servers Sequence[str]: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
enable_accelerated_networking bool: Does this Network Interface support Accelerated Networking? Defaults to false.
enable_ip_forwarding bool: Does this Network Interface support IP Forwarding? Defaults to false.
network_security_group_id str: The ID of a Network Security Group which should be assigned to this Network Interface.
primary bool: Is this the Primary IP Configuration?

ipConfigurations List<Property Map>: One or more ip_configuration blocks as defined above.
name String: The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
dnsServers List<String>: A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
enableAcceleratedNetworking Boolean: Does this Network Interface support Accelerated Networking? Defaults to false.
enableIpForwarding Boolean: Does this Network Interface support IP Forwarding? Defaults to false.
networkSecurityGroupId String: The ID of a Network Security Group which should be assigned to this Network Interface.
primary Boolean: Is this the Primary IP Configuration?

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

Name string: The Name which should be used for this IP Configuration.
ApplicationGatewayBackendAddressPoolIds List<string>: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
ApplicationSecurityGroupIds List<string>: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
LoadBalancerBackendAddressPoolIds List<string>: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
LoadBalancerInboundNatRulesIds List<string>: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Primary bool: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
PublicIpAddresses List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>: A public_ip_address block as defined below.
SubnetId string: The ID of the Subnet which this IP Configuration should be connected to.
Version string: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

Name string: The Name which should be used for this IP Configuration.
ApplicationGatewayBackendAddressPoolIds []string: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
ApplicationSecurityGroupIds []string: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
LoadBalancerBackendAddressPoolIds []string: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
LoadBalancerInboundNatRulesIds []string: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
Primary bool: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
PublicIpAddresses []WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress: A public_ip_address block as defined below.
SubnetId string: The ID of the Subnet which this IP Configuration should be connected to.
Version string: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

name String: The Name which should be used for this IP Configuration.
applicationGatewayBackendAddressPoolIds List<String>: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
applicationSecurityGroupIds List<String>: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
loadBalancerBackendAddressPoolIds List<String>: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
loadBalancerInboundNatRulesIds List<String>: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
primary Boolean: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
publicIpAddresses List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>: A public_ip_address block as defined below.
subnetId String: The ID of the Subnet which this IP Configuration should be connected to.
version String: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

name string: The Name which should be used for this IP Configuration.
applicationGatewayBackendAddressPoolIds string[]: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
applicationSecurityGroupIds string[]: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
loadBalancerBackendAddressPoolIds string[]: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
loadBalancerInboundNatRulesIds string[]: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
primary boolean: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
publicIpAddresses WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress[]: A public_ip_address block as defined below.
subnetId string: The ID of the Subnet which this IP Configuration should be connected to.
version string: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

name str: The Name which should be used for this IP Configuration.
application_gateway_backend_address_pool_ids Sequence[str]: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
application_security_group_ids Sequence[str]: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
load_balancer_backend_address_pool_ids Sequence[str]: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
load_balancer_inbound_nat_rules_ids Sequence[str]: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
primary bool: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
public_ip_addresses Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress]: A public_ip_address block as defined below.
subnet_id str: The ID of the Subnet which this IP Configuration should be connected to.
version str: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

name String: The Name which should be used for this IP Configuration.
applicationGatewayBackendAddressPoolIds List<String>: A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
applicationSecurityGroupIds List<String>: A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
loadBalancerBackendAddressPoolIds List<String>: A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
loadBalancerInboundNatRulesIds List<String>: A list of NAT Rule ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
primary Boolean: Is this the Primary IP Configuration for this Network Interface? Defaults to false.
publicIpAddresses List<Property Map>: A public_ip_address block as defined below.
subnetId String: The ID of the Subnet which this IP Configuration should be connected to.
version String: The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

Name string: The Name of the Public IP Address Configuration.
DomainNameLabel string: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
IdleTimeoutInMinutes int: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
IpTags List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
PublicIpPrefixId string: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
Version string: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

Name string: The Name of the Public IP Address Configuration.
DomainNameLabel string: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
IdleTimeoutInMinutes int: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
IpTags []WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
PublicIpPrefixId string: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
Version string: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

name String: The Name of the Public IP Address Configuration.
domainNameLabel String: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
idleTimeoutInMinutes Integer: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
ipTags List<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
publicIpPrefixId String: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
version String: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

name string: The Name of the Public IP Address Configuration.
domainNameLabel string: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
idleTimeoutInMinutes number: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
ipTags WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag[]: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
publicIpPrefixId string: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
version string: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

name str: The Name of the Public IP Address Configuration.
domain_name_label str: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
idle_timeout_in_minutes int: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
ip_tags Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag]: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
public_ip_prefix_id str: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
version str: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

name String: The Name of the Public IP Address Configuration.
domainNameLabel String: The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.
idleTimeoutInMinutes Number: The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.
ipTags List<Property Map>: One or more ip_tag blocks as defined above. Changing this forces a new resource to be created.
publicIpPrefixId String: The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.
version String: The Internet Protocol Version which should be used for this public IP address. Possible values are IPv4 and IPv6. Defaults to IPv4. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

Tag string: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
Type string: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

Tag string: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
Type string: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

tag String: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
type String: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

tag string: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
type string: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

tag str: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
type str: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

tag String: The IP Tag associated with the Public IP, such as SQL or Storage. Changing this forces a new resource to be created.
type String: The Type of IP Tag, such as FirstPartyUsage. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetOsDisk

Caching string: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
StorageAccountType string: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
DiffDiskSettings WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
DiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
DiskSizeGb int: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
SecureVmDiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
SecurityEncryptionType string: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
WriteAcceleratorEnabled bool: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

Caching string: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
StorageAccountType string: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
DiffDiskSettings WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
DiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
DiskSizeGb int: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
SecureVmDiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
SecurityEncryptionType string: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
WriteAcceleratorEnabled bool: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

caching String: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
storageAccountType String: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
diffDiskSettings WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
diskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
diskSizeGb Integer: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
secureVmDiskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
securityEncryptionType String: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
writeAcceleratorEnabled Boolean: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

caching string: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
storageAccountType string: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
diffDiskSettings WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
diskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
diskSizeGb number: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
secureVmDiskEncryptionSetId string: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
securityEncryptionType string: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
writeAcceleratorEnabled boolean: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

caching str: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
storage_account_type str: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
diff_disk_settings WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
disk_encryption_set_id str: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
disk_size_gb int: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
secure_vm_disk_encryption_set_id str: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
security_encryption_type str: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
write_accelerator_enabled bool: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

caching String: The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
storageAccountType String: The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS, StandardSSD_ZRS, Premium_LRS and Premium_ZRS. Changing this forces a new resource to be created.
diffDiskSettings Property Map: A diff_disk_settings block as defined above. Changing this forces a new resource to be created.
diskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id. Changing this forces a new resource to be created.
diskSizeGb Number: The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.
secureVmDiskEncryptionSetId String: The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.
securityEncryptionType String: Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.
writeAcceleratorEnabled Boolean: Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

Option string: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
Placement string: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

Option string: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
Placement string: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

option String: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
placement String: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

option string: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
placement string: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

option str: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
placement str: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

option String: Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.
placement String: Specifies where to store the Ephemeral Disk. Possible values are CacheDisk and ResourceDisk. Defaults to CacheDisk. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetPlan

Name string: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
Product string: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image. Changing this forces a new resource to be created.

Name string: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
Product string: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image. Changing this forces a new resource to be created.

name String: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
product String: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
publisher String: Specifies the publisher of the image. Changing this forces a new resource to be created.

name string: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
product string: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
publisher string: Specifies the publisher of the image. Changing this forces a new resource to be created.

name str: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
product str: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
publisher str: Specifies the publisher of the image. Changing this forces a new resource to be created.

name String: Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
product String: Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
publisher String: Specifies the publisher of the image. Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetRollingUpgradePolicy

MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
CrossZoneUpgradesEnabled bool: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
PrioritizeUnhealthyInstancesEnabled bool: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
CrossZoneUpgradesEnabled bool: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
PrioritizeUnhealthyInstancesEnabled bool: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

maxBatchInstancePercent Integer: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
maxUnhealthyInstancePercent Integer: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
maxUnhealthyUpgradedInstancePercent Integer: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
pauseTimeBetweenBatches String: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
crossZoneUpgradesEnabled Boolean: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
prioritizeUnhealthyInstancesEnabled Boolean: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

maxBatchInstancePercent number: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
maxUnhealthyInstancePercent number: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
maxUnhealthyUpgradedInstancePercent number: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
pauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
crossZoneUpgradesEnabled boolean: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
prioritizeUnhealthyInstancesEnabled boolean: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

max_batch_instance_percent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
max_unhealthy_instance_percent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
max_unhealthy_upgraded_instance_percent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
pause_time_between_batches str: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
cross_zone_upgrades_enabled bool: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
prioritize_unhealthy_instances_enabled bool: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

maxBatchInstancePercent Number: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability.
maxUnhealthyInstancePercent Number: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch.
maxUnhealthyUpgradedInstancePercent Number: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts.
pauseTimeBetweenBatches String: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
crossZoneUpgradesEnabled Boolean: Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are true or false.
prioritizeUnhealthyInstancesEnabled Boolean: Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are true or false.

WindowsVirtualMachineScaleSetScaleIn

ForceDeletionEnabled bool: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
Rule string: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

ForceDeletionEnabled bool: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
Rule string: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

forceDeletionEnabled Boolean: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
rule String: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

forceDeletionEnabled boolean: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
rule string: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

force_deletion_enabled bool: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
rule str: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

forceDeletionEnabled Boolean: Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are true or false. Defaults to false.
rule String: The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are Default, NewestVM and OldestVM, defaults to Default. For more information about scale in policy, please refer to this doc.

WindowsVirtualMachineScaleSetSecret

Certificates List<WindowsVirtualMachineScaleSetSecretCertificate>: One or more certificate blocks as defined above.
KeyVaultId string: The ID of the Key Vault from which all Secrets should be sourced.

Certificates []WindowsVirtualMachineScaleSetSecretCertificate: One or more certificate blocks as defined above.
KeyVaultId string: The ID of the Key Vault from which all Secrets should be sourced.

certificates List<WindowsVirtualMachineScaleSetSecretCertificate>: One or more certificate blocks as defined above.
keyVaultId String: The ID of the Key Vault from which all Secrets should be sourced.

certificates WindowsVirtualMachineScaleSetSecretCertificate[]: One or more certificate blocks as defined above.
keyVaultId string: The ID of the Key Vault from which all Secrets should be sourced.

certificates Sequence[WindowsVirtualMachineScaleSetSecretCertificate]: One or more certificate blocks as defined above.
key_vault_id str: The ID of the Key Vault from which all Secrets should be sourced.

certificates List<Property Map>: One or more certificate blocks as defined above.
keyVaultId String: The ID of the Key Vault from which all Secrets should be sourced.

WindowsVirtualMachineScaleSetSecretCertificate

Store string: The certificate store on the Virtual Machine where the certificate should be added.
Url string: The Secret URL of a Key Vault Certificate.

Store string: The certificate store on the Virtual Machine where the certificate should be added.
Url string: The Secret URL of a Key Vault Certificate.

store String: The certificate store on the Virtual Machine where the certificate should be added.
url String: The Secret URL of a Key Vault Certificate.

store string: The certificate store on the Virtual Machine where the certificate should be added.
url string: The Secret URL of a Key Vault Certificate.

store str: The certificate store on the Virtual Machine where the certificate should be added.
url str: The Secret URL of a Key Vault Certificate.

store String: The certificate store on the Virtual Machine where the certificate should be added.
url String: The Secret URL of a Key Vault Certificate.

WindowsVirtualMachineScaleSetSourceImageReference

Offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
Sku string: Specifies the SKU of the image used to create the virtual machines.
Version string: Specifies the version of the image used to create the virtual machines.

Offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
Sku string: Specifies the SKU of the image used to create the virtual machines.
Version string: Specifies the version of the image used to create the virtual machines.

offer String: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher String: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku String: Specifies the SKU of the image used to create the virtual machines.
version String: Specifies the version of the image used to create the virtual machines.

offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku string: Specifies the SKU of the image used to create the virtual machines.
version string: Specifies the version of the image used to create the virtual machines.

offer str: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher str: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku str: Specifies the SKU of the image used to create the virtual machines.
version str: Specifies the version of the image used to create the virtual machines.

offer String: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher String: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku String: Specifies the SKU of the image used to create the virtual machines.
version String: Specifies the version of the image used to create the virtual machines.

WindowsVirtualMachineScaleSetSpotRestore

Enabled bool: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
Timeout string: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

Enabled bool: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
Timeout string: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

enabled Boolean: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
timeout String: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

enabled boolean: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
timeout string: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

enabled bool: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
timeout str: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

enabled Boolean: Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are true or false. Defaults to false. Changing this forces a new resource to be created.
timeout String: The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between 15 minutes and 120 minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to 90 minutes (e.g. PT1H30M). Changing this forces a new resource to be created.

WindowsVirtualMachineScaleSetTerminateNotification

Enabled bool: Should the terminate notification be enabled on this Virtual Machine Scale Set?
Timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

Enabled bool: Should the terminate notification be enabled on this Virtual Machine Scale Set?
Timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled Boolean: Should the terminate notification be enabled on this Virtual Machine Scale Set?
timeout String: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled boolean: Should the terminate notification be enabled on this Virtual Machine Scale Set?
timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled bool: Should the terminate notification be enabled on this Virtual Machine Scale Set?
timeout str: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled Boolean: Should the terminate notification be enabled on this Virtual Machine Scale Set?
timeout String: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

WindowsVirtualMachineScaleSetTerminationNotification

Enabled bool: Should the termination notification be enabled on this Virtual Machine Scale Set?
Timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

Enabled bool: Should the termination notification be enabled on this Virtual Machine Scale Set?
Timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled Boolean: Should the termination notification be enabled on this Virtual Machine Scale Set?
timeout String: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled boolean: Should the termination notification be enabled on this Virtual Machine Scale Set?
timeout string: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled bool: Should the termination notification be enabled on this Virtual Machine Scale Set?
timeout str: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

enabled Boolean: Should the termination notification be enabled on this Virtual Machine Scale Set?
timeout String: Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M.

WindowsVirtualMachineScaleSetWinrmListener

Protocol string: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
CertificateUrl string: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

Protocol string: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
CertificateUrl string: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

protocol String: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
certificateUrl String: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

protocol string: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
certificateUrl string: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

protocol str: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
certificate_url str: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

protocol String: The Protocol of the WinRM Listener. Possible values are Http and Https. Changing this forces a new resource to be created.
certificateUrl String: The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

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

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

azure.compute.WindowsVirtualMachineScaleSet

Disclaimers

Example Usage

Create WindowsVirtualMachineScaleSet Resource

WindowsVirtualMachineScaleSet Resource Properties

Inputs

Outputs

Look up Existing WindowsVirtualMachineScaleSet Resource

Supporting Types

WindowsVirtualMachineScaleSetAdditionalCapabilities

WindowsVirtualMachineScaleSetAdditionalUnattendContent

WindowsVirtualMachineScaleSetAutomaticInstanceRepair

WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy

WindowsVirtualMachineScaleSetBootDiagnostics

WindowsVirtualMachineScaleSetDataDisk

WindowsVirtualMachineScaleSetExtension

WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault

WindowsVirtualMachineScaleSetGalleryApplication

WindowsVirtualMachineScaleSetIdentity

WindowsVirtualMachineScaleSetNetworkInterface

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

WindowsVirtualMachineScaleSetOsDisk

WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

WindowsVirtualMachineScaleSetPlan

WindowsVirtualMachineScaleSetRollingUpgradePolicy

WindowsVirtualMachineScaleSetScaleIn

WindowsVirtualMachineScaleSetSecret

WindowsVirtualMachineScaleSetSecretCertificate

WindowsVirtualMachineScaleSetSourceImageReference

WindowsVirtualMachineScaleSetSpotRestore

WindowsVirtualMachineScaleSetTerminateNotification

WindowsVirtualMachineScaleSetTerminationNotification

WindowsVirtualMachineScaleSetWinrmListener

Import

Package Details

On this page

On this page