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

ScaleSet

class ScaleSet : KotlinCustomResource

Manages a virtual machine scale set.

Example Usage

With Managed Disks (Recommended)

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.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.lb.LoadBalancer;
import com.pulumi.azure.lb.LoadBalancerArgs;
import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
import com.pulumi.azure.lb.BackendAddressPool;
import com.pulumi.azure.lb.BackendAddressPoolArgs;
import com.pulumi.azure.lb.NatPool;
import com.pulumi.azure.lb.NatPoolArgs;
import com.pulumi.azure.lb.Probe;
import com.pulumi.azure.lb.ProbeArgs;
import com.pulumi.azure.compute.ScaleSet;
import com.pulumi.azure.compute.ScaleSetArgs;
import com.pulumi.azure.compute.inputs.ScaleSetRollingUpgradePolicyArgs;
import com.pulumi.azure.compute.inputs.ScaleSetSkuArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileImageReferenceArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileOsDiskArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileDataDiskArgs;
import com.pulumi.azure.compute.inputs.ScaleSetOsProfileArgs;
import com.pulumi.azure.compute.inputs.ScaleSetOsProfileLinuxConfigArgs;
import com.pulumi.azure.compute.inputs.ScaleSetNetworkProfileArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("acctvn")
            .addressSpaces("10.0.0.0/16")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("acctsub")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());
        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .name("test")
            .location(example.location())
            .resourceGroupName(example.name())
            .allocationMethod("Static")
            .domainNameLabel(example.name())
            .tags(Map.of("environment", "staging"))
            .build());
        var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
            .name("test")
            .location(example.location())
            .resourceGroupName(example.name())
            .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
                .name("PublicIPAddress")
                .publicIpAddressId(examplePublicIp.id())
                .build())
            .build());
        var bpepool = new BackendAddressPool("bpepool", BackendAddressPoolArgs.builder()
            .loadbalancerId(exampleLoadBalancer.id())
            .name("BackEndAddressPool")
            .build());
        var lbnatpool = new NatPool("lbnatpool", NatPoolArgs.builder()
            .resourceGroupName(example.name())
            .name("ssh")
            .loadbalancerId(exampleLoadBalancer.id())
            .protocol("Tcp")
            .frontendPortStart(50000)
            .frontendPortEnd(50119)
            .backendPort(22)
            .frontendIpConfigurationName("PublicIPAddress")
            .build());
        var exampleProbe = new Probe("exampleProbe", ProbeArgs.builder()
            .loadbalancerId(exampleLoadBalancer.id())
            .name("http-probe")
            .protocol("Http")
            .requestPath("/health")
            .port(8080)
            .build());
        var exampleScaleSet = new ScaleSet("exampleScaleSet", ScaleSetArgs.builder()
            .name("mytestscaleset-1")
            .location(example.location())
            .resourceGroupName(example.name())
            .automaticOsUpgrade(true)
            .upgradePolicyMode("Rolling")
            .rollingUpgradePolicy(ScaleSetRollingUpgradePolicyArgs.builder()
                .maxBatchInstancePercent(20)
                .maxUnhealthyInstancePercent(20)
                .maxUnhealthyUpgradedInstancePercent(5)
                .pauseTimeBetweenBatches("PT0S")
                .build())
            .healthProbeId(exampleProbe.id())
            .sku(ScaleSetSkuArgs.builder()
                .name("Standard_F2")
                .tier("Standard")
                .capacity(2)
                .build())
            .storageProfileImageReference(ScaleSetStorageProfileImageReferenceArgs.builder()
                .publisher("Canonical")
                .offer("0001-com-ubuntu-server-jammy")
                .sku("22_04-lts")
                .version("latest")
                .build())
            .storageProfileOsDisk(ScaleSetStorageProfileOsDiskArgs.builder()
                .name("")
                .caching("ReadWrite")
                .createOption("FromImage")
                .managedDiskType("Standard_LRS")
                .build())
            .storageProfileDataDisks(ScaleSetStorageProfileDataDiskArgs.builder()
                .lun(0)
                .caching("ReadWrite")
                .createOption("Empty")
                .diskSizeGb(10)
                .build())
            .osProfile(ScaleSetOsProfileArgs.builder()
                .computerNamePrefix("testvm")
                .adminUsername("myadmin")
                .build())
            .osProfileLinuxConfig(ScaleSetOsProfileLinuxConfigArgs.builder()
                .disablePasswordAuthentication(true)
                .sshKeys(ScaleSetOsProfileLinuxConfigSshKeyArgs.builder()
                    .path("/home/myadmin/.ssh/authorized_keys")
                    .keyData(StdFunctions.file(FileArgs.builder()
                        .input("~/.ssh/demo_key.pub")
                        .build()).result())
                    .build())
                .build())
            .networkProfiles(ScaleSetNetworkProfileArgs.builder()
                .name("mynetworkprofile")
                .primary(true)
                .ipConfigurations(ScaleSetNetworkProfileIpConfigurationArgs.builder()
                    .name("TestIPConfiguration")
                    .primary(true)
                    .subnetId(exampleSubnet.id())
                    .loadBalancerBackendAddressPoolIds(bpepool.id())
                    .loadBalancerInboundNatRulesIds(lbnatpool.id())
                    .build())
                .build())
            .tags(Map.of("environment", "staging"))
            .build());
    }
}
Content copied to clipboard

