Azure Classic v5.43.0, May 6 23
Azure Classic v5.43.0, May 6 23
azure.compute.WindowsVirtualMachineScaleSet
Explore with Pulumi AI
Manages a Windows Virtual Machine Scale Set.
Disclaimers
NOTE:: All arguments including the administrator login and password will be stored in the raw state as plain-text.
NOTE: This provider will automatically update & reimage the nodes in the Scale Set (if Required) during an Update - this behaviour can be configured using the
features
setting within the Provider block.
NOTE: This resource does not support Unmanaged Disks. If you need to use Unmanaged Disks you can continue to use the
azure.compute.ScaleSet
resource instead
Example Usage
This example provisions a basic Windows Virtual Machine Scale Set on an internal network.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AddressSpaces = new[]
{
"10.0.0.0/16",
},
});
var @internal = new Azure.Network.Subnet("internal", new()
{
ResourceGroupName = exampleResourceGroup.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
});
var exampleWindowsVirtualMachineScaleSet = new Azure.Compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Sku = "Standard_F2",
Instances = 1,
AdminPassword = "P@55w0rd1234!",
AdminUsername = "adminuser",
SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetSourceImageReferenceArgs
{
Publisher = "MicrosoftWindowsServer",
Offer = "WindowsServer",
Sku = "2016-Datacenter-Server-Core",
Version = "latest",
},
OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetOsDiskArgs
{
StorageAccountType = "Standard_LRS",
Caching = "ReadWrite",
},
NetworkInterfaces = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs
{
Name = "example",
Primary = true,
IpConfigurations = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
{
Name = "internal",
Primary = true,
SubnetId = @internal.Id,
},
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
})
if err != nil {
return err
}
internal, err := network.NewSubnet(ctx, "internal", &network.SubnetArgs{
ResourceGroupName: exampleResourceGroup.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
})
if err != nil {
return err
}
_, err = compute.NewWindowsVirtualMachineScaleSet(ctx, "exampleWindowsVirtualMachineScaleSet", &compute.WindowsVirtualMachineScaleSetArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Sku: pulumi.String("Standard_F2"),
Instances: pulumi.Int(1),
AdminPassword: pulumi.String("P@55w0rd1234!"),
AdminUsername: pulumi.String("adminuser"),
SourceImageReference: &compute.WindowsVirtualMachineScaleSetSourceImageReferenceArgs{
Publisher: pulumi.String("MicrosoftWindowsServer"),
Offer: pulumi.String("WindowsServer"),
Sku: pulumi.String("2016-Datacenter-Server-Core"),
Version: pulumi.String("latest"),
},
OsDisk: &compute.WindowsVirtualMachineScaleSetOsDiskArgs{
StorageAccountType: pulumi.String("Standard_LRS"),
Caching: pulumi.String("ReadWrite"),
},
NetworkInterfaces: compute.WindowsVirtualMachineScaleSetNetworkInterfaceArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceArgs{
Name: pulumi.String("example"),
Primary: pulumi.Bool(true),
IpConfigurations: compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
&compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
Name: pulumi.String("internal"),
Primary: pulumi.Bool(true),
SubnetId: internal.ID(),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.compute.WindowsVirtualMachineScaleSet;
import com.pulumi.azure.compute.WindowsVirtualMachineScaleSetArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetSourceImageReferenceArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetOsDiskArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineScaleSetNetworkInterfaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.addressSpaces("10.0.0.0/16")
.build());
var internal = new Subnet("internal", SubnetArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.build());
var exampleWindowsVirtualMachineScaleSet = new WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", WindowsVirtualMachineScaleSetArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.sku("Standard_F2")
.instances(1)
.adminPassword("P@55w0rd1234!")
.adminUsername("adminuser")
.sourceImageReference(WindowsVirtualMachineScaleSetSourceImageReferenceArgs.builder()
.publisher("MicrosoftWindowsServer")
.offer("WindowsServer")
.sku("2016-Datacenter-Server-Core")
.version("latest")
.build())
.osDisk(WindowsVirtualMachineScaleSetOsDiskArgs.builder()
.storageAccountType("Standard_LRS")
.caching("ReadWrite")
.build())
.networkInterfaces(WindowsVirtualMachineScaleSetNetworkInterfaceArgs.builder()
.name("example")
.primary(true)
.ipConfigurations(WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
.name("internal")
.primary(true)
.subnetId(internal.id())
.build())
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
address_spaces=["10.0.0.0/16"])
internal = azure.network.Subnet("internal",
resource_group_name=example_resource_group.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"])
example_windows_virtual_machine_scale_set = azure.compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
sku="Standard_F2",
instances=1,
admin_password="P@55w0rd1234!",
admin_username="adminuser",
source_image_reference=azure.compute.WindowsVirtualMachineScaleSetSourceImageReferenceArgs(
publisher="MicrosoftWindowsServer",
offer="WindowsServer",
sku="2016-Datacenter-Server-Core",
version="latest",
),
os_disk=azure.compute.WindowsVirtualMachineScaleSetOsDiskArgs(
storage_account_type="Standard_LRS",
caching="ReadWrite",
),
network_interfaces=[azure.compute.WindowsVirtualMachineScaleSetNetworkInterfaceArgs(
name="example",
primary=True,
ip_configurations=[azure.compute.WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs(
name="internal",
primary=True,
subnet_id=internal.id,
)],
)])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
addressSpaces: ["10.0.0.0/16"],
});
const internal = new azure.network.Subnet("internal", {
resourceGroupName: exampleResourceGroup.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
});
const exampleWindowsVirtualMachineScaleSet = new azure.compute.WindowsVirtualMachineScaleSet("exampleWindowsVirtualMachineScaleSet", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
sku: "Standard_F2",
instances: 1,
adminPassword: "P@55w0rd1234!",
adminUsername: "adminuser",
sourceImageReference: {
publisher: "MicrosoftWindowsServer",
offer: "WindowsServer",
sku: "2016-Datacenter-Server-Core",
version: "latest",
},
osDisk: {
storageAccountType: "Standard_LRS",
caching: "ReadWrite",
},
networkInterfaces: [{
name: "example",
primary: true,
ipConfigurations: [{
name: "internal",
primary: true,
subnetId: internal.id,
}],
}],
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
addressSpaces:
- 10.0.0.0/16
internal:
type: azure:network:Subnet
properties:
resourceGroupName: ${exampleResourceGroup.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
exampleWindowsVirtualMachineScaleSet:
type: azure:compute:WindowsVirtualMachineScaleSet
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
sku: Standard_F2
instances: 1
adminPassword: P@55w0rd1234!
adminUsername: adminuser
sourceImageReference:
publisher: MicrosoftWindowsServer
offer: WindowsServer
sku: 2016-Datacenter-Server-Core
version: latest
osDisk:
storageAccountType: Standard_LRS
caching: ReadWrite
networkInterfaces:
- name: example
primary: true
ipConfigurations:
- name: internal
primary: true
subnetId: ${internal.id}
Create WindowsVirtualMachineScaleSet Resource
new WindowsVirtualMachineScaleSet(name: string, args: WindowsVirtualMachineScaleSetArgs, opts?: CustomResourceOptions);
@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
additional_capabilities: Optional[WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]] = None,
admin_password: Optional[str] = None,
admin_username: Optional[str] = None,
automatic_instance_repair: Optional[WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
automatic_os_upgrade_policy: Optional[WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs] = None,
boot_diagnostics: Optional[WindowsVirtualMachineScaleSetBootDiagnosticsArgs] = None,
capacity_reservation_group_id: Optional[str] = None,
computer_name_prefix: Optional[str] = None,
custom_data: Optional[str] = None,
data_disks: Optional[Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]] = None,
do_not_run_extensions_on_overprovisioned_machines: Optional[bool] = None,
edge_zone: Optional[str] = None,
enable_automatic_updates: Optional[bool] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extension_operations_enabled: Optional[bool] = None,
extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
gallery_application: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
gallery_applications: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
health_probe_id: Optional[str] = None,
host_group_id: Optional[str] = None,
identity: Optional[WindowsVirtualMachineScaleSetIdentityArgs] = None,
instances: Optional[int] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
network_interfaces: Optional[Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
os_disk: Optional[WindowsVirtualMachineScaleSetOsDiskArgs] = None,
overprovision: Optional[bool] = None,
plan: Optional[WindowsVirtualMachineScaleSetPlanArgs] = None,
platform_fault_domain_count: Optional[int] = None,
priority: Optional[str] = None,
provision_vm_agent: Optional[bool] = None,
proximity_placement_group_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
rolling_upgrade_policy: Optional[WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs] = None,
scale_in: Optional[WindowsVirtualMachineScaleSetScaleInArgs] = None,
scale_in_policy: Optional[str] = None,
secrets: Optional[Sequence[WindowsVirtualMachineScaleSetSecretArgs]] = None,
secure_boot_enabled: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
sku: Optional[str] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[WindowsVirtualMachineScaleSetSourceImageReferenceArgs] = None,
spot_restore: Optional[WindowsVirtualMachineScaleSetSpotRestoreArgs] = None,
tags: Optional[Mapping[str, str]] = None,
terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = None,
termination_notification: Optional[WindowsVirtualMachineScaleSetTerminationNotificationArgs] = None,
timezone: Optional[str] = None,
upgrade_mode: Optional[str] = None,
user_data: Optional[str] = None,
vtpm_enabled: Optional[bool] = None,
winrm_listeners: Optional[Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]] = None,
zone_balance: Optional[bool] = None,
zones: Optional[Sequence[str]] = None)
@overload
def WindowsVirtualMachineScaleSet(resource_name: str,
args: WindowsVirtualMachineScaleSetArgs,
opts: Optional[ResourceOptions] = None)
func NewWindowsVirtualMachineScaleSet(ctx *Context, name string, args WindowsVirtualMachineScaleSetArgs, opts ...ResourceOption) (*WindowsVirtualMachineScaleSet, error)
public WindowsVirtualMachineScaleSet(string name, WindowsVirtualMachineScaleSetArgs args, CustomResourceOptions? opts = null)
public WindowsVirtualMachineScaleSet(String name, WindowsVirtualMachineScaleSetArgs args)
public WindowsVirtualMachineScaleSet(String name, WindowsVirtualMachineScaleSetArgs args, CustomResourceOptions options)
type: azure:compute:WindowsVirtualMachineScaleSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WindowsVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WindowsVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WindowsVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WindowsVirtualMachineScaleSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WindowsVirtualMachineScaleSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
WindowsVirtualMachineScaleSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The WindowsVirtualMachineScaleSet resource accepts the following input properties:
- 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 Args> One or more
network_interface
blocks as defined below.- Os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 An
additional_capabilities
block as defined below.- Additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- Computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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 Args> One or more
data_disk
blocks 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
.- Edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- Extensions
List<Windows
Virtual Machine Scale Set Extension Args> One or more
extension
blocks as defined below- Extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- Gallery
Application List<WindowsVirtual Machine Scale Set Gallery Application Args> One or more
gallery_application
blocks as defined below.- Gallery
Applications List<WindowsVirtual Machine Scale Set Gallery Application Args> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- Host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- Identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args A
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- Scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- Scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- Secrets
List<Windows
Virtual Machine Scale Set Secret Args> One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- Spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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 Args A
terminate_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- Termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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 Args> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- Zones List<string>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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_interface
blocks as defined below.- Os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 An
additional_capabilities
block as defined below.- Additional
Unattend []WindowsContents Virtual Machine Scale Set Additional Unattend Content Args One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- Computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- Edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- Extensions
[]Windows
Virtual Machine Scale Set Extension Args One or more
extension
blocks as defined below- Extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- Gallery
Application []WindowsVirtual Machine Scale Set Gallery Application Args One or more
gallery_application
blocks as defined below.- Gallery
Applications []WindowsVirtual Machine Scale Set Gallery Application Args gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- Host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- Identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- Scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- Scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- Secrets
[]Windows
Virtual Machine Scale Set Secret Args One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- Spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- Termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- Zones []string
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- admin
Password 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 Args> One or more
network_interface
blocks as defined below.- os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 An
additional_capabilities
block as defined below.- additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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 Args> One or more
data_disk
blocks 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
.- edge
Zone String Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
List<Windows
Virtual Machine Scale Set Extension Args> One or more
extension
blocks as defined below- extensions
Time StringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application List<WindowsVirtual Machine Scale Set Gallery Application Args> One or more
gallery_application
blocks as defined below.- gallery
Applications List<WindowsVirtual Machine Scale Set Gallery Application Args> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group StringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args A
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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 Args A
rolling_upgrade_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale
In StringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
List<Windows
Virtual Machine Scale Set Secret Args> One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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 Args> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- 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>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- admin
Password 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 Args[] One or more
network_interface
blocks as defined below.- os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 An
additional_capabilities
block as defined below.- additional
Unattend WindowsContents Virtual Machine Scale Set Additional Unattend Content Args[] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations booleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
Windows
Virtual Machine Scale Set Extension Args[] One or more
extension
blocks as defined below- extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application WindowsVirtual Machine Scale Set Gallery Application Args[] One or more
gallery_application
blocks as defined below.- gallery
Applications WindowsVirtual Machine Scale Set Gallery Application Args[] gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args A
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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 Args A
rolling_upgrade_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
Windows
Virtual Machine Scale Set Secret Args[] One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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 Args A
terminate_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- 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[]
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- admin_
password str The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin_
username str The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- instances int
The number of Virtual Machines in the Scale Set.
- network_
interfaces Sequence[WindowsVirtual Machine Scale Set Network Interface Args] One or more
network_interface
blocks as defined below.- os_
disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 An
additional_capabilities
block as defined below.- additional_
unattend_ Sequence[Windowscontents Virtual Machine Scale Set Additional Unattend Content Args] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- automatic_
instance_ Windowsrepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic_
os_ Windowsupgrade_ policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot_
diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer_
name_ 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge_
zone str Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- enable_
automatic_ 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension_
operations_ boolenabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
Sequence[Windows
Virtual Machine Scale Set Extension Args] One or more
extension
blocks as defined below- extensions_
time_ strbudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery_
application Sequence[WindowsVirtual Machine Scale Set Gallery Application Args] One or more
gallery_application
blocks as defined below.- gallery_
applications Sequence[WindowsVirtual Machine Scale Set Gallery Application Args] gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host_
group_ strid Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale_
in WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale_
in_ strpolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
Sequence[Windows
Virtual Machine Scale Set Secret Args] One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source_
image_ Windowsreference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot_
restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination_
notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block as defined below.- timezone str
Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade_
mode str Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- user_
data str The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm_
enabled bool Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Scale Set Winrm Listener Args] One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- zone_
balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- zones Sequence[str]
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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_interface
blocks as defined below.- os
Disk Property Map An
os_disk
block 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 An
additional_capabilities
block as defined below.- additional
Unattend List<Property Map>Contents One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- automatic
Instance Property MapRepair An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os Property MapUpgrade Policy An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics Property Map A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge
Zone String Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions List<Property Map>
One or more
extension
blocks as defined below- extensions
Time StringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application List<Property Map> One or more
gallery_application
blocks as defined below.- gallery
Applications List<Property Map> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group StringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity Property Map
An
identity
block as defined below.- 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_Client
andWindows_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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In Property Map A
scale_in
block as defined below.- scale
In StringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets List<Property Map>
One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image Property MapReference A
source_image_reference
block as defined below.- spot
Restore Property Map A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification Property Map A
termination_notification
block as defined below.- timezone String
Specifies the time zone of the virtual machine, the possible values are defined here.
- upgrade
Mode String Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- 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>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the WindowsVirtualMachineScaleSet resource produces the following output properties:
Look up Existing WindowsVirtualMachineScaleSet Resource
Get an existing WindowsVirtualMachineScaleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: WindowsVirtualMachineScaleSetState, opts?: CustomResourceOptions): WindowsVirtualMachineScaleSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_capabilities: Optional[WindowsVirtualMachineScaleSetAdditionalCapabilitiesArgs] = None,
additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineScaleSetAdditionalUnattendContentArgs]] = None,
admin_password: Optional[str] = None,
admin_username: Optional[str] = None,
automatic_instance_repair: Optional[WindowsVirtualMachineScaleSetAutomaticInstanceRepairArgs] = None,
automatic_os_upgrade_policy: Optional[WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicyArgs] = None,
boot_diagnostics: Optional[WindowsVirtualMachineScaleSetBootDiagnosticsArgs] = None,
capacity_reservation_group_id: Optional[str] = None,
computer_name_prefix: Optional[str] = None,
custom_data: Optional[str] = None,
data_disks: Optional[Sequence[WindowsVirtualMachineScaleSetDataDiskArgs]] = None,
do_not_run_extensions_on_overprovisioned_machines: Optional[bool] = None,
edge_zone: Optional[str] = None,
enable_automatic_updates: Optional[bool] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extension_operations_enabled: Optional[bool] = None,
extensions: Optional[Sequence[WindowsVirtualMachineScaleSetExtensionArgs]] = None,
extensions_time_budget: Optional[str] = None,
gallery_application: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
gallery_applications: Optional[Sequence[WindowsVirtualMachineScaleSetGalleryApplicationArgs]] = None,
health_probe_id: Optional[str] = None,
host_group_id: Optional[str] = None,
identity: Optional[WindowsVirtualMachineScaleSetIdentityArgs] = None,
instances: Optional[int] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
network_interfaces: Optional[Sequence[WindowsVirtualMachineScaleSetNetworkInterfaceArgs]] = None,
os_disk: Optional[WindowsVirtualMachineScaleSetOsDiskArgs] = None,
overprovision: Optional[bool] = None,
plan: Optional[WindowsVirtualMachineScaleSetPlanArgs] = None,
platform_fault_domain_count: Optional[int] = None,
priority: Optional[str] = None,
provision_vm_agent: Optional[bool] = None,
proximity_placement_group_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
rolling_upgrade_policy: Optional[WindowsVirtualMachineScaleSetRollingUpgradePolicyArgs] = None,
scale_in: Optional[WindowsVirtualMachineScaleSetScaleInArgs] = None,
scale_in_policy: Optional[str] = None,
secrets: Optional[Sequence[WindowsVirtualMachineScaleSetSecretArgs]] = None,
secure_boot_enabled: Optional[bool] = None,
single_placement_group: Optional[bool] = None,
sku: Optional[str] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[WindowsVirtualMachineScaleSetSourceImageReferenceArgs] = None,
spot_restore: Optional[WindowsVirtualMachineScaleSetSpotRestoreArgs] = None,
tags: Optional[Mapping[str, str]] = None,
terminate_notification: Optional[WindowsVirtualMachineScaleSetTerminateNotificationArgs] = None,
termination_notification: Optional[WindowsVirtualMachineScaleSetTerminationNotificationArgs] = None,
timezone: Optional[str] = None,
unique_id: Optional[str] = None,
upgrade_mode: Optional[str] = None,
user_data: Optional[str] = None,
vtpm_enabled: Optional[bool] = None,
winrm_listeners: Optional[Sequence[WindowsVirtualMachineScaleSetWinrmListenerArgs]] = None,
zone_balance: Optional[bool] = None,
zones: Optional[Sequence[str]] = None) -> WindowsVirtualMachineScaleSet
func GetWindowsVirtualMachineScaleSet(ctx *Context, name string, id IDInput, state *WindowsVirtualMachineScaleSetState, opts ...ResourceOption) (*WindowsVirtualMachineScaleSet, error)
public static WindowsVirtualMachineScaleSet Get(string name, Input<string> id, WindowsVirtualMachineScaleSetState? state, CustomResourceOptions? opts = null)
public static WindowsVirtualMachineScaleSet get(String name, Output<String> id, WindowsVirtualMachineScaleSetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args An
additional_capabilities
block as defined below.- Additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. 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.
- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- Computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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 Args> One or more
data_disk
blocks 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
.- Edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- Extensions
List<Windows
Virtual Machine Scale Set Extension Args> One or more
extension
blocks as defined below- Extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- Gallery
Application List<WindowsVirtual Machine Scale Set Gallery Application Args> One or more
gallery_application
blocks as defined below.- Gallery
Applications List<WindowsVirtual Machine Scale Set Gallery Application Args> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- Host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- Identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args> One or more
network_interface
blocks as defined below.- Os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- Scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- Scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- Secrets
List<Windows
Virtual Machine Scale Set Secret Args> One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- Spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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 Args A
terminate_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- Termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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 Args> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- Zones List<string>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- Additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args An
additional_capabilities
block as defined below.- Additional
Unattend []WindowsContents Virtual Machine Scale Set Additional Unattend Content Args One or more
additional_unattend_content
blocks as defined below. 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.
- Automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- Automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- Boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- Computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- Edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extension
Operations boolEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- Extensions
[]Windows
Virtual Machine Scale Set Extension Args One or more
extension
blocks as defined below- Extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- Gallery
Application []WindowsVirtual Machine Scale Set Gallery Application Args One or more
gallery_application
blocks as defined below.- Gallery
Applications []WindowsVirtual Machine Scale Set Gallery Application Args gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- Host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- Identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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_interface
blocks as defined below.- Os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- Scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- Scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- Secrets
[]Windows
Virtual Machine Scale Set Secret Args One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- Spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- Termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- Zone
Balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- Zones []string
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args An
additional_capabilities
block as defined below.- additional
Unattend List<WindowsContents Virtual Machine Scale Set Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. 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.
- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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 Args> One or more
data_disk
blocks 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
.- edge
Zone String Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
List<Windows
Virtual Machine Scale Set Extension Args> One or more
extension
blocks as defined below- extensions
Time StringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application List<WindowsVirtual Machine Scale Set Gallery Application Args> One or more
gallery_application
blocks as defined below.- gallery
Applications List<WindowsVirtual Machine Scale Set Gallery Application Args> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group StringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args> One or more
network_interface
blocks as defined below.- os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 Args A
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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 Args A
rolling_upgrade_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale
In StringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
List<Windows
Virtual Machine Scale Set Secret Args> One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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 Args> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- 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>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- additional
Capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args An
additional_capabilities
block as defined below.- additional
Unattend WindowsContents Virtual Machine Scale Set Additional Unattend Content Args[] One or more
additional_unattend_content
blocks as defined below. 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.
- automatic
Instance WindowsRepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os WindowsUpgrade Policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge
Zone string Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations booleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
Windows
Virtual Machine Scale Set Extension Args[] One or more
extension
blocks as defined below- extensions
Time stringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application WindowsVirtual Machine Scale Set Gallery Application Args[] One or more
gallery_application
blocks as defined below.- gallery
Applications WindowsVirtual Machine Scale Set Gallery Application Args[] gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group stringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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 Args[] One or more
network_interface
blocks as defined below.- os
Disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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 Args A
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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 Args A
rolling_upgrade_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale
In stringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
Windows
Virtual Machine Scale Set Secret Args[] One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot
Restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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 Args A
terminate_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- 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[]
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- additional_
capabilities WindowsVirtual Machine Scale Set Additional Capabilities Args An
additional_capabilities
block as defined below.- additional_
unattend_ Sequence[Windowscontents Virtual Machine Scale Set Additional Unattend Content Args] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- admin_
password str The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin_
username str The username of the local administrator on each Virtual Machine Scale Set instance. Changing this forces a new resource to be created.
- automatic_
instance_ Windowsrepair Virtual Machine Scale Set Automatic Instance Repair Args An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic_
os_ Windowsupgrade_ policy Virtual Machine Scale Set Automatic Os Upgrade Policy Args An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot_
diagnostics WindowsVirtual Machine Scale Set Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer_
name_ 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge_
zone str Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- enable_
automatic_ 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension_
operations_ boolenabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions
Sequence[Windows
Virtual Machine Scale Set Extension Args] One or more
extension
blocks as defined below- extensions_
time_ strbudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery_
application Sequence[WindowsVirtual Machine Scale Set Gallery Application Args] One or more
gallery_application
blocks as defined below.- gallery_
applications Sequence[WindowsVirtual Machine Scale Set Gallery Application Args] gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host_
group_ strid Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity
Windows
Virtual Machine Scale Set Identity Args An
identity
block 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_Client
andWindows_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_interface
blocks as defined below.- os_
disk WindowsVirtual Machine Scale Set Os Disk Args An
os_disk
block 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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale_
in WindowsVirtual Machine Scale Set Scale In Args A
scale_in
block as defined below.- scale_
in_ strpolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets
Sequence[Windows
Virtual Machine Scale Set Secret Args] One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source_
image_ Windowsreference Virtual Machine Scale Set Source Image Reference Args A
source_image_reference
block as defined below.- spot_
restore WindowsVirtual Machine Scale Set Spot Restore Args A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination_
notification WindowsVirtual Machine Scale Set Termination Notification Args A
termination_notification
block as defined below.- timezone str
Specifies the time zone of the virtual machine, the possible values are defined here.
- unique_
id str The Unique ID for this Windows Virtual Machine Scale Set.
- upgrade_
mode str Specifies how Upgrades (e.g. changing the Image/SKU) should be performed to Virtual Machine Instances. Possible values are
Automatic
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- user_
data str The Base64-Encoded User Data which should be used for this Virtual Machine Scale Set.
- vtpm_
enabled bool Specifies if vTPM (Virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Scale Set Winrm Listener Args] One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- zone_
balance bool Should the Virtual Machines in this Scale Set be strictly evenly distributed across Availability Zones? Defaults to
false
. Changing this forces a new resource to be created.- zones Sequence[str]
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- additional
Capabilities Property Map An
additional_capabilities
block as defined below.- additional
Unattend List<Property Map>Contents One or more
additional_unattend_content
blocks as defined below. 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.
- automatic
Instance Property MapRepair An
automatic_instance_repair
block as defined below. To enable the automatic instance repair, this Virtual Machine Scale Set must have a validhealth_probe_id
or an Application Health Extension.- automatic
Os Property MapUpgrade Policy An
automatic_os_upgrade_policy
block as defined below. This can only be specified whenupgrade_mode
is set to eitherAutomatic
orRolling
.- boot
Diagnostics Property Map A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine Scale Set should be allocated to. Changing this forces a new resource to be created.
- computer
Name 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
name
field. If the value of thename
field is not a validcomputer_name_prefix
, then you must specifycomputer_name_prefix
. Changing this forces a new resource to be created.- 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_disk
blocks 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
.- edge
Zone String Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine Scale Set should exist. Changing this forces a new Windows Virtual Machine Scale Set to be created.
- 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 Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extension
Operations BooleanEnabled Should extension operations be allowed on the Virtual Machine Scale Set? Possible values are
true
orfalse
. Defaults totrue
. Changing this forces a new Windows Virtual Machine Scale Set to be created.- extensions List<Property Map>
One or more
extension
blocks as defined below- extensions
Time StringBudget Specifies the duration allocated for all extensions to start. The time duration should be between
15
minutes and120
minutes (inclusive) and should be specified in ISO 8601 format. Defaults to90
minutes (PT1H30M
).- gallery
Application List<Property Map> One or more
gallery_application
blocks as defined below.- gallery
Applications List<Property Map> gallery_applications
has been renamed togallery_application
and will be deprecated in 4.0- 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_mode
is set toAutomatic
orRolling
.- host
Group StringId Specifies the ID of the dedicated host group that the virtual machine scale set resides in. Changing this forces a new resource to be created.
- identity Property Map
An
identity
block as defined below.- instances Number
The number of Virtual Machines in the Scale Set.
- 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_Client
andWindows_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_interface
blocks as defined below.- os
Disk Property Map An
os_disk
block 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
plan
block as defined below. Changing this forces a new resource to be created.- 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
Regular
andSpot
. 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_policy
block as defined below. This is Required and can only be specified whenupgrade_mode
is set toAutomatic
orRolling
. Changing this forces a new resource to be created.- scale
In Property Map A
scale_in
block as defined below.- scale
In StringPolicy scale_in_policy
will be removed in favour of thescale_in
code block in version 4.0 of the AzureRM Provider.- secrets List<Property Map>
One or more
secret
blocks 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. Possible Image ID types include
Image ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image Property MapReference A
source_image_reference
block as defined below.- spot
Restore Property Map A
spot_restore
block 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_notification
block as defined below.terminate_notification
has been renamed totermination_notification
and will be removed in 4.0.- termination
Notification Property Map A
termination_notification
block as defined below.- timezone String
Specifies the time zone of the virtual machine, the possible values are defined here.
- 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
,Manual
andRolling
. Defaults toManual
. Changing this forces a new resource to be created.- 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 Platform 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_listener
blocks as defined below. Changing this forces a new resource to be created.- 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>
Specifies a list of Availability Zones in which this Windows Virtual Machine Scale Set should be located. Changing this forces a new Windows Virtual Machine Scale Set to be created.
Supporting Types
WindowsVirtualMachineScaleSetAdditionalCapabilities
- Ultra
Ssd boolEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
- Ultra
Ssd boolEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd booleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
- ultra_
ssd_ boolenabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
- ultra
Ssd BooleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine Scale Set? Possible values aretrue
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetAdditionalUnattendContent
- Content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- Content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content str
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting str
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetAutomaticInstanceRepair
- Enabled bool
Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- 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. Defaults to
PT30M
.
- 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. Defaults to
PT30M
.
- 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. Defaults to
PT30M
.
- 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. Defaults to
PT30M
.
- enabled bool
Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- grace_
period str Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to
PT30M
.
- enabled Boolean
Should the automatic instance repair be enabled on this Virtual Machine Scale Set?
- 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. Defaults to
PT30M
.
WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy
- 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
- 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
- Caching string
The type of Caching which should be used for this Data Disk. Possible values are
None
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- Create
Option string The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- Name string
The name of the Data Disk.
- Ultra
Ssd intDisk Iops Read Write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- Ultra
Ssd intDisk Mbps Read Write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- 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
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- Create
Option string The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- Name string
The name of the Data Disk.
- Ultra
Ssd intDisk Iops Read Write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- Ultra
Ssd intDisk Mbps Read Write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- 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
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- create
Option String The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- name String
The name of the Data Disk.
- ultra
Ssd IntegerDisk Iops Read Write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd IntegerDisk Mbps Read Write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- 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
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- create
Option string The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- name string
The name of the Data Disk.
- ultra
Ssd numberDisk Iops Read Write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd numberDisk Mbps Read Write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- 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
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- create_
option str The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- name str
The name of the Data Disk.
- ultra_
ssd_ intdisk_ iops_ read_ write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- ultra_
ssd_ intdisk_ mbps_ read_ write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- 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
,ReadOnly
andReadWrite
.- 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
,StandardSSD_ZRS
,Premium_LRS
,PremiumV2_LRS
,Premium_ZRS
andUltraSSD_LRS
.- create
Option String The create option which should be used for this Data Disk. Possible values are
Empty
andFromImage
. Defaults toEmpty
. (FromImage
should 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. Changing this forces a new resource to be created.
- name String
The name of the Data Disk.
- ultra
Ssd NumberDisk Iops Read Write Specifies the Read-Write IOPS for this Data Disk. Only settable for UltraSSD disks.
- ultra
Ssd NumberDisk Mbps Read Write Specifies the bandwidth in MB per second for this Data Disk. Only settable for UltraSSD disks.
- write
Accelerator BooleanEnabled Should Write Accelerator be enabled for this Data Disk? Defaults to
false
.
WindowsVirtualMachineScaleSetExtension
- Name string
The name for the Virtual Machine Scale Set Extension.
- Publisher string
Specifies the Publisher of the Extension.
- Type string
Specifies the Type of the Extension.
- 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?
- 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.
- Protected
Settings WindowsFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault - 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?
- 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.
- Protected
Settings WindowsFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault - 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?
- 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.
- protected
Settings WindowsFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault - 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?
- 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.
- protected
Settings WindowsFrom Key Vault Virtual Machine Scale Set Extension Protected Settings From Key Vault - 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?
- 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.
- protected_
settings_ Windowsfrom_ key_ vault Virtual Machine Scale Set Extension Protected Settings From Key Vault - 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?
- 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.
- protected
Settings Property MapFrom Key Vault - 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.
WindowsVirtualMachineScaleSetExtensionProtectedSettingsFromKeyVault
- Secret
Url string The URL to the Key Vault Secret which stores the protected settings.
- Source
Vault stringId The ID of the source Key Vault.
- Secret
Url string The URL to the Key Vault Secret which stores the protected settings.
- Source
Vault stringId The ID of the source Key Vault.
- secret
Url String The URL to the Key Vault Secret which stores the protected settings.
- source
Vault StringId The ID of the source Key Vault.
- secret
Url string The URL to the Key Vault Secret which stores the protected settings.
- source
Vault stringId The ID of the source Key Vault.
- secret_
url str The URL to the Key Vault Secret which stores the protected settings.
- source_
vault_ strid The ID of the source Key Vault.
- secret
Url String The URL to the Key Vault Secret which stores the protected settings.
- source
Vault StringId The ID of the source Key Vault.
WindowsVirtualMachineScaleSetGalleryApplication
- Package
Reference stringId package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- Configuration
Reference stringBlob Uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- Order int
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- Tag string
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
- Package
Reference stringId package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- Configuration
Reference stringBlob Uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- Order int
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- Tag string
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
- package
Reference StringId package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- configuration
Reference StringBlob Uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- order Integer
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- tag String
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
- package
Reference stringId package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- configuration
Reference stringBlob Uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- order number
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- tag string
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
- package_
reference_ strid package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- configuration_
reference_ strblob_ uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- order int
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- tag str
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
- package
Reference StringId package_reference_id
has been renamed toversion_id
and will be deprecated in 4.0- configuration
Reference StringBlob Uri configuration_reference_blob_uri
has been renamed toconfiguration_blob_uri
and will be deprecated in 4.0- order Number
Specifies the order in which the packages have to be installed. Possible values are between
0
and2,147,483,647
. Changing this forces a new resource to be created.- tag String
Specifies a passthrough value for more generic context. This field can be any valid
string
value. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetIdentity
- Type string
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids List<string> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- Type string
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids []string Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
- type string
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids string[] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type str
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity_
ids Sequence[str] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- principal_
id str The Principal ID associated with this Managed Service Identity.
- tenant_
id str The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine Scale Set. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine Scale Set.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
WindowsVirtualMachineScaleSetNetworkInterface
- Ip
Configurations List<WindowsVirtual Machine Scale Set Network Interface Ip Configuration> One or more
ip_configuration
blocks as defined above.- Name string
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- 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_configuration
blocks as defined above.- Name string
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- 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_configuration
blocks as defined above.- name String
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- 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_configuration
blocks as defined above.- name string
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- 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_configuration
blocks as defined above.- name str
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- dns_
servers Sequence[str] A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.
- enable_
accelerated_ 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_configuration
blocks as defined above.- name String
The Name which should be used for this Network Interface. Changing this forces a new resource to be created.
- 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
- 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_address
block 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
IPv4
andIPv6
. 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_address
block 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
IPv4
andIPv6
. 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_address
block 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
IPv4
andIPv6
. 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_address
block 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
IPv4
andIPv6
. 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_address
block as defined below.- subnet_
id str The ID of the Subnet which this IP Configuration should be connected to.
- version str
The Internet Protocol Version which should be used for this IP Configuration. Possible values are
IPv4
andIPv6
. 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_address
block 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
IPv4
andIPv6
. Defaults toIPv4
.
WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress
- 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
4
to32
.- List<Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- Version string
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. 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
4
to32
.- []Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- Version string
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. 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
4
to32
.- List<Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag> One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- version String
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. 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
4
to32
.- Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag[] One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- version string
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. 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
4
to32
.- Sequence[Windows
Virtual Machine Scale Set Network Interface Ip Configuration Public Ip Address Ip Tag] One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- version str
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. 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
4
to32
.- List<Property Map>
One or more
ip_tag
blocks as defined above. Changing this forces a new resource to be created.- 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.
- version String
The Internet Protocol Version which should be used for this public IP address. Possible values are
IPv4
andIPv6
. Defaults toIPv4
. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag
WindowsVirtualMachineScaleSetOsDisk
- Caching string
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- Storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- Diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- Secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- Security
Encryption stringType Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- 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
,ReadOnly
andReadWrite
.- Storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- Diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- Secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- Security
Encryption stringType Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- 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
,ReadOnly
andReadWrite
.- storage
Account StringType The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- secure
Vm StringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- security
Encryption StringType Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- 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
,ReadOnly
andReadWrite
.- storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk WindowsSettings Virtual Machine Scale Set Os Disk Diff Disk Settings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- security
Encryption stringType Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- 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
,ReadOnly
andReadWrite
.- storage_
account_ strtype The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff_
disk_ Windowssettings Virtual Machine Scale Set Os Disk Diff Disk Settings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- secure_
vm_ strdisk_ encryption_ set_ id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- security_
encryption_ strtype Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- 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
,ReadOnly
andReadWrite
.- storage
Account StringType The Type of Storage Account which should back this the Internal OS Disk. Possible values include
Standard_LRS
,StandardSSD_LRS
,StandardSSD_ZRS
,Premium_LRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk Property MapSettings A
diff_disk_settings
block 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. Conflicts with
secure_vm_disk_encryption_set_id
. Changing this forces a new resource to be created.- 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.
- secure
Vm StringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt the OS Disk when the Virtual Machine Scale Set is Confidential VMSS. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.- security
Encryption StringType Encryption Type when the Virtual Machine Scale Set is Confidential VMSS. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- write
Accelerator BooleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings
- Option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- Placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- Option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- Placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement String
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option str
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement str
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement String
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetPlan
- Name string
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- Product string
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- Publisher string
Specifies the publisher of the image. Changing this forces a new resource to be created.
- Name string
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- Product string
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- Publisher string
Specifies the publisher of the image. Changing this forces a new resource to be created.
- name String
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product String
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher String
Specifies the publisher of the image. Changing this forces a new resource to be created.
- name string
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product string
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher string
Specifies the publisher of the image. Changing this forces a new resource to be created.
- name str
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product str
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher str
Specifies the publisher of the image. Changing this forces a new resource to be created.
- name String
Specifies the name of the image from the marketplace. Changing this forces a new resource to be created.
- product String
Specifies the product of the image from the marketplace. Changing this forces a new resource to be created.
- publisher String
Specifies the publisher of the image. Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetRollingUpgradePolicy
- 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.
- Cross
Zone boolUpgrades Enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- Prioritize
Unhealthy boolInstances Enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
- 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.
- Cross
Zone boolUpgrades Enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- Prioritize
Unhealthy boolInstances Enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
- 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.
- cross
Zone BooleanUpgrades Enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- prioritize
Unhealthy BooleanInstances Enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
- 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.
- cross
Zone booleanUpgrades Enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- prioritize
Unhealthy booleanInstances Enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
- 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.
- cross_
zone_ boolupgrades_ enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- prioritize_
unhealthy_ boolinstances_ enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
- 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.
- cross
Zone BooleanUpgrades Enabled Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are
true
orfalse
.- prioritize
Unhealthy BooleanInstances Enabled Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are
true
orfalse
.
WindowsVirtualMachineScaleSetScaleIn
- Force
Deletion boolEnabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- Rule string
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
- Force
Deletion boolEnabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- Rule string
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
- force
Deletion BooleanEnabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- rule String
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
- force
Deletion booleanEnabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- rule string
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
- force_
deletion_ boolenabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- rule str
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
- force
Deletion BooleanEnabled Should the virtual machines chosen for removal be force deleted when the virtual machine scale set is being scaled-in? Possible values are
true
orfalse
. Defaults tofalse
.- rule String
The scale-in policy rule that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled in. Possible values for the scale-in policy rules are
Default
,NewestVM
andOldestVM
, defaults toDefault
. For more information about scale in policy, please refer to this doc.
WindowsVirtualMachineScaleSetSecret
- Certificates
List<Windows
Virtual Machine Scale Set Secret Certificate> One or more
certificate
blocks 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
certificate
blocks 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
certificate
blocks 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
certificate
blocks 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
certificate
blocks 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
certificate
blocks as defined above.- key
Vault StringId The ID of the Key Vault from which all Secrets should be sourced.
WindowsVirtualMachineScaleSetSecretCertificate
WindowsVirtualMachineScaleSetSourceImageReference
- Offer string
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Sku string
Specifies the SKU of the image used to create the virtual machines.
- Version string
Specifies the version of the image used to create the virtual machines.
- Offer string
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Sku string
Specifies the SKU of the image used to create the virtual machines.
- Version string
Specifies the version of the image used to create the virtual machines.
- offer String
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku String
Specifies the SKU of the image used to create the virtual machines.
- version String
Specifies the version of the image used to create the virtual machines.
- offer string
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher string
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku string
Specifies the SKU of the image used to create the virtual machines.
- version string
Specifies the version of the image used to create the virtual machines.
- offer str
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher str
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku str
Specifies the SKU of the image used to create the virtual machines.
- version str
Specifies the version of the image used to create the virtual machines.
- offer String
Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku String
Specifies the SKU of the image used to create the virtual machines.
- version String
Specifies the version of the image used to create the virtual machines.
WindowsVirtualMachineScaleSetSpotRestore
- Enabled bool
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- Timeout string
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
- Enabled bool
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- Timeout string
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
- enabled Boolean
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- timeout String
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
- enabled boolean
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- timeout string
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
- enabled bool
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- timeout str
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
- enabled Boolean
Should the Spot-Try-Restore feature be enabled? The Spot-Try-Restore feature will attempt to automatically restore the evicted Spot Virtual Machine Scale Set VM instances opportunistically based on capacity availability and pricing constraints. Possible values are
true
orfalse
. Defaults tofalse
. Changing this forces a new resource to be created.- timeout String
The length of time that the Virtual Machine Scale Set should attempt to restore the Spot VM instances which have been evicted. The time duration should be between
15
minutes and120
minutes (inclusive). The time duration should be specified in the ISO 8601 format. Defaults to90
minutes (e.g.PT1H30M
). Changing this forces a new resource to be created.
WindowsVirtualMachineScaleSetTerminateNotification
- Enabled bool
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- Timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- Enabled bool
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- Timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled Boolean
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- timeout String
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled boolean
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled bool
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- timeout str
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled Boolean
Should the terminate notification be enabled on this Virtual Machine Scale Set?
- timeout String
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
WindowsVirtualMachineScaleSetTerminationNotification
- Enabled bool
Should the termination notification be enabled on this Virtual Machine Scale Set?
- Timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- Enabled bool
Should the termination notification be enabled on this Virtual Machine Scale Set?
- Timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled Boolean
Should the termination notification be enabled on this Virtual Machine Scale Set?
- timeout String
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled boolean
Should the termination notification be enabled on this Virtual Machine Scale Set?
- timeout string
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled bool
Should the termination notification be enabled on this Virtual Machine Scale Set?
- timeout str
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
- enabled Boolean
Should the termination notification be enabled on this Virtual Machine Scale Set?
- timeout String
Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to
PT5M
.
WindowsVirtualMachineScaleSetWinrmListener
- Protocol string
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- Protocol string
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol string
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol str
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- certificate_
url str The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
The Protocol of the WinRM Listener. Possible values are
Http
andHttps
. Changing this forces a new resource to be created.- certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
Import
Windows Virtual Machine Scale Sets can be imported using the resource id
, e.g.
$ pulumi import azure:compute/windowsVirtualMachineScaleSet:WindowsVirtualMachineScaleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachineScaleSets/scaleset1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.