OrchestratedVirtualMachineScaleSet

class OrchestratedVirtualMachineScaleSet : KotlinCustomResource

Manages an Virtual Machine Scale Set in Flexible Orchestration Mode.

Disclaimers

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleOrchestratedVirtualMachineScaleSet = new azure.compute.OrchestratedVirtualMachineScaleSet("example", {
name: "example-VMSS",
location: example.location,
resourceGroupName: example.name,
platformFaultDomainCount: 1,
zones: ["1"],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_orchestrated_virtual_machine_scale_set = azure.compute.OrchestratedVirtualMachineScaleSet("example",
name="example-VMSS",
location=example.location,
resource_group_name=example.name,
platform_fault_domain_count=1,
zones=["1"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleOrchestratedVirtualMachineScaleSet = new Azure.Compute.OrchestratedVirtualMachineScaleSet("example", new()
{
Name = "example-VMSS",
Location = example.Location,
ResourceGroupName = example.Name,
PlatformFaultDomainCount = 1,
Zones = new[]
{
"1",
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = compute.NewOrchestratedVirtualMachineScaleSet(ctx, "example", &compute.OrchestratedVirtualMachineScaleSetArgs{
Name: pulumi.String("example-VMSS"),
Location: example.Location,
ResourceGroupName: example.Name,
PlatformFaultDomainCount: pulumi.Int(1),
Zones: pulumi.StringArray{
pulumi.String("1"),
},
})
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.compute.OrchestratedVirtualMachineScaleSet;
import com.pulumi.azure.compute.OrchestratedVirtualMachineScaleSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleOrchestratedVirtualMachineScaleSet = new OrchestratedVirtualMachineScaleSet("exampleOrchestratedVirtualMachineScaleSet", OrchestratedVirtualMachineScaleSetArgs.builder()
.name("example-VMSS")
.location(example.location())
.resourceGroupName(example.name())
.platformFaultDomainCount(1)
.zones("1")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleOrchestratedVirtualMachineScaleSet:
type: azure:compute:OrchestratedVirtualMachineScaleSet
name: example
properties:
name: example-VMSS
location: ${example.location}
resourceGroupName: ${example.name}
platformFaultDomainCount: 1
zones:
- '1'

Import

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

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

Properties

Link copied to clipboard

An additional_capabilities block as defined below.

Link copied to clipboard

An automatic_instance_repair block as defined below.

Link copied to clipboard

A boot_diagnostics block as defined below.

Link copied to clipboard

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

Link copied to clipboard

One or more data_disk blocks as defined below.

Link copied to clipboard

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

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

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

Link copied to clipboard

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

Link copied to clipboard

One or more extension blocks as defined below

Link copied to clipboard

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.

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

An identity block as defined below.

Link copied to clipboard
val instances: Output<Int>

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

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

Link copied to clipboard
val location: Output<String>

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

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

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard

One or more network_interface blocks as defined below.

Link copied to clipboard

An os_disk block as defined below.

Link copied to clipboard

An os_profile block as defined below.

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

a priority_mix block as defined below

Link copied to clipboard

The ID of the Proximity Placement Group which the Virtual Machine should be assigned to. 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

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

Link copied to clipboard

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

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

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

Link copied to clipboard

An sku_profile block as defined below. Changing this forces a new resource to be created.

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

Link copied to clipboard

A source_image_reference block as defined below.

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

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

Link copied to clipboard

A termination_notification block as defined below.

Link copied to clipboard
val uniqueId: Output<String>

The Unique ID for the Virtual Machine Scale Set.

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

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

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

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

Specifies a list of Availability Zones across which the Virtual Machine Scale Set will create instances.