With Unmanaged Disks

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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.compute.ScaleSet;
import com.pulumi.azure.compute.ScaleSetArgs;
import com.pulumi.azure.compute.inputs.ScaleSetSkuArgs;
import com.pulumi.azure.compute.inputs.ScaleSetOsProfileArgs;
import com.pulumi.azure.compute.inputs.ScaleSetOsProfileLinuxConfigArgs;
import com.pulumi.azure.compute.inputs.ScaleSetNetworkProfileArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileOsDiskArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileImageReferenceArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("acctvn")
            .addressSpaces("10.0.0.0/16")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("acctsub")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("accsa")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .tags(Map.of("environment", "staging"))
            .build());
        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("vhds")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());
        var exampleScaleSet = new ScaleSet("exampleScaleSet", ScaleSetArgs.builder()
            .name("mytestscaleset-1")
            .location(example.location())
            .resourceGroupName(example.name())
            .upgradePolicyMode("Manual")
            .sku(ScaleSetSkuArgs.builder()
                .name("Standard_F2")
                .tier("Standard")
                .capacity(2)
                .build())
            .osProfile(ScaleSetOsProfileArgs.builder()
                .computerNamePrefix("testvm")
                .adminUsername("myadmin")
                .build())
            .osProfileLinuxConfig(ScaleSetOsProfileLinuxConfigArgs.builder()
                .disablePasswordAuthentication(true)
                .sshKeys(ScaleSetOsProfileLinuxConfigSshKeyArgs.builder()
                    .path("/home/myadmin/.ssh/authorized_keys")
                    .keyData(StdFunctions.file(FileArgs.builder()
                        .input("~/.ssh/demo_key.pub")
                        .build()).result())
                    .build())
                .build())
            .networkProfiles(ScaleSetNetworkProfileArgs.builder()
                .name("TestNetworkProfile")
                .primary(true)
                .ipConfigurations(ScaleSetNetworkProfileIpConfigurationArgs.builder()
                    .name("TestIPConfiguration")
                    .primary(true)
                    .subnetId(exampleSubnet.id())
                    .build())
                .build())
            .storageProfileOsDisk(ScaleSetStorageProfileOsDiskArgs.builder()
                .name("osDiskProfile")
                .caching("ReadWrite")
                .createOption("FromImage")
                .vhdContainers(Output.tuple(exampleAccount.primaryBlobEndpoint(), exampleContainer.name()).applyValue(values -> {
                    var primaryBlobEndpoint = values.t1;
                    var name = values.t2;
                    return String.format("%s%s", primaryBlobEndpoint,name);
                }))
                .build())
            .storageProfileImageReference(ScaleSetStorageProfileImageReferenceArgs.builder()
                .publisher("Canonical")
                .offer("0001-com-ubuntu-server-jammy")
                .sku("22_04-lts")
                .version("latest")
                .build())
            .build());
    }
}
Content copied to clipboard

