We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages a Windows Virtual Machine Scale Set.
Disclaimers
NOTE: As of the v2.86.0 (November 19, 2021) release of the provider this resource will only create Virtual Machine Scale Sets with the Uniform Orchestration Mode.
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
featuressetting 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.ScaleSetresource instead
Example Usage
This example provisions a basic Windows Virtual Machine Scale Set on an internal network.
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AddressSpaces =
{
"10.0.0.0/16",
},
});
var @internal = new Azure.Network.Subnet("internal", new Azure.Network.SubnetArgs
{
ResourceGroupName = exampleResourceGroup.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes =
{
"10.0.2.0/24",
},
});
var exampleWindowsVirtualMachineScaleSet = new Azure.Compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", new Azure.Compute.WindowsVirtualMachineScaleSetArgs
{
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 Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs
{
Name = "example",
Primary = true,
IpConfigurations =
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
{
Name = "internal",
Primary = true,
SubnetId = @internal.Id,
},
},
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/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
})
}
Example coming soon!
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,
}],
}],
});
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,
)],
)])
Example coming soon!
Create WindowsVirtualMachineScaleSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WindowsVirtualMachineScaleSet(name: string, args: WindowsVirtualMachineScaleSetArgs, opts?: CustomResourceOptions);@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
args: WindowsVirtualMachineScaleSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
instances: Optional[int] = None,
sku: Optional[str] = None,
admin_password: Optional[str] = None,
admin_username: Optional[str] = None,
resource_group_name: Optional[str] = None,
os_disk: Optional[WindowsVirtualMachineScaleSetOsDiskArgs] = None,
network_interfaces: Optional[Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
encryption_at_host_enabled: Optional[bool] = None,
priority: Optional[str] = None,
data_disks: Optional[Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]] = None,
do_not_run_extensions_on_overprovisioned_machines: Optional[bool] = None,
enable_automatic_updates: Optional[bool] = None,
additional_capabilities: Optional[WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
eviction_policy: Optional[str] = None,
extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
health_probe_id: Optional[str] = None,
identity: Optional[WindowsVirtualMachineScaleSetIdentityArgs] = None,
computer_name_prefix: Optional[str] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
boot_diagnostics: Optional[WindowsVirtualMachineScaleSetBootDiagnosticsArgs] = None,
automatic_os_upgrade_policy: Optional[WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs] = None,
overprovision: Optional[bool] = None,
plan: Optional[WindowsVirtualMachineScaleSetPlanArgs] = None,
platform_fault_domain_count: Optional[int] = None,
custom_data: Optional[str] = None,
provision_vm_agent: Optional[bool] = None,
proximity_placement_group_id: Optional[str] = None,
automatic_instance_repair: Optional[WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
rolling_upgrade_policy: Optional[WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs] = None,
scale_in_policy: Optional[str] = None,
secrets: Optional[Sequence[WindowsVirtualMachineScaleSetSecretArgs]] = None,
secure_boot_enabled: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[WindowsVirtualMachineScaleSetSourceImageReferenceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = 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)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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var windowsVirtualMachineScaleSetResource = new Azure.Compute.WindowsVirtualMachineScaleSet("windowsVirtualMachineScaleSetResource", new()
{
Instances = 0,
Sku = "string",
AdminPassword = "string",
AdminUsername = "string",
ResourceGroupName = "string",
OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetOsDiskArgs
{
Caching = "string",
StorageAccountType = "string",
DiffDiskSettings = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs
{
Option = "string",
},
DiskEncryptionSetId = "string",
DiskSizeGb = 0,
WriteAcceleratorEnabled = false,
},
NetworkInterfaces = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs
{
IpConfigurations = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
{
Name = "string",
ApplicationGatewayBackendAddressPoolIds = new[]
{
"string",
},
ApplicationSecurityGroupIds = new[]
{
"string",
},
LoadBalancerBackendAddressPoolIds = new[]
{
"string",
},
LoadBalancerInboundNatRulesIds = new[]
{
"string",
},
Primary = false,
PublicIpAddresses = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs
{
Name = "string",
DomainNameLabel = "string",
IdleTimeoutInMinutes = 0,
IpTags = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs
{
Tag = "string",
Type = "string",
},
},
PublicIpPrefixId = "string",
},
},
SubnetId = "string",
Version = "string",
},
},
Name = "string",
DnsServers = new[]
{
"string",
},
EnableAcceleratedNetworking = false,
EnableIpForwarding = false,
NetworkSecurityGroupId = "string",
Primary = false,
},
},
EncryptionAtHostEnabled = false,
Priority = "string",
DataDisks = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetDataDiskArgs
{
Caching = "string",
DiskSizeGb = 0,
Lun = 0,
StorageAccountType = "string",
CreateOption = "string",
DiskEncryptionSetId = "string",
UltraSsdDiskIopsReadWrite = 0,
UltraSsdDiskMbpsReadWrite = 0,
WriteAcceleratorEnabled = false,
},
},
DoNotRunExtensionsOnOverprovisionedMachines = false,
EnableAutomaticUpdates = false,
AdditionalCapabilities = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs
{
UltraSsdEnabled = false,
},
EvictionPolicy = "string",
Extensions = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetExtensionArgs
{
Name = "string",
Publisher = "string",
Type = "string",
TypeHandlerVersion = "string",
AutoUpgradeMinorVersion = false,
AutomaticUpgradeEnabled = false,
ForceUpdateTag = "string",
ProtectedSettings = "string",
ProvisionAfterExtensions = new[]
{
"string",
},
Settings = "string",
},
},
ExtensionsTimeBudget = "string",
HealthProbeId = "string",
Identity = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
ComputerNamePrefix = "string",
LicenseType = "string",
Location = "string",
MaxBidPrice = 0,
Name = "string",
BootDiagnostics = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetBootDiagnosticsArgs
{
StorageAccountUri = "string",
},
AutomaticOsUpgradePolicy = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs
{
DisableAutomaticRollback = false,
EnableAutomaticOsUpgrade = false,
},
Overprovision = false,
Plan = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetPlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
},
PlatformFaultDomainCount = 0,
CustomData = "string",
ProvisionVmAgent = false,
ProximityPlacementGroupId = "string",
AutomaticInstanceRepair = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs
{
Enabled = false,
GracePeriod = "string",
},
RollingUpgradePolicy = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs
{
MaxBatchInstancePercent = 0,
MaxUnhealthyInstancePercent = 0,
MaxUnhealthyUpgradedInstancePercent = 0,
PauseTimeBetweenBatches = "string",
},
ScaleInPolicy = "string",
Secrets = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetSecretArgs
{
Certificates = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetSecretCertificateArgs
{
Store = "string",
Url = "string",
},
},
KeyVaultId = "string",
},
},
SecureBootEnabled = false,
SinglePlacementGroup = false,
AdditionalUnattendContents = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs
{
Content = "string",
Setting = "string",
},
},
SourceImageId = "string",
SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetSourceImageReferenceArgs
{
Offer = "string",
Publisher = "string",
Sku = "string",
Version = "string",
},
Tags =
{
{ "string", "string" },
},
TerminateNotification = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetTerminateNotificationArgs
{
Enabled = false,
Timeout = "string",
},
Timezone = "string",
UpgradeMode = "string",
UserData = "string",
VtpmEnabled = false,
WinrmListeners = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetWinrmListenerArgs
{
Protocol = "string",
CertificateUrl = "string",
},
},
ZoneBalance = false,
Zones = new[]
{
"string",
},
});
example, err := compute.NewWindowsVirtualMachineScaleSet(ctx, "windowsVirtualMachineScaleSetResource", &compute.WindowsVirtualMachineScaleSetArgs{
Instances: pulumi.Int(0),
Sku: pulumi.String("string"),
AdminPassword: pulumi.String("string"),
AdminUsername: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
OsDisk: &compute.WindowsVirtualMachineScaleSetOsDiskArgs{
Caching: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
DiffDiskSettings: &compute.WindowsVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs{
Option: pulumi.String("string"),
},
DiskEncryptionSetId: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
NetworkInterfaces: compute.WindowsVirtualMachineScaleSetNetworkInterfaceArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceArgs{
IpConfigurations: compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
Name: pulumi.String("string"),
ApplicationGatewayBackendAddressPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
ApplicationSecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
LoadBalancerBackendAddressPoolIds: pulumi.StringArray{
pulumi.String("string"),
},
LoadBalancerInboundNatRulesIds: pulumi.StringArray{
pulumi.String("string"),
},
Primary: pulumi.Bool(false),
PublicIpAddresses: compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs{
Name: pulumi.String("string"),
DomainNameLabel: pulumi.String("string"),
IdleTimeoutInMinutes: pulumi.Int(0),
IpTags: compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs{
Tag: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
PublicIpPrefixId: pulumi.String("string"),
},
},
SubnetId: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
DnsServers: pulumi.StringArray{
pulumi.String("string"),
},
EnableAcceleratedNetworking: pulumi.Bool(false),
EnableIpForwarding: pulumi.Bool(false),
NetworkSecurityGroupId: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
EncryptionAtHostEnabled: pulumi.Bool(false),
Priority: pulumi.String("string"),
DataDisks: compute.WindowsVirtualMachineScaleSetDataDiskArray{
&compute.WindowsVirtualMachineScaleSetDataDiskArgs{
Caching: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
Lun: pulumi.Int(0),
StorageAccountType: pulumi.String("string"),
CreateOption: pulumi.String("string"),
DiskEncryptionSetId: pulumi.String("string"),
UltraSsdDiskIopsReadWrite: pulumi.Int(0),
UltraSsdDiskMbpsReadWrite: pulumi.Int(0),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
},
DoNotRunExtensionsOnOverprovisionedMachines: pulumi.Bool(false),
EnableAutomaticUpdates: pulumi.Bool(false),
AdditionalCapabilities: &compute.WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs{
UltraSsdEnabled: pulumi.Bool(false),
},
EvictionPolicy: pulumi.String("string"),
Extensions: compute.WindowsVirtualMachineScaleSetExtensionArray{
&compute.WindowsVirtualMachineScaleSetExtensionArgs{
Name: pulumi.String("string"),
Publisher: pulumi.String("string"),
Type: pulumi.String("string"),
TypeHandlerVersion: pulumi.String("string"),
AutoUpgradeMinorVersion: pulumi.Bool(false),
AutomaticUpgradeEnabled: pulumi.Bool(false),
ForceUpdateTag: pulumi.String("string"),
ProtectedSettings: pulumi.String("string"),
ProvisionAfterExtensions: pulumi.StringArray{
pulumi.String("string"),
},
Settings: pulumi.String("string"),
},
},
ExtensionsTimeBudget: pulumi.String("string"),
HealthProbeId: pulumi.String("string"),
Identity: &compute.WindowsVirtualMachineScaleSetIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
ComputerNamePrefix: pulumi.String("string"),
LicenseType: pulumi.String("string"),
Location: pulumi.String("string"),
MaxBidPrice: pulumi.Float64(0),
Name: pulumi.String("string"),
BootDiagnostics: &compute.WindowsVirtualMachineScaleSetBootDiagnosticsArgs{
StorageAccountUri: pulumi.String("string"),
},
AutomaticOsUpgradePolicy: &compute.WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs{
DisableAutomaticRollback: pulumi.Bool(false),
EnableAutomaticOsUpgrade: pulumi.Bool(false),
},
Overprovision: pulumi.Bool(false),
Plan: &compute.WindowsVirtualMachineScaleSetPlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
},
PlatformFaultDomainCount: pulumi.Int(0),
CustomData: pulumi.String("string"),
ProvisionVmAgent: pulumi.Bool(false),
ProximityPlacementGroupId: pulumi.String("string"),
AutomaticInstanceRepair: &compute.WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs{
Enabled: pulumi.Bool(false),
GracePeriod: pulumi.String("string"),
},
RollingUpgradePolicy: &compute.WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs{
MaxBatchInstancePercent: pulumi.Int(0),
MaxUnhealthyInstancePercent: pulumi.Int(0),
MaxUnhealthyUpgradedInstancePercent: pulumi.Int(0),
PauseTimeBetweenBatches: pulumi.String("string"),
},
ScaleInPolicy: pulumi.String("string"),
Secrets: compute.WindowsVirtualMachineScaleSetSecretArray{
&compute.WindowsVirtualMachineScaleSetSecretArgs{
Certificates: compute.WindowsVirtualMachineScaleSetSecretCertificateArray{
&compute.WindowsVirtualMachineScaleSetSecretCertificateArgs{
Store: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
KeyVaultId: pulumi.String("string"),
},
},
SecureBootEnabled: pulumi.Bool(false),
SinglePlacementGroup: pulumi.Bool(false),
AdditionalUnattendContents: compute.WindowsVirtualMachineScaleSetAdditionalUnattendContentArray{
&compute.WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs{
Content: pulumi.String("string"),
Setting: pulumi.String("string"),
},
},
SourceImageId: pulumi.String("string"),
SourceImageReference: &compute.WindowsVirtualMachineScaleSetSourceImageReferenceArgs{
Offer: pulumi.String("string"),
Publisher: pulumi.String("string"),
Sku: pulumi.String("string"),
Version: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TerminateNotification: &compute.WindowsVirtualMachineScaleSetTerminateNotificationArgs{
Enabled: pulumi.Bool(false),
Timeout: pulumi.String("string"),
},
Timezone: pulumi.String("string"),
UpgradeMode: pulumi.String("string"),
UserData: pulumi.String("string"),
VtpmEnabled: pulumi.Bool(false),
WinrmListeners: compute.WindowsVirtualMachineScaleSetWinrmListenerArray{
&compute.WindowsVirtualMachineScaleSetWinrmListenerArgs{
Protocol: pulumi.String("string"),
CertificateUrl: pulumi.String("string"),
},
},
ZoneBalance: pulumi.Bool(false),
Zones: pulumi.StringArray{
pulumi.String("string"),
},
})
var windowsVirtualMachineScaleSetResource = new WindowsVirtualMachineScaleSet("windowsVirtualMachineScaleSetResource", WindowsVirtualMachineScaleSetArgs.builder()
.instances(0)
.sku("string")
.adminPassword("string")
.adminUsername("string")
.resourceGroupName("string")
.osDisk(WindowsVirtualMachineScaleSetOsDiskArgs.builder()
.caching("string")
.storageAccountType("string")
.diffDiskSettings(WindowsVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs.builder()
.option("string")
.build())
.diskEncryptionSetId("string")
.diskSizeGb(0)
.writeAcceleratorEnabled(false)
.build())
.networkInterfaces(WindowsVirtualMachineScaleSetNetworkInterfaceArgs.builder()
.ipConfigurations(WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
.name("string")
.applicationGatewayBackendAddressPoolIds("string")
.applicationSecurityGroupIds("string")
.loadBalancerBackendAddressPoolIds("string")
.loadBalancerInboundNatRulesIds("string")
.primary(false)
.publicIpAddresses(WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs.builder()
.name("string")
.domainNameLabel("string")
.idleTimeoutInMinutes(0)
.ipTags(WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs.builder()
.tag("string")
.type("string")
.build())
.publicIpPrefixId("string")
.build())
.subnetId("string")
.version("string")
.build())
.name("string")
.dnsServers("string")
.enableAcceleratedNetworking(false)
.enableIpForwarding(false)
.networkSecurityGroupId("string")
.primary(false)
.build())
.encryptionAtHostEnabled(false)
.priority("string")
.dataDisks(WindowsVirtualMachineScaleSetDataDiskArgs.builder()
.caching("string")
.diskSizeGb(0)
.lun(0)
.storageAccountType("string")
.createOption("string")
.diskEncryptionSetId("string")
.ultraSsdDiskIopsReadWrite(0)
.ultraSsdDiskMbpsReadWrite(0)
.writeAcceleratorEnabled(false)
.build())
.doNotRunExtensionsOnOverprovisionedMachines(false)
.enableAutomaticUpdates(false)
.additionalCapabilities(WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs.builder()
.ultraSsdEnabled(false)
.build())
.evictionPolicy("string")
.extensions(WindowsVirtualMachineScaleSetExtensionArgs.builder()
.name("string")
.publisher("string")
.type("string")
.typeHandlerVersion("string")
.autoUpgradeMinorVersion(false)
.automaticUpgradeEnabled(false)
.forceUpdateTag("string")
.protectedSettings("string")
.provisionAfterExtensions("string")
.settings("string")
.build())
.extensionsTimeBudget("string")
.healthProbeId("string")
.identity(WindowsVirtualMachineScaleSetIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.computerNamePrefix("string")
.licenseType("string")
.location("string")
.maxBidPrice(0.0)
.name("string")
.bootDiagnostics(WindowsVirtualMachineScaleSetBootDiagnosticsArgs.builder()
.storageAccountUri("string")
.build())
.automaticOsUpgradePolicy(WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs.builder()
.disableAutomaticRollback(false)
.enableAutomaticOsUpgrade(false)
.build())
.overprovision(false)
.plan(WindowsVirtualMachineScaleSetPlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.build())
.platformFaultDomainCount(0)
.customData("string")
.provisionVmAgent(false)
.proximityPlacementGroupId("string")
.automaticInstanceRepair(WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs.builder()
.enabled(false)
.gracePeriod("string")
.build())
.rollingUpgradePolicy(WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs.builder()
.maxBatchInstancePercent(0)
.maxUnhealthyInstancePercent(0)
.maxUnhealthyUpgradedInstancePercent(0)
.pauseTimeBetweenBatches("string")
.build())
.scaleInPolicy("string")
.secrets(WindowsVirtualMachineScaleSetSecretArgs.builder()
.certificates(WindowsVirtualMachineScaleSetSecretCertificateArgs.builder()
.store("string")
.url("string")
.build())
.keyVaultId("string")
.build())
.secureBootEnabled(false)
.singlePlacementGroup(false)
.additionalUnattendContents(WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs.builder()
.content("string")
.setting("string")
.build())
.sourceImageId("string")
.sourceImageReference(WindowsVirtualMachineScaleSetSourceImageReferenceArgs.builder()
.offer("string")
.publisher("string")
.sku("string")
.version("string")
.build())
.tags(Map.of("string", "string"))
.terminateNotification(WindowsVirtualMachineScaleSetTerminateNotificationArgs.builder()
.enabled(false)
.timeout("string")
.build())
.timezone("string")
.upgradeMode("string")
.userData("string")
.vtpmEnabled(false)
.winrmListeners(WindowsVirtualMachineScaleSetWinrmListenerArgs.builder()
.protocol("string")
.certificateUrl("string")
.build())
.zoneBalance(false)
.zones("string")
.build());
windows_virtual_machine_scale_set_resource = azure.compute.WindowsVirtualMachineScaleSet("windowsVirtualMachineScaleSetResource",
instances=0,
sku="string",
admin_password="string",
admin_username="string",
resource_group_name="string",
os_disk={
"caching": "string",
"storage_account_type": "string",
"diff_disk_settings": {
"option": "string",
},
"disk_encryption_set_id": "string",
"disk_size_gb": 0,
"write_accelerator_enabled": False,
},
network_interfaces=[{
"ip_configurations": [{
"name": "string",
"application_gateway_backend_address_pool_ids": ["string"],
"application_security_group_ids": ["string"],
"load_balancer_backend_address_pool_ids": ["string"],
"load_balancer_inbound_nat_rules_ids": ["string"],
"primary": False,
"public_ip_addresses": [{
"name": "string",
"domain_name_label": "string",
"idle_timeout_in_minutes": 0,
"ip_tags": [{
"tag": "string",
"type": "string",
}],
"public_ip_prefix_id": "string",
}],
"subnet_id": "string",
"version": "string",
}],
"name": "string",
"dns_servers": ["string"],
"enable_accelerated_networking": False,
"enable_ip_forwarding": False,
"network_security_group_id": "string",
"primary": False,
}],
encryption_at_host_enabled=False,
priority="string",
data_disks=[{
"caching": "string",
"disk_size_gb": 0,
"lun": 0,
"storage_account_type": "string",
"create_option": "string",
"disk_encryption_set_id": "string",
"ultra_ssd_disk_iops_read_write": 0,
"ultra_ssd_disk_mbps_read_write": 0,
"write_accelerator_enabled": False,
}],
do_not_run_extensions_on_overprovisioned_machines=False,
enable_automatic_updates=False,
additional_capabilities={
"ultra_ssd_enabled": False,
},
eviction_policy="string",
extensions=[{
"name": "string",
"publisher": "string",
"type": "string",
"type_handler_version": "string",
"auto_upgrade_minor_version": False,
"automatic_upgrade_enabled": False,
"force_update_tag": "string",
"protected_settings": "string",
"provision_after_extensions": ["string"],
"settings": "string",
}],
extensions_time_budget="string",
health_probe_id="string",
identity={
"type": "string",
"identity_ids": ["string"],
"principal_id": "string",
"tenant_id": "string",
},
computer_name_prefix="string",
license_type="string",
location="string",
max_bid_price=0,
name="string",
boot_diagnostics={
"storage_account_uri": "string",
},
automatic_os_upgrade_policy={
"disable_automatic_rollback": False,
"enable_automatic_os_upgrade": False,
},
overprovision=False,
plan={
"name": "string",
"product": "string",
"publisher": "string",
},
platform_fault_domain_count=0,
custom_data="string",
provision_vm_agent=False,
proximity_placement_group_id="string",
automatic_instance_repair={
"enabled": False,
"grace_period": "string",
},
rolling_upgrade_policy={
"max_batch_instance_percent": 0,
"max_unhealthy_instance_percent": 0,
"max_unhealthy_upgraded_instance_percent": 0,
"pause_time_between_batches": "string",
},
scale_in_policy="string",
secrets=[{
"certificates": [{
"store": "string",
"url": "string",
}],
"key_vault_id": "string",
}],
secure_boot_enabled=False,
single_placement_group=False,
additional_unattend_contents=[{
"content": "string",
"setting": "string",
}],
source_image_id="string",
source_image_reference={
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string",
},
tags={
"string": "string",
},
terminate_notification={
"enabled": False,
"timeout": "string",
},
timezone="string",
upgrade_mode="string",
user_data="string",
vtpm_enabled=False,
winrm_listeners=[{
"protocol": "string",
"certificate_url": "string",
}],
zone_balance=False,
zones=["string"])
const windowsVirtualMachineScaleSetResource = new azure.compute.WindowsVirtualMachineScaleSet("windowsVirtualMachineScaleSetResource", {
instances: 0,
sku: "string",
adminPassword: "string",
adminUsername: "string",
resourceGroupName: "string",
osDisk: {
caching: "string",
storageAccountType: "string",
diffDiskSettings: {
option: "string",
},
diskEncryptionSetId: "string",
diskSizeGb: 0,
writeAcceleratorEnabled: false,
},
networkInterfaces: [{
ipConfigurations: [{
name: "string",
applicationGatewayBackendAddressPoolIds: ["string"],
applicationSecurityGroupIds: ["string"],
loadBalancerBackendAddressPoolIds: ["string"],
loadBalancerInboundNatRulesIds: ["string"],
primary: false,
publicIpAddresses: [{
name: "string",
domainNameLabel: "string",
idleTimeoutInMinutes: 0,
ipTags: [{
tag: "string",
type: "string",
}],
publicIpPrefixId: "string",
}],
subnetId: "string",
version: "string",
}],
name: "string",
dnsServers: ["string"],
enableAcceleratedNetworking: false,
enableIpForwarding: false,
networkSecurityGroupId: "string",
primary: false,
}],
encryptionAtHostEnabled: false,
priority: "string",
dataDisks: [{
caching: "string",
diskSizeGb: 0,
lun: 0,
storageAccountType: "string",
createOption: "string",
diskEncryptionSetId: "string",
ultraSsdDiskIopsReadWrite: 0,
ultraSsdDiskMbpsReadWrite: 0,
writeAcceleratorEnabled: false,
}],
doNotRunExtensionsOnOverprovisionedMachines: false,
enableAutomaticUpdates: false,
additionalCapabilities: {
ultraSsdEnabled: false,
},
evictionPolicy: "string",
extensions: [{
name: "string",
publisher: "string",
type: "string",
typeHandlerVersion: "string",
autoUpgradeMinorVersion: false,
automaticUpgradeEnabled: false,
forceUpdateTag: "string",
protectedSettings: "string",
provisionAfterExtensions: ["string"],
settings: "string",
}],
extensionsTimeBudget: "string",
healthProbeId: "string",
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
computerNamePrefix: "string",
licenseType: "string",
location: "string",
maxBidPrice: 0,
name: "string",
bootDiagnostics: {
storageAccountUri: "string",
},
automaticOsUpgradePolicy: {
disableAutomaticRollback: false,
enableAutomaticOsUpgrade: false,
},
overprovision: false,
plan: {
name: "string",
product: "string",
publisher: "string",
},
platformFaultDomainCount: 0,
customData: "string",
provisionVmAgent: false,
proximityPlacementGroupId: "string",
automaticInstanceRepair: {
enabled: false,
gracePeriod: "string",
},
rollingUpgradePolicy: {
maxBatchInstancePercent: 0,
maxUnhealthyInstancePercent: 0,
maxUnhealthyUpgradedInstancePercent: 0,
pauseTimeBetweenBatches: "string",
},
scaleInPolicy: "string",
secrets: [{
certificates: [{
store: "string",
url: "string",
}],
keyVaultId: "string",
}],
secureBootEnabled: false,
singlePlacementGroup: false,
additionalUnattendContents: [{
content: "string",
setting: "string",
}],
sourceImageId: "string",
sourceImageReference: {
offer: "string",
publisher: "string",
sku: "string",
version: "string",
},
tags: {
string: "string",
},
terminateNotification: {
enabled: false,
timeout: "string",
},
timezone: "string",
upgradeMode: "string",
userData: "string",
vtpmEnabled: false,
winrmListeners: [{
protocol: "string",
certificateUrl: "string",
}],
zoneBalance: false,
zones: ["string"],
});
type: azure:compute:WindowsVirtualMachineScaleSet
properties:
additionalCapabilities:
ultraSsdEnabled: false
additionalUnattendContents:
- content: string
setting: string
adminPassword: string
adminUsername: string
automaticInstanceRepair:
enabled: false
gracePeriod: string
automaticOsUpgradePolicy:
disableAutomaticRollback: false
enableAutomaticOsUpgrade: false
bootDiagnostics:
storageAccountUri: string
computerNamePrefix: string
customData: string
dataDisks:
- caching: string
createOption: string
diskEncryptionSetId: string
diskSizeGb: 0
lun: 0
storageAccountType: string
ultraSsdDiskIopsReadWrite: 0
ultraSsdDiskMbpsReadWrite: 0
writeAcceleratorEnabled: false
doNotRunExtensionsOnOverprovisionedMachines: false
enableAutomaticUpdates: false
encryptionAtHostEnabled: false
evictionPolicy: string
extensions:
- autoUpgradeMinorVersion: false
automaticUpgradeEnabled: false
forceUpdateTag: string
name: string
protectedSettings: string
provisionAfterExtensions:
- string
publisher: string
settings: string
type: string
typeHandlerVersion: string
extensionsTimeBudget: string
healthProbeId: string
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
instances: 0
licenseType: string
location: string
maxBidPrice: 0
name: string
networkInterfaces:
- dnsServers:
- string
enableAcceleratedNetworking: false
enableIpForwarding: false
ipConfigurations:
- applicationGatewayBackendAddressPoolIds:
- string
applicationSecurityGroupIds:
- string
loadBalancerBackendAddressPoolIds:
- string
loadBalancerInboundNatRulesIds:
- string
name: string
primary: false
publicIpAddresses:
- domainNameLabel: string
idleTimeoutInMinutes: 0
ipTags:
- tag: string
type: string
name: string
publicIpPrefixId: string
subnetId: string
version: string
name: string
networkSecurityGroupId: string
primary: false
osDisk:
caching: string
diffDiskSettings:
option: string
diskEncryptionSetId: string
diskSizeGb: 0
storageAccountType: string
writeAcceleratorEnabled: false
overprovision: false
plan:
name: string
product: string
publisher: string
platformFaultDomainCount: 0
priority: string
provisionVmAgent: false
proximityPlacementGroupId: string
resourceGroupName: string
rollingUpgradePolicy:
maxBatchInstancePercent: 0
maxUnhealthyInstancePercent: 0
maxUnhealthyUpgradedInstancePercent: 0
pauseTimeBetweenBatches: string
scaleInPolicy: string
secrets:
- certificates:
- store: string
url: string
keyVaultId: string
secureBootEnabled: false
singlePlacementGroup: false
sku: string
sourceImageId: string
sourceImageReference:
offer: string
publisher: string
sku: string
version: string
tags:
string: string
terminateNotification:
enabled: false
timeout: string
timezone: string
upgradeMode: string
userData: string
vtpmEnabled: false
winrmListeners:
- certificateUrl: string
protocol: string
zoneBalance: false
zones:
- string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WindowsVirtualMachineScaleSet resource accepts the following input properties:
- Admin
Password string - 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 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.
- Network
Interfaces List<WindowsVirtual Machine Scale Set Network Interface> - One or more
network_interfaceblocks as defined below. - Os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - Resource
Group stringName - 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. - Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - Additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content> - One or more
additional_unattend_contentblocks as defined below. - Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - Computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - Custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- Data
Disks List<WindowsVirtual Machine Scale Set Data Disk> - One or more
data_diskblocks as defined below. - Do
Not boolRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - Encryption
At boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- Extensions
List<Windows
Virtual Machine Scale Set Extension> - One or more
extensionblocks as defined below - Extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - Health
Probe stringId - 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_modeis set toAutomaticorRolling. - Identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - License
Type 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_ClientandWindows_Server. - Location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - Platform
Fault intDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - Provision
Vm boolAgent - 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 stringGroup Id - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - Scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - Secrets
List<Windows
Virtual Machine Scale Set Secret> - One or more
secretblocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Single
Placement boolGroup - 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 stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - User
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Vtpm
Enabled bool - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners List<WindowsVirtual Machine Scale Set Winrm Listener> - One or more
winrm_listenerblocks as defined below. - 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 List<string>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- Admin
Password string - 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 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.
- Network
Interfaces []WindowsVirtual Machine Scale Set Network Interface Args - One or more
network_interfaceblocks as defined below. - Os
Disk WindowsVirtual Machine Scale Set Os Disk Args - An
os_diskblock as defined below. - Resource
Group stringName - 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. - Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args - A
additional_capabilitiesblock as defined below. - Additional
Unattend []WindowsContents Virtual Machine Scale Set Additional Unattend Content Args - One or more
additional_unattend_contentblocks as defined below. - Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnosticsblock as defined below. - Computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - Custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- Data
Disks []WindowsVirtual Machine Scale Set Data Disk Args - One or more
data_diskblocks as defined below. - Do
Not boolRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - Encryption
At boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- Extensions
[]Windows
Virtual Machine Scale Set Extension Args - One or more
extensionblocks as defined below - Extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - Health
Probe stringId - 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_modeis set toAutomaticorRolling. - Identity
Windows
Virtual Machine Scale Set Identity Args - An
identityblock as defined below. - License
Type 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_ClientandWindows_Server. - Location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - 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
Windows
Virtual Machine Scale Set Plan Args - A
planblock as documented below. - Platform
Fault intDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - Provision
Vm boolAgent - 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 stringGroup Id - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy Args - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - Scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - Secrets
[]Windows
Virtual Machine Scale Set Secret Args - One or more
secretblocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Single
Placement boolGroup - 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 stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - map[string]string
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification Args - A
terminate_notificationblock as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - User
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Vtpm
Enabled bool - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners []WindowsVirtual Machine Scale Set Winrm Listener Args - One or more
winrm_listenerblocks as defined below. - 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 []string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- admin
Password String - 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 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.
- network
Interfaces List<WindowsVirtual Machine Scale Set Network Interface> - One or more
network_interfaceblocks as defined below. - os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - resource
Group StringName - 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. - additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content> - One or more
additional_unattend_contentblocks as defined below. - automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - computer
Name StringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data String - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks List<WindowsVirtual Machine Scale Set Data Disk> - One or more
data_diskblocks as defined below. - do
Not BooleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
List<Windows
Virtual Machine Scale Set Extension> - One or more
extensionblocks as defined below - extensions
Time StringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe StringId - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - license
Type 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_ClientandWindows_Server. - location String
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - 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 Boolean
- 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - platform
Fault IntegerDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm BooleanAgent - 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 StringGroup Id - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In StringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
List<Windows
Virtual Machine Scale Set Secret> - One or more
secretblocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement BooleanGroup - 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 StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade
Mode String - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data String - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled Boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<WindowsVirtual Machine Scale Set Winrm Listener> - One or more
winrm_listenerblocks as defined below. - zone
Balance 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>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- admin
Password string - 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 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.
- network
Interfaces WindowsVirtual Machine Scale Set Network Interface[] - One or more
network_interfaceblocks as defined below. - os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - resource
Group stringName - 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. - additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - additional
Unattend WindowsContents Virtual Machine Scale Set Additional Unattend Content[] - One or more
additional_unattend_contentblocks as defined below. - automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks WindowsVirtual Machine Scale Set Data Disk[] - One or more
data_diskblocks as defined below. - do
Not booleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic booleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At booleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
Windows
Virtual Machine Scale Set Extension[] - One or more
extensionblocks as defined below - extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe stringId - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - license
Type 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_ClientandWindows_Server. - location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - 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 boolean
- 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - platform
Fault numberDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm booleanAgent - 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 stringGroup Id - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
Windows
Virtual Machine Scale Set Secret[] - One or more
secretblocks as defined below. - secure
Boot booleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement booleanGroup - 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 stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners WindowsVirtual Machine Scale Set Winrm Listener[] - One or more
winrm_listenerblocks as defined below. - zone
Balance 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[]
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. 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.
- instances int
- The number of Virtual Machines in the Scale Set.
- network_
interfaces Sequence[WindowsVirtual Machine Scale Set Network Interface Args] - One or more
network_interfaceblocks as defined below. - os_
disk WindowsVirtual Machine Scale Set Os Disk Args - An
os_diskblock as defined below. - resource_
group_ strname - 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 WindowsVirtual Machine Scale Set Additional Capabilities Args - A
additional_capabilitiesblock as defined below. - additional_
unattend_ Sequence[Windowscontents Virtual Machine Scale Set Additional Unattend Content Args] - One or more
additional_unattend_contentblocks as defined below. - automatic_
instance_ Windowsrepair Virtual Machine Scale Set Automatic Instance Repair Args - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic_
os_ Windowsupgrade_ policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot_
diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnosticsblock as defined below. - computer_
name_ strprefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom_
data str - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data_
disks Sequence[WindowsVirtual Machine Scale Set Data Disk Args] - One or more
data_diskblocks as defined below. - do_
not_ boolrun_ extensions_ on_ overprovisioned_ machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable_
automatic_ boolupdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption_
at_ boolhost_ enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
Sequence[Windows
Virtual Machine Scale Set Extension Args] - One or more
extensionblocks as defined below - extensions_
time_ strbudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health_
probe_ strid - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity Args - An
identityblock as defined below. - license_
type str - 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_ClientandWindows_Server. - 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_ floatprice - 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 str
- 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
Windows
Virtual Machine Scale Set Plan Args - A
planblock as documented below. - platform_
fault_ intdomain_ count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision_
vm_ boolagent - 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_ strgroup_ id - 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_ Windowspolicy Virtual Machine Scale Set Rolling Upgrade Policy Args - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale_
in_ strpolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
Sequence[Windows
Virtual Machine Scale Set Secret Args] - One or more
secretblocks as defined below. - secure_
boot_ boolenabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single_
placement_ boolgroup - 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_ strid - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source_
image_ Windowsreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate_
notification WindowsVirtual Machine Scale Set Terminate Notification Args - A
terminate_notificationblock as defined below. - timezone str
- Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade_
mode str - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - 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 Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Scale Set Winrm Listener Args] - One or more
winrm_listenerblocks as defined below. - 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]
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- admin
Password String - 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 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.
- network
Interfaces List<Property Map> - One or more
network_interfaceblocks as defined below. - os
Disk Property Map - An
os_diskblock as defined below. - resource
Group StringName - 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. - additional
Capabilities Property Map - A
additional_capabilitiesblock as defined below. - additional
Unattend List<Property Map>Contents - One or more
additional_unattend_contentblocks as defined below. - automatic
Instance Property MapRepair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os Property MapUpgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics Property Map - A
boot_diagnosticsblock as defined below. - computer
Name StringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data String - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks List<Property Map> - One or more
data_diskblocks as defined below. - do
Not BooleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions List<Property Map>
- One or more
extensionblocks as defined below - extensions
Time StringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe StringId - 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_modeis set toAutomaticorRolling. - identity Property Map
- An
identityblock as defined below. - license
Type 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_ClientandWindows_Server. - location String
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - 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 Boolean
- 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 Property Map
- A
planblock as documented below. - platform
Fault NumberDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm BooleanAgent - 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 StringGroup Id - 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 Property MapPolicy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In StringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets List<Property Map>
- One or more
secretblocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement BooleanGroup - 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 StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image Property MapReference - A
source_image_referenceblock as defined below. - Map<String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification Property Map - A
terminate_notificationblock as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade
Mode String - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data String - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled Boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<Property Map> - One or more
winrm_listenerblocks as defined below. - zone
Balance 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>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the WindowsVirtualMachineScaleSet resource produces the following output properties:
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,
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,
enable_automatic_updates: Optional[bool] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
health_probe_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_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,
tags: Optional[Mapping[str, str]] = None,
terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = 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) -> WindowsVirtualMachineScaleSetfunc 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)resources: _: type: azure:compute:WindowsVirtualMachineScaleSet get: id: ${id}- 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.
- Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - Additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content> - One or more
additional_unattend_contentblocks as defined below. - Admin
Password string - 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 string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - Computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - Custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- Data
Disks List<WindowsVirtual Machine Scale Set Data Disk> - One or more
data_diskblocks as defined below. - Do
Not boolRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - Encryption
At boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- Extensions
List<Windows
Virtual Machine Scale Set Extension> - One or more
extensionblocks as defined below - Extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - Health
Probe stringId - 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_modeis set toAutomaticorRolling. - Identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - Instances int
- The number of Virtual Machines in the Scale Set.
- License
Type 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_ClientandWindows_Server. - Location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice - 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.
- Network
Interfaces List<WindowsVirtual Machine Scale Set Network Interface> - One or more
network_interfaceblocks as defined below. - Os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - Platform
Fault intDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - Provision
Vm boolAgent - 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 stringGroup Id - 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 stringName - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - Scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - Secrets
List<Windows
Virtual Machine Scale Set Secret> - One or more
secretblocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Single
Placement boolGroup - 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. - Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Unique
Id string - The Unique ID for this Windows Virtual Machine Scale Set.
- Upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - User
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Vtpm
Enabled bool - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners List<WindowsVirtual Machine Scale Set Winrm Listener> - One or more
winrm_listenerblocks as defined below. - 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 List<string>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args - A
additional_capabilitiesblock as defined below. - Additional
Unattend []WindowsContents Virtual Machine Scale Set Additional Unattend Content Args - One or more
additional_unattend_contentblocks as defined below. - Admin
Password string - 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 string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnosticsblock as defined below. - Computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - Custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- Data
Disks []WindowsVirtual Machine Scale Set Data Disk Args - One or more
data_diskblocks as defined below. - Do
Not boolRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - Enable
Automatic boolUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - Encryption
At boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- Extensions
[]Windows
Virtual Machine Scale Set Extension Args - One or more
extensionblocks as defined below - Extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - Health
Probe stringId - 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_modeis set toAutomaticorRolling. - Identity
Windows
Virtual Machine Scale Set Identity Args - An
identityblock as defined below. - Instances int
- The number of Virtual Machines in the Scale Set.
- License
Type 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_ClientandWindows_Server. - Location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price - 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.
- Network
Interfaces []WindowsVirtual Machine Scale Set Network Interface Args - One or more
network_interfaceblocks as defined below. - Os
Disk WindowsVirtual Machine Scale Set Os Disk Args - An
os_diskblock as defined below. - 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
Windows
Virtual Machine Scale Set Plan Args - A
planblock as documented below. - Platform
Fault intDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - Provision
Vm boolAgent - 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 stringGroup Id - 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 stringName - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy Args - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - Scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - Secrets
[]Windows
Virtual Machine Scale Set Secret Args - One or more
secretblocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Single
Placement boolGroup - 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. - Source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - map[string]string
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- Terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification Args - A
terminate_notificationblock as defined below. - Timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- Unique
Id string - The Unique ID for this Windows Virtual Machine Scale Set.
- Upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - User
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- Vtpm
Enabled bool - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners []WindowsVirtual Machine Scale Set Winrm Listener Args - One or more
winrm_listenerblocks as defined below. - 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 []string
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content> - One or more
additional_unattend_contentblocks as defined below. - admin
Password String - 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 String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - computer
Name StringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data String - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks List<WindowsVirtual Machine Scale Set Data Disk> - One or more
data_diskblocks as defined below. - do
Not BooleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
List<Windows
Virtual Machine Scale Set Extension> - One or more
extensionblocks as defined below - extensions
Time StringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe StringId - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - instances Integer
- The number of Virtual Machines in the Scale Set.
- license
Type 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_ClientandWindows_Server. - location String
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice - 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.
- network
Interfaces List<WindowsVirtual Machine Scale Set Network Interface> - One or more
network_interfaceblocks as defined below. - os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - overprovision Boolean
- 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - platform
Fault IntegerDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm BooleanAgent - 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 StringGroup Id - 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 StringName - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In StringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
List<Windows
Virtual Machine Scale Set Secret> - One or more
secretblocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement BooleanGroup - 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. - source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- unique
Id String - The Unique ID for this Windows Virtual Machine Scale Set.
- upgrade
Mode String - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data String - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled Boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<WindowsVirtual Machine Scale Set Winrm Listener> - One or more
winrm_listenerblocks as defined below. - zone
Balance 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>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities - A
additional_capabilitiesblock as defined below. - additional
Unattend WindowsContents Virtual Machine Scale Set Additional Unattend Content[] - One or more
additional_unattend_contentblocks as defined below. - admin
Password string - 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 string - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics - A
boot_diagnosticsblock as defined below. - computer
Name stringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data string - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks WindowsVirtual Machine Scale Set Data Disk[] - One or more
data_diskblocks as defined below. - do
Not booleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic booleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At booleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
Windows
Virtual Machine Scale Set Extension[] - One or more
extensionblocks as defined below - extensions
Time stringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe stringId - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity - An
identityblock as defined below. - instances number
- The number of Virtual Machines in the Scale Set.
- license
Type 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_ClientandWindows_Server. - location string
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice - 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.
- network
Interfaces WindowsVirtual Machine Scale Set Network Interface[] - One or more
network_interfaceblocks as defined below. - os
Disk WindowsVirtual Machine Scale Set Os Disk - An
os_diskblock as defined below. - overprovision boolean
- 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
Windows
Virtual Machine Scale Set Plan - A
planblock as documented below. - platform
Fault numberDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm booleanAgent - 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 stringGroup Id - 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 stringName - 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 WindowsPolicy Virtual Machine Scale Set Rolling Upgrade Policy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In stringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
Windows
Virtual Machine Scale Set Secret[] - One or more
secretblocks as defined below. - secure
Boot booleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement booleanGroup - 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. - source
Image stringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference - A
source_image_referenceblock as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification WindowsVirtual Machine Scale Set Terminate Notification - A
terminate_notificationblock as defined below. - timezone string
- Specifies the time zone of the virtual machine, the possible values are defined here.
- unique
Id string - The Unique ID for this Windows Virtual Machine Scale Set.
- upgrade
Mode string - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data string - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners WindowsVirtual Machine Scale Set Winrm Listener[] - One or more
winrm_listenerblocks as defined below. - zone
Balance 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[]
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- additional_
capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args - A
additional_capabilitiesblock as defined below. - additional_
unattend_ Sequence[Windowscontents Virtual Machine Scale Set Additional Unattend Content Args] - One or more
additional_unattend_contentblocks as defined below. - 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_ Windowsrepair Virtual Machine Scale Set Automatic Instance Repair Args - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic_
os_ Windowsupgrade_ policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot_
diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args - A
boot_diagnosticsblock as defined below. - computer_
name_ strprefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom_
data str - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data_
disks Sequence[WindowsVirtual Machine Scale Set Data Disk Args] - One or more
data_diskblocks as defined below. - do_
not_ boolrun_ extensions_ on_ overprovisioned_ machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable_
automatic_ boolupdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption_
at_ boolhost_ enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions
Sequence[Windows
Virtual Machine Scale Set Extension Args] - One or more
extensionblocks as defined below - extensions_
time_ strbudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health_
probe_ strid - 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_modeis set toAutomaticorRolling. - identity
Windows
Virtual Machine Scale Set Identity Args - An
identityblock as defined below. - instances int
- The number of Virtual Machines in the Scale Set.
- license_
type str - 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_ClientandWindows_Server. - 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_ floatprice - 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 str
- The name of the Windows Virtual Machine Scale Set. Changing this forces a new resource to be created.
- network_
interfaces Sequence[WindowsVirtual Machine Scale Set Network Interface Args] - One or more
network_interfaceblocks as defined below. - os_
disk WindowsVirtual Machine Scale Set Os Disk Args - An
os_diskblock as defined below. - 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
Windows
Virtual Machine Scale Set Plan Args - A
planblock as documented below. - platform_
fault_ intdomain_ count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision_
vm_ boolagent - 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_ strgroup_ id - 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_ strname - 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_ Windowspolicy Virtual Machine Scale Set Rolling Upgrade Policy Args - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale_
in_ strpolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets
Sequence[Windows
Virtual Machine Scale Set Secret Args] - One or more
secretblocks as defined below. - secure_
boot_ boolenabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single_
placement_ boolgroup - 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_ strid - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source_
image_ Windowsreference Virtual Machine Scale Set Source Image Reference Args - A
source_image_referenceblock as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate_
notification WindowsVirtual Machine Scale Set Terminate Notification Args - A
terminate_notificationblock 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 - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - 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 Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Scale Set Winrm Listener Args] - One or more
winrm_listenerblocks as defined below. - 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]
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
- additional
Capabilities Property Map - A
additional_capabilitiesblock as defined below. - additional
Unattend List<Property Map>Contents - One or more
additional_unattend_contentblocks as defined below. - admin
Password String - 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 String - The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- automatic
Instance Property MapRepair - A
automatic_instance_repairblock as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_idor an Application Health Extension. - automatic
Os Property MapUpgrade Policy - A
automatic_os_upgrade_policyblock as defined below. This can only be specified whenupgrade_modeis set toAutomatic. - boot
Diagnostics Property Map - A
boot_diagnosticsblock as defined below. - computer
Name StringPrefix - 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
namefield. If the value of thenamefield is not a validcomputer_name_prefix, then you must specifycomputer_name_prefix. - custom
Data String - The Base64-Encoded Custom Data which should be used for this Virtual Machine Scale Set.
- data
Disks List<Property Map> - One or more
data_diskblocks as defined below. - do
Not BooleanRun Extensions On Overprovisioned Machines - Should Virtual Machine Extensions be run on Overprovisioned Virtual Machines in the Scale Set? Defaults to
false. - enable
Automatic BooleanUpdates - Are automatic updates enabled for this Virtual Machine? Defaults to
true. - encryption
At BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String - The Policy which should be used Virtual Machines are Evicted from the Scale Set. Changing this forces a new resource to be created.
- extensions List<Property Map>
- One or more
extensionblocks as defined below - extensions
Time StringBudget - Specifies the duration allocated for all extensions to start. The time duration should be between
15minutes and120minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90minutes (PT1H30M). - health
Probe StringId - 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_modeis set toAutomaticorRolling. - identity Property Map
- An
identityblock as defined below. - instances Number
- The number of Virtual Machines in the Scale Set.
- license
Type 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_ClientandWindows_Server. - location String
- The Azure location where the Windows Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice - 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.
- network
Interfaces List<Property Map> - One or more
network_interfaceblocks as defined below. - os
Disk Property Map - An
os_diskblock as defined below. - overprovision Boolean
- 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 Property Map
- A
planblock as documented below. - platform
Fault NumberDomain Count - 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
RegularandSpot. Defaults toRegular. Changing this value forces a new resource. - provision
Vm BooleanAgent - 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 StringGroup Id - 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 StringName - 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 Property MapPolicy - A
rolling_upgrade_policyblock as defined below. This is Required and can only be specified whenupgrade_modeis set toAutomaticorRolling. - scale
In StringPolicy - 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,NewestVMandOldestVM, defaults toDefault. For more information about scale in policy, please refer to this doc. - secrets List<Property Map>
- One or more
secretblocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- single
Placement BooleanGroup - 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. - source
Image StringId - The ID of an Image which each Virtual Machine in this Scale Set should be based on.
- source
Image Property MapReference - A
source_image_referenceblock as defined below. - Map<String>
- A mapping of tags which should be assigned to this Virtual Machine Scale Set.
- terminate
Notification Property Map - A
terminate_notificationblock as defined below. - timezone String
- Specifies the time zone of the virtual machine, the possible values are defined here.
- unique
Id String - The Unique ID for this Windows Virtual Machine Scale Set.
- upgrade
Mode String - Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic,ManualandRolling. Defaults toManual. - user
Data String - The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm
Enabled Boolean - Specifies if vTPM (Virtual Trusted Plaform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<Property Map> - One or more
winrm_listenerblocks as defined below. - zone
Balance 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>
- A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.
Supporting Types
WindowsVirtualMachineScaleSetAdditionalCapabilities, WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
- ultra
Ssd booleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
- ultra_
ssd_ boolenabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRSstorage account type be supported on this Virtual Machine Scale Set? Defaults tofalse. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetAdditionalUnattendContent, WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs
- 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
AutoLogonandFirstLogonCommands. 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
AutoLogonandFirstLogonCommands. 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
AutoLogonandFirstLogonCommands. 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
AutoLogonandFirstLogonCommands. 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
AutoLogonandFirstLogonCommands. 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
AutoLogonandFirstLogonCommands. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetAutomaticInstanceRepair, WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs
- Enabled bool
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- Grace
Period 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.
- Enabled bool
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- Grace
Period 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.
- enabled Boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- grace
Period 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.
- enabled boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- grace
Period 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.
- 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.
- enabled Boolean
- Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- grace
Period 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.
WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy, WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs
- Disable
Automatic boolRollback - Should automatic rollbacks be disabled?
- Enable
Automatic boolOs Upgrade - 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 boolRollback - Should automatic rollbacks be disabled?
- Enable
Automatic boolOs Upgrade - 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 BooleanRollback - Should automatic rollbacks be disabled?
- enable
Automatic BooleanOs Upgrade - 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 booleanRollback - Should automatic rollbacks be disabled?
- enable
Automatic booleanOs Upgrade - 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_ boolrollback - Should automatic rollbacks be disabled?
- enable_
automatic_ boolos_ upgrade - 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 BooleanRollback - Should automatic rollbacks be disabled?
- enable
Automatic BooleanOs Upgrade - 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, WindowsVirtualMachineScaleSetBootDiagnosticsArgs
- Storage
Account stringUri - 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 stringUri - 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 StringUri - 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 stringUri - 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_ struri - 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 StringUri - 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, WindowsVirtualMachineScaleSetDataDiskArgs
- Caching string
- The type of Caching which should be used for this Data Disk. Possible values are
None,ReadOnlyandReadWrite. - Disk
Size intGb - 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 stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - Create
Option string - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- Disk
Iops intRead Write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- Disk
Mbps intRead Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- Ultra
Ssd intDisk Iops Read Write - Ultra
Ssd intDisk Mbps Read Write - Write
Accelerator boolEnabled - 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,ReadOnlyandReadWrite. - Disk
Size intGb - 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 stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - Create
Option string - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- Disk
Iops intRead Write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- Disk
Mbps intRead Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- Ultra
Ssd intDisk Iops Read Write - Ultra
Ssd intDisk Mbps Read Write - Write
Accelerator boolEnabled - 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,ReadOnlyandReadWrite. - disk
Size IntegerGb - 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.
- storage
Account StringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - create
Option String - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- disk
Iops IntegerRead Write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- disk
Mbps IntegerRead Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd IntegerDisk Iops Read Write - ultra
Ssd IntegerDisk Mbps Read Write - write
Accelerator BooleanEnabled - 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,ReadOnlyandReadWrite. - disk
Size numberGb - 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.
- storage
Account stringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - create
Option string - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- disk
Iops numberRead Write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- disk
Mbps numberRead Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd numberDisk Iops Read Write - ultra
Ssd numberDisk Mbps Read Write - write
Accelerator booleanEnabled - 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,ReadOnlyandReadWrite. - disk_
size_ intgb - 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_ strtype - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - create_
option str - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - disk_
encryption_ strset_ id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- disk_
iops_ intread_ write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- disk_
mbps_ intread_ write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- ultra_
ssd_ intdisk_ iops_ read_ write - ultra_
ssd_ intdisk_ mbps_ read_ write - write_
accelerator_ boolenabled - 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,ReadOnlyandReadWrite. - disk
Size NumberGb - 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.
- storage
Account StringType - The Type of Storage Account which should back this Data Disk. Possible values include
Standard_LRS,StandardSSD_LRS,Premium_LRSandUltraSSD_LRS. - create
Option String - The create option which should be used for this Data Disk. Possible values are
EmptyandFromImage. Defaults toEmpty. (FromImageshould only be used if the source image includes data disks). - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.
- disk
Iops NumberRead Write - Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- disk
Mbps NumberRead Write - Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd NumberDisk Iops Read Write - ultra
Ssd NumberDisk Mbps Read Write - write
Accelerator BooleanEnabled - Should Write Accelerator be enabled for this Data Disk? Defaults to
false.
WindowsVirtualMachineScaleSetExtension, WindowsVirtualMachineScaleSetExtensionArgs
- 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.
- Type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- Auto
Upgrade boolMinor Version - 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 boolEnabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - Force
Update stringTag - 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 string - A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
- Provision
After List<string>Extensions - 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.
- Type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- Auto
Upgrade boolMinor Version - 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 boolEnabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - Force
Update stringTag - 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 string - A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
- Provision
After []stringExtensions - 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.
- type
Handler StringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade BooleanMinor Version - 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 BooleanEnabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - force
Update StringTag - 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 String - A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
- provision
After List<String>Extensions - 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.
- type
Handler stringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade booleanMinor Version - 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 booleanEnabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - force
Update stringTag - 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 string - A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
- provision
After string[]Extensions - 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_ strversion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto_
upgrade_ boolminor_ version - 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_ boolenabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - force_
update_ strtag - 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.
- provision_
after_ Sequence[str]extensions - 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.
- type
Handler StringVersion - Specifies the version of the extension to use, available versions can be found using the Azure CLI.
- auto
Upgrade BooleanMinor Version - 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 BooleanEnabled - Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to
false. - force
Update StringTag - 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 String - A JSON String which specifies Sensitive Settings (such as Passwords) for the Extension.
- provision
After List<String>Extensions - An ordered list of Extension names which this should be provisioned after.
- settings String
- A JSON String which specifies Settings for the Extension.
WindowsVirtualMachineScaleSetIdentity, WindowsVirtualMachineScaleSetIdentityArgs
- Type string
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - Identity
Ids List<string> - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- Principal
Id string - The ID of the System Managed Service Principal.
- Tenant
Id string
- Type string
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - Identity
Ids []string - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- Principal
Id string - The ID of the System Managed Service Principal.
- Tenant
Id string
- type String
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids List<String> - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- principal
Id String - The ID of the System Managed Service Principal.
- tenant
Id String
- type string
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids string[] - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- principal
Id string - The ID of the System Managed Service Principal.
- tenant
Id string
- type str
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity_
ids Sequence[str] - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- principal_
id str - The ID of the System Managed Service Principal.
- tenant_
id str
- type String
- The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are
SystemAssigned,UserAssignedandSystemAssigned, UserAssigned. - identity
Ids List<String> - A list of User Managed Identity ID's which should be assigned to the Windows Virtual Machine Scale Set.
- principal
Id String - The ID of the System Managed Service Principal.
- tenant
Id String
WindowsVirtualMachineScaleSetNetworkInterface, WindowsVirtualMachineScaleSetNetworkInterfaceArgs
- Ip
Configurations List<WindowsVirtual Machine Scale Set Network Interface Ip Configuration> - One or more
ip_configurationblocks as defined above. - Name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- Dns
Servers List<string> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- Enable
Accelerated boolNetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - Enable
Ip boolForwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - Network
Security stringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- Primary bool
- Is this the Primary IP Configuration?
- Ip
Configurations []WindowsVirtual Machine Scale Set Network Interface Ip Configuration - One or more
ip_configurationblocks as defined above. - Name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- Dns
Servers []string - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- Enable
Accelerated boolNetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - Enable
Ip boolForwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - Network
Security stringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- Primary bool
- Is this the Primary IP Configuration?
- ip
Configurations List<WindowsVirtual Machine Scale Set Network Interface Ip Configuration> - One or more
ip_configurationblocks as defined above. - name String
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers List<String> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated BooleanNetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - enable
Ip BooleanForwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - network
Security StringGroup Id - 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 WindowsVirtual Machine Scale Set Network Interface Ip Configuration[] - One or more
ip_configurationblocks as defined above. - name string
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers string[] - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated booleanNetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - enable
Ip booleanForwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - network
Security stringGroup Id - 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[WindowsVirtual Machine Scale Set Network Interface Ip Configuration] - One or more
ip_configurationblocks 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_ boolnetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - enable_
ip_ boolforwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - network_
security_ strgroup_ id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary bool
- Is this the Primary IP Configuration?
- ip
Configurations List<Property Map> - One or more
ip_configurationblocks as defined above. - name String
- The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns
Servers List<String> - A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable
Accelerated BooleanNetworking - Does this Network Interface support Accelerated Networking? Defaults to
false. - enable
Ip BooleanForwarding - Does this Network Interface support IP Forwarding? Defaults to
false. - network
Security StringGroup Id - The ID of a Network Security Group which should be assigned to this Network Interface.
- primary Boolean
- Is this the Primary IP Configuration?
WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration, WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
- Name string
- The Name which should be used for this IP Configuration.
- Application
Gateway List<string>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- Application
Security List<string>Group Ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- Load
Balancer List<string>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- Load
Balancer List<string>Inbound Nat Rules Ids - 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 List<WindowsAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - A
public_ip_addressblock as defined below. - Subnet
Id 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
IPv4andIPv6. Defaults toIPv4.
- Name string
- The Name which should be used for this IP Configuration.
- Application
Gateway []stringBackend Address Pool Ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- Application
Security []stringGroup Ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- Load
Balancer []stringBackend Address Pool Ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- Load
Balancer []stringInbound Nat Rules Ids - 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 []WindowsAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address - A
public_ip_addressblock as defined below. - Subnet
Id 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
IPv4andIPv6. Defaults toIPv4.
- name String
- The Name which should be used for this IP Configuration.
- application
Gateway List<String>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security List<String>Group Ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Inbound Nat Rules Ids - 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. - public
Ip List<WindowsAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address> - A
public_ip_addressblock as defined below. - subnet
Id 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
IPv4andIPv6. Defaults toIPv4.
- name string
- The Name which should be used for this IP Configuration.
- application
Gateway string[]Backend Address Pool Ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security string[]Group Ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- load
Balancer string[]Backend Address Pool Ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- load
Balancer string[]Inbound Nat Rules Ids - 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. - public
Ip WindowsAddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address[] - A
public_ip_addressblock as defined below. - subnet
Id 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
IPv4andIPv6. Defaults toIPv4.
- name str
- The Name which should be used for this IP Configuration.
- application_
gateway_ Sequence[str]backend_ address_ pool_ ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application_
security_ Sequence[str]group_ ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- load_
balancer_ Sequence[str]backend_ address_ pool_ ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- load_
balancer_ Sequence[str]inbound_ nat_ rules_ ids - 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_ Sequence[Windowsaddresses Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address] - A
public_ip_addressblock 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
IPv4andIPv6. Defaults toIPv4.
- name String
- The Name which should be used for this IP Configuration.
- application
Gateway List<String>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Application Gateway which this Virtual Machine Scale Set should be connected to.
- application
Security List<String>Group Ids - A list of Application Security Group ID's which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Backend Address Pool Ids - A list of Backend Address Pools ID's from a Load Balancer which this Virtual Machine Scale Set should be connected to.
- load
Balancer List<String>Inbound Nat Rules Ids - 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. - public
Ip List<Property Map>Addresses - A
public_ip_addressblock as defined below. - subnet
Id 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
IPv4andIPv6. Defaults toIPv4.
WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress, WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressArgs
- Name string
- The Name of the Public IP Address Configuration.
- Domain
Name stringLabel - 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 intIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. -
List<Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - One or more
ip_tagblocks as defined above. - Public
Ip stringPrefix Id - 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.
- Name string
- The Name of the Public IP Address Configuration.
- Domain
Name stringLabel - 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 intIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. -
[]Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag - One or more
ip_tagblocks as defined above. - Public
Ip stringPrefix Id - 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.
- name String
- The Name of the Public IP Address Configuration.
- domain
Name StringLabel - 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 IntegerIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. -
List<Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> - One or more
ip_tagblocks as defined above. - public
Ip StringPrefix Id - 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.
- name string
- The Name of the Public IP Address Configuration.
- domain
Name stringLabel - 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 numberIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. -
Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag[] - One or more
ip_tagblocks as defined above. - public
Ip stringPrefix Id - 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.
- name str
- The Name of the Public IP Address Configuration.
- domain_
name_ strlabel - 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_ intin_ minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. -
Sequence[Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag] - One or more
ip_tagblocks as defined above. - public_
ip_ strprefix_ id - 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.
- name String
- The Name of the Public IP Address Configuration.
- domain
Name StringLabel - 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 NumberIn Minutes - The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range
4to32. - List<Property Map>
- One or more
ip_tagblocks as defined above. - public
Ip StringPrefix Id - 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.
WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag, WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTagArgs
WindowsVirtualMachineScaleSetOsDisk, WindowsVirtualMachineScaleSetOsDiskArgs
- Caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None,ReadOnlyandReadWrite. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - Diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- Disk
Size intGb - 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.
- Write
Accelerator boolEnabled - 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,ReadOnlyandReadWrite. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - Diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - Disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- Disk
Size intGb - 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.
- Write
Accelerator boolEnabled - 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,ReadOnlyandReadWrite. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- disk
Size IntegerGb - 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.
- write
Accelerator BooleanEnabled - 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,ReadOnlyandReadWrite. - storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - disk
Encryption stringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- disk
Size numberGb - 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.
- write
Accelerator booleanEnabled - 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,ReadOnlyandReadWrite. - storage_
account_ strtype - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - diff_
disk_ Windowssettings Virtual Machine Scale Set Os Disk Diff Disk Settings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - disk_
encryption_ strset_ id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- disk_
size_ intgb - 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.
- write_
accelerator_ boolenabled - 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,ReadOnlyandReadWrite. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS,StandardSSD_LRSandPremium_LRS. - diff
Disk Property MapSettings - A
diff_disk_settingsblock as defined above. Changing this forces a new resource to be created. - disk
Encryption StringSet Id - The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.
- disk
Size NumberGb - 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.
- write
Accelerator BooleanEnabled - Should Write Accelerator be Enabled for this OS Disk? Defaults to
false.
WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings, WindowsVirtualMachineScaleSetOsDiskDiffDiskSettingsArgs
- Option string
- Option string
- option String
- option string
- option str
- option String
WindowsVirtualMachineScaleSetPlan, WindowsVirtualMachineScaleSetPlanArgs
- 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, WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs
- Max
Batch intInstance Percent - 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 intInstance Percent - 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 intUpgraded Instance Percent - 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 stringBetween Batches - 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.
- Max
Batch intInstance Percent - 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 intInstance Percent - 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 intUpgraded Instance Percent - 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 stringBetween Batches - 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.
- max
Batch IntegerInstance Percent - 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 IntegerInstance Percent - 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 IntegerUpgraded Instance Percent - 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 StringBetween Batches - 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.
- max
Batch numberInstance Percent - 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 numberInstance Percent - 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 numberUpgraded Instance Percent - 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 stringBetween Batches - 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.
- max_
batch_ intinstance_ percent - 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_ intinstance_ percent - 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_ intupgraded_ instance_ percent - 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_ strbetween_ batches - 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.
- max
Batch NumberInstance Percent - 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 NumberInstance Percent - 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 NumberUpgraded Instance Percent - 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 StringBetween Batches - 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.
WindowsVirtualMachineScaleSetSecret, WindowsVirtualMachineScaleSetSecretArgs
- Certificates
List<Windows
Virtual Machine Scale Set Secret Certificate> - One or more
certificateblocks as defined above. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- Certificates
[]Windows
Virtual Machine Scale Set Secret Certificate - One or more
certificateblocks as defined above. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
List<Windows
Virtual Machine Scale Set Secret Certificate> - One or more
certificateblocks as defined above. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Windows
Virtual Machine Scale Set Secret Certificate[] - One or more
certificateblocks as defined above. - key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Sequence[Windows
Virtual Machine Scale Set Secret Certificate] - One or more
certificateblocks as defined above. - key_
vault_ strid - The ID of the Key Vault from which all Secrets should be sourced.
- certificates List<Property Map>
- One or more
certificateblocks as defined above. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
WindowsVirtualMachineScaleSetSecretCertificate, WindowsVirtualMachineScaleSetSecretCertificateArgs
WindowsVirtualMachineScaleSetSourceImageReference, WindowsVirtualMachineScaleSetSourceImageReferenceArgs
- Offer string
- Specifies the offer of the image used to create the virtual machines.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines.
- 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.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines.
- 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.
- publisher String
- Specifies the publisher of the image used to create the virtual machines.
- 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.
- publisher string
- Specifies the publisher of the image used to create the virtual machines.
- 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.
- publisher str
- Specifies the publisher of the image used to create the virtual machines.
- 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.
- publisher String
- Specifies the publisher of the image used to create the virtual machines.
- 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.
WindowsVirtualMachineScaleSetTerminateNotification, WindowsVirtualMachineScaleSetTerminateNotificationArgs
- Enabled bool
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
- Enabled bool
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
- enabled Boolean
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
- enabled boolean
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
- enabled bool
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
- enabled Boolean
- Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to
false. - 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.
WindowsVirtualMachineScaleSetWinrmListener, WindowsVirtualMachineScaleSetWinrmListenerArgs
- Protocol string
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - Certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
- Protocol string
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - Certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
- protocol String
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - certificate
Url String - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
- protocol string
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
- protocol str
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - certificate_
url str - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
- protocol String
- The Protocol of the WinRM Listener. Possible values are
HttpandHttps. - certificate
Url String - The Secret URL of a Key Vault Certificate, which must be specified when
protocolis set toHttps.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