Example of storage_profile_image_reference with id

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.compute.Image("example", {name: "test"});
const exampleScaleSet = new azure.compute.ScaleSet("example", {
    name: "test",
    storageProfileImageReference: {
        id: example.id,
    },
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.compute.Image("example", name="test")
example_scale_set = azure.compute.ScaleSet("example",
    name="test",
    storage_profile_image_reference=azure.compute.ScaleSetStorageProfileImageReferenceArgs(
        id=example.id,
    ))
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = new Azure.Compute.Image("example", new()
    {
        Name = "test",
    });
    var exampleScaleSet = new Azure.Compute.ScaleSet("example", new()
    {
        Name = "test",
        StorageProfileImageReference = new Azure.Compute.Inputs.ScaleSetStorageProfileImageReferenceArgs
        {
            Id = example.Id,
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := compute.NewImage(ctx, "example", &compute.ImageArgs{
			Name: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewScaleSet(ctx, "example", &compute.ScaleSetArgs{
			Name: pulumi.String("test"),
			StorageProfileImageReference: &compute.ScaleSetStorageProfileImageReferenceArgs{
				Id: example.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.compute.Image;
import com.pulumi.azure.compute.ImageArgs;
import com.pulumi.azure.compute.ScaleSet;
import com.pulumi.azure.compute.ScaleSetArgs;
import com.pulumi.azure.compute.inputs.ScaleSetStorageProfileImageReferenceArgs;
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 example = new Image("example", ImageArgs.builder()
            .name("test")
            .build());
        var exampleScaleSet = new ScaleSet("exampleScaleSet", ScaleSetArgs.builder()
            .name("test")
            .storageProfileImageReference(ScaleSetStorageProfileImageReferenceArgs.builder()
                .id(example.id())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:compute:Image
    properties:
      name: test
  exampleScaleSet:
    type: azure:compute:ScaleSet
    name: example
    properties:
      name: test
      storageProfileImageReference:
        id: ${example.id}
Content copied to clipboard

Import

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

$ pulumi import azure:compute/scaleSet:ScaleSet scaleset1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleset1
Content copied to clipboard

Properties

Link copied to clipboard
val automaticOsUpgrade: Output<Boolean>?

Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.

Link copied to clipboard
val bootDiagnostics: Output<ScaleSetBootDiagnostics>?

A boot_diagnostics block as referenced below.

Link copied to clipboard
val evictionPolicy: Output<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.

Link copied to clipboard
val extensions: Output<List<ScaleSetExtension>>?

Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.

Link copied to clipboard
val healthProbeId: Output<String>?

Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val identity: Output<ScaleSetIdentity>

An identity block as defined below.

Link copied to clipboard
val licenseType: Output<String>

(Optional, when a Windows machine) Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.

Link copied to clipboard
val location: Output<String>

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Link copied to clipboard
val name: Output<String>

Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.

Link copied to clipboard
val networkProfiles: Output<List<ScaleSetNetworkProfile>>

A collection of network_profile blocks as documented below.

Link copied to clipboard
val osProfile: Output<ScaleSetOsProfile>

A os_profile block as documented below.

Link copied to clipboard
val osProfileLinuxConfig: Output<ScaleSetOsProfileLinuxConfig>

A os_profile_linux_config block as documented below.

Link copied to clipboard
val osProfileSecrets: Output<List<ScaleSetOsProfileSecret>>?

A collection of os_profile_secrets blocks as documented below.

Link copied to clipboard
val osProfileWindowsConfig: Output<ScaleSetOsProfileWindowsConfig>?

A os_profile_windows_config block as documented below.

Link copied to clipboard
val overprovision: Output<Boolean>?

Specifies whether the virtual machine scale set should be overprovisioned. Defaults to true.

Link copied to clipboard
val plan: Output<ScaleSetPlan>?

A plan block as documented below.

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

Specifies the priority for the Virtual Machines in the Scale Set. Possible values are Low and Regular. Changing this forces a new resource to be created.

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

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val resourceGroupName: Output<String>

The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.

Link copied to clipboard
val rollingUpgradePolicy: Output<ScaleSetRollingUpgradePolicy>?

A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.

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

Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Changing this forces a new resource to be created. See documentation for more information. Defaults to true.

Link copied to clipboard
val sku: Output<ScaleSetSku>

A sku block as documented below.

Link copied to clipboard
val storageProfileDataDisks: Output<List<ScaleSetStorageProfileDataDisk>>?

A storage_profile_data_disk block as documented below.

Link copied to clipboard
val storageProfileImageReference: Output<ScaleSetStorageProfileImageReference>

A storage_profile_image_reference block as documented below.

Link copied to clipboard
val storageProfileOsDisk: Output<ScaleSetStorageProfileOsDisk>

A storage_profile_os_disk block as documented below.

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

A mapping of tags to assign to the resource.

Link copied to clipboard
val upgradePolicyMode: Output<String>

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.

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

A collection of availability zones to spread the Virtual Machines over. Changing this forces a new resource to be created.