1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. WindowsVirtualMachine

We recommend using Azure Native.

Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi

azure.compute.WindowsVirtualMachine

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi

    Manages a Windows Virtual Machine.

    Disclaimers

    Note This provider will automatically remove the OS Disk by default - this behaviour can be configured using the features setting within the Provider block.

    Note All arguments including the administrator login and password will be stored in the raw state as plain-text.

    Note This resource does not support Unmanaged Disks. If you need to use Unmanaged Disks you can continue to use the azure.compute.VirtualMachine resource instead.

    Note This resource does not support attaching existing OS Disks. You can instead capture an image of the OS Disk or continue to use the azure.compute.VirtualMachine resource instead.

    In this release there’s a known issue where the public_ip_address and public_ip_addresses fields may not be fully populated for Dynamic Public IP’s.

    Example Usage

    This example provisions a basic Windows Virtual Machine on an internal network.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
        {
            Name = "example-network",
            AddressSpaces = new[]
            {
                "10.0.0.0/16",
            },
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleSubnet = new Azure.Network.Subnet("example", new()
        {
            Name = "internal",
            ResourceGroupName = example.Name,
            VirtualNetworkName = exampleVirtualNetwork.Name,
            AddressPrefixes = new[]
            {
                "10.0.2.0/24",
            },
        });
    
        var exampleNetworkInterface = new Azure.Network.NetworkInterface("example", new()
        {
            Name = "example-nic",
            Location = example.Location,
            ResourceGroupName = example.Name,
            IpConfigurations = new[]
            {
                new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
                {
                    Name = "internal",
                    SubnetId = exampleSubnet.Id,
                    PrivateIpAddressAllocation = "Dynamic",
                },
            },
        });
    
        var exampleWindowsVirtualMachine = new Azure.Compute.WindowsVirtualMachine("example", new()
        {
            Name = "example-machine",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Size = "Standard_F2",
            AdminUsername = "adminuser",
            AdminPassword = "P@$$w0rd1234!",
            NetworkInterfaceIds = new[]
            {
                exampleNetworkInterface.Id,
            },
            OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineOsDiskArgs
            {
                Caching = "ReadWrite",
                StorageAccountType = "Standard_LRS",
            },
            SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineSourceImageReferenceArgs
            {
                Publisher = "MicrosoftWindowsServer",
                Offer = "WindowsServer",
                Sku = "2016-Datacenter",
                Version = "latest",
            },
        });
    
    });
    
    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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
    			Name: pulumi.String("example-network"),
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.0.0.0/16"),
    			},
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
    			Name:               pulumi.String("internal"),
    			ResourceGroupName:  example.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.0.2.0/24"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleNetworkInterface, err := network.NewNetworkInterface(ctx, "example", &network.NetworkInterfaceArgs{
    			Name:              pulumi.String("example-nic"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
    				&network.NetworkInterfaceIpConfigurationArgs{
    					Name:                       pulumi.String("internal"),
    					SubnetId:                   exampleSubnet.ID(),
    					PrivateIpAddressAllocation: pulumi.String("Dynamic"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewWindowsVirtualMachine(ctx, "example", &compute.WindowsVirtualMachineArgs{
    			Name:              pulumi.String("example-machine"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Size:              pulumi.String("Standard_F2"),
    			AdminUsername:     pulumi.String("adminuser"),
    			AdminPassword:     pulumi.String("P@$$w0rd1234!"),
    			NetworkInterfaceIds: pulumi.StringArray{
    				exampleNetworkInterface.ID(),
    			},
    			OsDisk: &compute.WindowsVirtualMachineOsDiskArgs{
    				Caching:            pulumi.String("ReadWrite"),
    				StorageAccountType: pulumi.String("Standard_LRS"),
    			},
    			SourceImageReference: &compute.WindowsVirtualMachineSourceImageReferenceArgs{
    				Publisher: pulumi.String("MicrosoftWindowsServer"),
    				Offer:     pulumi.String("WindowsServer"),
    				Sku:       pulumi.String("2016-Datacenter"),
    				Version:   pulumi.String("latest"),
    			},
    		})
    		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.network.NetworkInterface;
    import com.pulumi.azure.network.NetworkInterfaceArgs;
    import com.pulumi.azure.network.inputs.NetworkInterfaceIpConfigurationArgs;
    import com.pulumi.azure.compute.WindowsVirtualMachine;
    import com.pulumi.azure.compute.WindowsVirtualMachineArgs;
    import com.pulumi.azure.compute.inputs.WindowsVirtualMachineOsDiskArgs;
    import com.pulumi.azure.compute.inputs.WindowsVirtualMachineSourceImageReferenceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
                .name("example-network")
                .addressSpaces("10.0.0.0/16")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()        
                .name("internal")
                .resourceGroupName(example.name())
                .virtualNetworkName(exampleVirtualNetwork.name())
                .addressPrefixes("10.0.2.0/24")
                .build());
    
            var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()        
                .name("example-nic")
                .location(example.location())
                .resourceGroupName(example.name())
                .ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
                    .name("internal")
                    .subnetId(exampleSubnet.id())
                    .privateIpAddressAllocation("Dynamic")
                    .build())
                .build());
    
            var exampleWindowsVirtualMachine = new WindowsVirtualMachine("exampleWindowsVirtualMachine", WindowsVirtualMachineArgs.builder()        
                .name("example-machine")
                .resourceGroupName(example.name())
                .location(example.location())
                .size("Standard_F2")
                .adminUsername("adminuser")
                .adminPassword("P@$$w0rd1234!")
                .networkInterfaceIds(exampleNetworkInterface.id())
                .osDisk(WindowsVirtualMachineOsDiskArgs.builder()
                    .caching("ReadWrite")
                    .storageAccountType("Standard_LRS")
                    .build())
                .sourceImageReference(WindowsVirtualMachineSourceImageReferenceArgs.builder()
                    .publisher("MicrosoftWindowsServer")
                    .offer("WindowsServer")
                    .sku("2016-Datacenter")
                    .version("latest")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_virtual_network = azure.network.VirtualNetwork("example",
        name="example-network",
        address_spaces=["10.0.0.0/16"],
        location=example.location,
        resource_group_name=example.name)
    example_subnet = azure.network.Subnet("example",
        name="internal",
        resource_group_name=example.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.0.2.0/24"])
    example_network_interface = azure.network.NetworkInterface("example",
        name="example-nic",
        location=example.location,
        resource_group_name=example.name,
        ip_configurations=[azure.network.NetworkInterfaceIpConfigurationArgs(
            name="internal",
            subnet_id=example_subnet.id,
            private_ip_address_allocation="Dynamic",
        )])
    example_windows_virtual_machine = azure.compute.WindowsVirtualMachine("example",
        name="example-machine",
        resource_group_name=example.name,
        location=example.location,
        size="Standard_F2",
        admin_username="adminuser",
        admin_password="P@$$w0rd1234!",
        network_interface_ids=[example_network_interface.id],
        os_disk=azure.compute.WindowsVirtualMachineOsDiskArgs(
            caching="ReadWrite",
            storage_account_type="Standard_LRS",
        ),
        source_image_reference=azure.compute.WindowsVirtualMachineSourceImageReferenceArgs(
            publisher="MicrosoftWindowsServer",
            offer="WindowsServer",
            sku="2016-Datacenter",
            version="latest",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
        name: "example-network",
        addressSpaces: ["10.0.0.0/16"],
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleSubnet = new azure.network.Subnet("example", {
        name: "internal",
        resourceGroupName: example.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.0.2.0/24"],
    });
    const exampleNetworkInterface = new azure.network.NetworkInterface("example", {
        name: "example-nic",
        location: example.location,
        resourceGroupName: example.name,
        ipConfigurations: [{
            name: "internal",
            subnetId: exampleSubnet.id,
            privateIpAddressAllocation: "Dynamic",
        }],
    });
    const exampleWindowsVirtualMachine = new azure.compute.WindowsVirtualMachine("example", {
        name: "example-machine",
        resourceGroupName: example.name,
        location: example.location,
        size: "Standard_F2",
        adminUsername: "adminuser",
        adminPassword: "P@$$w0rd1234!",
        networkInterfaceIds: [exampleNetworkInterface.id],
        osDisk: {
            caching: "ReadWrite",
            storageAccountType: "Standard_LRS",
        },
        sourceImageReference: {
            publisher: "MicrosoftWindowsServer",
            offer: "WindowsServer",
            sku: "2016-Datacenter",
            version: "latest",
        },
    });
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleVirtualNetwork:
        type: azure:network:VirtualNetwork
        name: example
        properties:
          name: example-network
          addressSpaces:
            - 10.0.0.0/16
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleSubnet:
        type: azure:network:Subnet
        name: example
        properties:
          name: internal
          resourceGroupName: ${example.name}
          virtualNetworkName: ${exampleVirtualNetwork.name}
          addressPrefixes:
            - 10.0.2.0/24
      exampleNetworkInterface:
        type: azure:network:NetworkInterface
        name: example
        properties:
          name: example-nic
          location: ${example.location}
          resourceGroupName: ${example.name}
          ipConfigurations:
            - name: internal
              subnetId: ${exampleSubnet.id}
              privateIpAddressAllocation: Dynamic
      exampleWindowsVirtualMachine:
        type: azure:compute:WindowsVirtualMachine
        name: example
        properties:
          name: example-machine
          resourceGroupName: ${example.name}
          location: ${example.location}
          size: Standard_F2
          adminUsername: adminuser
          adminPassword: P@$$w0rd1234!
          networkInterfaceIds:
            - ${exampleNetworkInterface.id}
          osDisk:
            caching: ReadWrite
            storageAccountType: Standard_LRS
          sourceImageReference:
            publisher: MicrosoftWindowsServer
            offer: WindowsServer
            sku: 2016-Datacenter
            version: latest
    

    Create WindowsVirtualMachine Resource

    new WindowsVirtualMachine(name: string, args: WindowsVirtualMachineArgs, opts?: CustomResourceOptions);
    @overload
    def WindowsVirtualMachine(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              additional_capabilities: Optional[WindowsVirtualMachineAdditionalCapabilitiesArgs] = None,
                              additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]] = None,
                              admin_password: Optional[str] = None,
                              admin_username: Optional[str] = None,
                              allow_extension_operations: Optional[bool] = None,
                              availability_set_id: Optional[str] = None,
                              boot_diagnostics: Optional[WindowsVirtualMachineBootDiagnosticsArgs] = None,
                              bypass_platform_safety_checks_on_user_schedule_enabled: Optional[bool] = None,
                              capacity_reservation_group_id: Optional[str] = None,
                              computer_name: Optional[str] = None,
                              custom_data: Optional[str] = None,
                              dedicated_host_group_id: Optional[str] = None,
                              dedicated_host_id: Optional[str] = None,
                              edge_zone: Optional[str] = None,
                              enable_automatic_updates: Optional[bool] = None,
                              encryption_at_host_enabled: Optional[bool] = None,
                              eviction_policy: Optional[str] = None,
                              extensions_time_budget: Optional[str] = None,
                              gallery_applications: Optional[Sequence[WindowsVirtualMachineGalleryApplicationArgs]] = None,
                              hotpatching_enabled: Optional[bool] = None,
                              identity: Optional[WindowsVirtualMachineIdentityArgs] = None,
                              license_type: Optional[str] = None,
                              location: Optional[str] = None,
                              max_bid_price: Optional[float] = None,
                              name: Optional[str] = None,
                              network_interface_ids: Optional[Sequence[str]] = None,
                              os_disk: Optional[WindowsVirtualMachineOsDiskArgs] = None,
                              patch_assessment_mode: Optional[str] = None,
                              patch_mode: Optional[str] = None,
                              plan: Optional[WindowsVirtualMachinePlanArgs] = None,
                              platform_fault_domain: Optional[int] = None,
                              priority: Optional[str] = None,
                              provision_vm_agent: Optional[bool] = None,
                              proximity_placement_group_id: Optional[str] = None,
                              reboot_setting: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              secrets: Optional[Sequence[WindowsVirtualMachineSecretArgs]] = None,
                              secure_boot_enabled: Optional[bool] = None,
                              size: Optional[str] = None,
                              source_image_id: Optional[str] = None,
                              source_image_reference: Optional[WindowsVirtualMachineSourceImageReferenceArgs] = None,
                              tags: Optional[Mapping[str, str]] = None,
                              termination_notification: Optional[WindowsVirtualMachineTerminationNotificationArgs] = None,
                              timezone: Optional[str] = None,
                              user_data: Optional[str] = None,
                              virtual_machine_scale_set_id: Optional[str] = None,
                              vtpm_enabled: Optional[bool] = None,
                              winrm_listeners: Optional[Sequence[WindowsVirtualMachineWinrmListenerArgs]] = None,
                              zone: Optional[str] = None)
    @overload
    def WindowsVirtualMachine(resource_name: str,
                              args: WindowsVirtualMachineArgs,
                              opts: Optional[ResourceOptions] = None)
    func NewWindowsVirtualMachine(ctx *Context, name string, args WindowsVirtualMachineArgs, opts ...ResourceOption) (*WindowsVirtualMachine, error)
    public WindowsVirtualMachine(string name, WindowsVirtualMachineArgs args, CustomResourceOptions? opts = null)
    public WindowsVirtualMachine(String name, WindowsVirtualMachineArgs args)
    public WindowsVirtualMachine(String name, WindowsVirtualMachineArgs args, CustomResourceOptions options)
    
    type: azure:compute:WindowsVirtualMachine
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WindowsVirtualMachineArgs
    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 WindowsVirtualMachineArgs
    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 WindowsVirtualMachineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WindowsVirtualMachineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WindowsVirtualMachineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WindowsVirtualMachine 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 WindowsVirtualMachine resource accepts the following input properties:

    AdminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    AdminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    NetworkInterfaceIds List<string>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    OsDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    ResourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    Size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    AdditionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    AdditionalUnattendContents List<WindowsVirtualMachineAdditionalUnattendContent>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    AllowExtensionOperations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    AvailabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    BootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    BypassPlatformSafetyChecksOnUserScheduleEnabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    CapacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    ComputerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    CustomData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    DedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    DedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    EnableAutomaticUpdates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    EncryptionAtHostEnabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    EvictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    ExtensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    GalleryApplications List<WindowsVirtualMachineGalleryApplication>
    One or more gallery_application blocks as defined below.
    HotpatchingEnabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    Identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    LicenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    Location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    MaxBidPrice double

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    Name string
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    PatchAssessmentMode string

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    PatchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    Plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    PlatformFaultDomain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    Priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    ProvisionVmAgent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    ProximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    RebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    Secrets List<WindowsVirtualMachineSecret>
    One or more secret blocks as defined below.
    SecureBootEnabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    SourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    SourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to this Virtual Machine.
    TerminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    Timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    UserData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    VirtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    VtpmEnabled bool
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    WinrmListeners List<WindowsVirtualMachineWinrmListener>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    Zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    AdminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    AdminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    NetworkInterfaceIds []string
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    OsDisk WindowsVirtualMachineOsDiskArgs
    A os_disk block as defined below.
    ResourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    Size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    AdditionalCapabilities WindowsVirtualMachineAdditionalCapabilitiesArgs
    A additional_capabilities block as defined below.
    AdditionalUnattendContents []WindowsVirtualMachineAdditionalUnattendContentArgs
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    AllowExtensionOperations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    AvailabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    BootDiagnostics WindowsVirtualMachineBootDiagnosticsArgs
    A boot_diagnostics block as defined below.
    BypassPlatformSafetyChecksOnUserScheduleEnabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    CapacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    ComputerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    CustomData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    DedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    DedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    EnableAutomaticUpdates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    EncryptionAtHostEnabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    EvictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    ExtensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    GalleryApplications []WindowsVirtualMachineGalleryApplicationArgs
    One or more gallery_application blocks as defined below.
    HotpatchingEnabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    Identity WindowsVirtualMachineIdentityArgs
    An identity block as defined below.
    LicenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    Location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    MaxBidPrice float64

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    Name string
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    PatchAssessmentMode string

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    PatchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    Plan WindowsVirtualMachinePlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    PlatformFaultDomain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    Priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    ProvisionVmAgent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    ProximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    RebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    Secrets []WindowsVirtualMachineSecretArgs
    One or more secret blocks as defined below.
    SecureBootEnabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    SourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    SourceImageReference WindowsVirtualMachineSourceImageReferenceArgs

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    Tags map[string]string
    A mapping of tags which should be assigned to this Virtual Machine.
    TerminationNotification WindowsVirtualMachineTerminationNotificationArgs
    A termination_notification block as defined below.
    Timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    UserData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    VirtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    VtpmEnabled bool
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    WinrmListeners []WindowsVirtualMachineWinrmListenerArgs
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    Zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    adminPassword String
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername String
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds List<String>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    resourceGroupName String
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    size String
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    additionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    additionalUnattendContents List<WindowsVirtualMachineAdditionalUnattendContent>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    allowExtensionOperations Boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId String
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled Boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId String

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName String
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData String
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId String
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId String
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates Boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled Boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy String

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget String
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications List<WindowsVirtualMachineGalleryApplication>
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled Boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    licenseType String
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location String
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice Double

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

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

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode String

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain Integer
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority String
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    provisionVmAgent Boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId String
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    rebootSetting String

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    secrets List<WindowsVirtualMachineSecret>
    One or more secret blocks as defined below.
    secureBootEnabled Boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    sourceImageId String

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Map<String,String>
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    timezone String
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData String
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineScaleSetId String

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled Boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners List<WindowsVirtualMachineWinrmListener>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone String
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    adminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds string[]
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    resourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    additionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    additionalUnattendContents WindowsVirtualMachineAdditionalUnattendContent[]
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    allowExtensionOperations boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications WindowsVirtualMachineGalleryApplication[]
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    licenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice number

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

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

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain number
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    provisionVmAgent boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    rebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    secrets WindowsVirtualMachineSecret[]
    One or more secret blocks as defined below.
    secureBootEnabled boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    sourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags {[key: string]: string}
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners WindowsVirtualMachineWinrmListener[]
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine 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 used for the Virtual Machine. Changing this forces a new resource to be created.
    network_interface_ids Sequence[str]
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    os_disk WindowsVirtualMachineOsDiskArgs
    A os_disk block as defined below.
    resource_group_name str
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    size str
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    additional_capabilities WindowsVirtualMachineAdditionalCapabilitiesArgs
    A additional_capabilities block as defined below.
    additional_unattend_contents Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    allow_extension_operations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availability_set_id str
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    boot_diagnostics WindowsVirtualMachineBootDiagnosticsArgs
    A boot_diagnostics block as defined below.
    bypass_platform_safety_checks_on_user_schedule_enabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacity_reservation_group_id str

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computer_name str
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. 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. Changing this forces a new resource to be created.
    dedicated_host_group_id str
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicated_host_id str
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edge_zone str
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enable_automatic_updates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryption_at_host_enabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    eviction_policy str

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensions_time_budget str
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    gallery_applications Sequence[WindowsVirtualMachineGalleryApplicationArgs]
    One or more gallery_application blocks as defined below.
    hotpatching_enabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentityArgs
    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. Possible values are None, Windows_Client and Windows_Server.
    location str
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    max_bid_price float

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

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

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patch_mode str

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    platform_fault_domain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority str
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    provision_vm_agent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximity_placement_group_id str
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    reboot_setting str

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    secrets Sequence[WindowsVirtualMachineSecretArgs]
    One or more secret blocks as defined below.
    secure_boot_enabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    source_image_id str

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    source_image_reference WindowsVirtualMachineSourceImageReferenceArgs

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Mapping[str, str]
    A mapping of tags which should be assigned to this Virtual Machine.
    termination_notification WindowsVirtualMachineTerminationNotificationArgs
    A termination_notification block as defined below.
    timezone str
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. 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.
    virtual_machine_scale_set_id str

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    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[WindowsVirtualMachineWinrmListenerArgs]
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone str
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    adminPassword String
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername String
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds List<String>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk Property Map
    A os_disk block as defined below.
    resourceGroupName String
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    size String
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    additionalCapabilities Property Map
    A additional_capabilities block as defined below.
    additionalUnattendContents List<Property Map>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    allowExtensionOperations Boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId String
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics Property Map
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled Boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId String

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName String
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData String
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId String
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId String
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates Boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled Boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy String

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget String
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications List<Property Map>
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled Boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity Property Map
    An identity block as defined below.
    licenseType String
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location String
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice Number

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

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

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode String

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan Property Map
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain Number
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority String
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    provisionVmAgent Boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId String
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    rebootSetting String

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    secrets List<Property Map>
    One or more secret blocks as defined below.
    secureBootEnabled Boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    sourceImageId String

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference Property Map

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Map<String>
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification Property Map
    A termination_notification block as defined below.
    timezone String
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData String
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineScaleSetId String

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled Boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners List<Property Map>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone String
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    PrivateIpAddresses List<string>
    A list of Private IP Addresses assigned to this Virtual Machine.
    PublicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    PublicIpAddresses List<string>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    VirtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    PrivateIpAddresses []string
    A list of Private IP Addresses assigned to this Virtual Machine.
    PublicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    PublicIpAddresses []string
    A list of the Public IP Addresses assigned to this Virtual Machine.
    VirtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIpAddress String
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses List<String>
    A list of Private IP Addresses assigned to this Virtual Machine.
    publicIpAddress String
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses List<String>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    virtualMachineId String
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    id string
    The provider-assigned unique ID for this managed resource.
    privateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses string[]
    A list of Private IP Addresses assigned to this Virtual Machine.
    publicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses string[]
    A list of the Public IP Addresses assigned to this Virtual Machine.
    virtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    id str
    The provider-assigned unique ID for this managed resource.
    private_ip_address str
    The Primary Private IP Address assigned to this Virtual Machine.
    private_ip_addresses Sequence[str]
    A list of Private IP Addresses assigned to this Virtual Machine.
    public_ip_address str
    The Primary Public IP Address assigned to this Virtual Machine.
    public_ip_addresses Sequence[str]
    A list of the Public IP Addresses assigned to this Virtual Machine.
    virtual_machine_id str
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    id String
    The provider-assigned unique ID for this managed resource.
    privateIpAddress String
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses List<String>
    A list of Private IP Addresses assigned to this Virtual Machine.
    publicIpAddress String
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses List<String>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    virtualMachineId String
    A 128-bit identifier which uniquely identifies this Virtual Machine.

    Look up Existing WindowsVirtualMachine Resource

    Get an existing WindowsVirtualMachine 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?: WindowsVirtualMachineState, opts?: CustomResourceOptions): WindowsVirtualMachine
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_capabilities: Optional[WindowsVirtualMachineAdditionalCapabilitiesArgs] = None,
            additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]] = None,
            admin_password: Optional[str] = None,
            admin_username: Optional[str] = None,
            allow_extension_operations: Optional[bool] = None,
            availability_set_id: Optional[str] = None,
            boot_diagnostics: Optional[WindowsVirtualMachineBootDiagnosticsArgs] = None,
            bypass_platform_safety_checks_on_user_schedule_enabled: Optional[bool] = None,
            capacity_reservation_group_id: Optional[str] = None,
            computer_name: Optional[str] = None,
            custom_data: Optional[str] = None,
            dedicated_host_group_id: Optional[str] = None,
            dedicated_host_id: Optional[str] = None,
            edge_zone: Optional[str] = None,
            enable_automatic_updates: Optional[bool] = None,
            encryption_at_host_enabled: Optional[bool] = None,
            eviction_policy: Optional[str] = None,
            extensions_time_budget: Optional[str] = None,
            gallery_applications: Optional[Sequence[WindowsVirtualMachineGalleryApplicationArgs]] = None,
            hotpatching_enabled: Optional[bool] = None,
            identity: Optional[WindowsVirtualMachineIdentityArgs] = None,
            license_type: Optional[str] = None,
            location: Optional[str] = None,
            max_bid_price: Optional[float] = None,
            name: Optional[str] = None,
            network_interface_ids: Optional[Sequence[str]] = None,
            os_disk: Optional[WindowsVirtualMachineOsDiskArgs] = None,
            patch_assessment_mode: Optional[str] = None,
            patch_mode: Optional[str] = None,
            plan: Optional[WindowsVirtualMachinePlanArgs] = None,
            platform_fault_domain: Optional[int] = None,
            priority: Optional[str] = None,
            private_ip_address: Optional[str] = None,
            private_ip_addresses: Optional[Sequence[str]] = None,
            provision_vm_agent: Optional[bool] = None,
            proximity_placement_group_id: Optional[str] = None,
            public_ip_address: Optional[str] = None,
            public_ip_addresses: Optional[Sequence[str]] = None,
            reboot_setting: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            secrets: Optional[Sequence[WindowsVirtualMachineSecretArgs]] = None,
            secure_boot_enabled: Optional[bool] = None,
            size: Optional[str] = None,
            source_image_id: Optional[str] = None,
            source_image_reference: Optional[WindowsVirtualMachineSourceImageReferenceArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            termination_notification: Optional[WindowsVirtualMachineTerminationNotificationArgs] = None,
            timezone: Optional[str] = None,
            user_data: Optional[str] = None,
            virtual_machine_id: Optional[str] = None,
            virtual_machine_scale_set_id: Optional[str] = None,
            vtpm_enabled: Optional[bool] = None,
            winrm_listeners: Optional[Sequence[WindowsVirtualMachineWinrmListenerArgs]] = None,
            zone: Optional[str] = None) -> WindowsVirtualMachine
    func GetWindowsVirtualMachine(ctx *Context, name string, id IDInput, state *WindowsVirtualMachineState, opts ...ResourceOption) (*WindowsVirtualMachine, error)
    public static WindowsVirtualMachine Get(string name, Input<string> id, WindowsVirtualMachineState? state, CustomResourceOptions? opts = null)
    public static WindowsVirtualMachine get(String name, Output<String> id, WindowsVirtualMachineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    AdditionalUnattendContents List<WindowsVirtualMachineAdditionalUnattendContent>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    AdminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    AdminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    AllowExtensionOperations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    AvailabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    BootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    BypassPlatformSafetyChecksOnUserScheduleEnabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    CapacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    ComputerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    CustomData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    DedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    DedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    EnableAutomaticUpdates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    EncryptionAtHostEnabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    EvictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    ExtensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    GalleryApplications List<WindowsVirtualMachineGalleryApplication>
    One or more gallery_application blocks as defined below.
    HotpatchingEnabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    Identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    LicenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    Location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    MaxBidPrice double

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    Name string
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    NetworkInterfaceIds List<string>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    OsDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    PatchAssessmentMode string

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    PatchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    Plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    PlatformFaultDomain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    Priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    PrivateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    PrivateIpAddresses List<string>
    A list of Private IP Addresses assigned to this Virtual Machine.
    ProvisionVmAgent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    ProximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    PublicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    PublicIpAddresses List<string>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    RebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    ResourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    Secrets List<WindowsVirtualMachineSecret>
    One or more secret blocks as defined below.
    SecureBootEnabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    Size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    SourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    SourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to this Virtual Machine.
    TerminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    Timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    UserData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    VirtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    VirtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    VtpmEnabled bool
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    WinrmListeners List<WindowsVirtualMachineWinrmListener>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    Zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    AdditionalCapabilities WindowsVirtualMachineAdditionalCapabilitiesArgs
    A additional_capabilities block as defined below.
    AdditionalUnattendContents []WindowsVirtualMachineAdditionalUnattendContentArgs
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    AdminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    AdminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    AllowExtensionOperations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    AvailabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    BootDiagnostics WindowsVirtualMachineBootDiagnosticsArgs
    A boot_diagnostics block as defined below.
    BypassPlatformSafetyChecksOnUserScheduleEnabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    CapacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    ComputerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    CustomData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    DedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    DedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    EdgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    EnableAutomaticUpdates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    EncryptionAtHostEnabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    EvictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    ExtensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    GalleryApplications []WindowsVirtualMachineGalleryApplicationArgs
    One or more gallery_application blocks as defined below.
    HotpatchingEnabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    Identity WindowsVirtualMachineIdentityArgs
    An identity block as defined below.
    LicenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    Location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    MaxBidPrice float64

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    Name string
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    NetworkInterfaceIds []string
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    OsDisk WindowsVirtualMachineOsDiskArgs
    A os_disk block as defined below.
    PatchAssessmentMode string

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    PatchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    Plan WindowsVirtualMachinePlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    PlatformFaultDomain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    Priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    PrivateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    PrivateIpAddresses []string
    A list of Private IP Addresses assigned to this Virtual Machine.
    ProvisionVmAgent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    ProximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    PublicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    PublicIpAddresses []string
    A list of the Public IP Addresses assigned to this Virtual Machine.
    RebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    ResourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    Secrets []WindowsVirtualMachineSecretArgs
    One or more secret blocks as defined below.
    SecureBootEnabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    Size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    SourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    SourceImageReference WindowsVirtualMachineSourceImageReferenceArgs

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    Tags map[string]string
    A mapping of tags which should be assigned to this Virtual Machine.
    TerminationNotification WindowsVirtualMachineTerminationNotificationArgs
    A termination_notification block as defined below.
    Timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    UserData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    VirtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    VirtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    VtpmEnabled bool
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    WinrmListeners []WindowsVirtualMachineWinrmListenerArgs
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    Zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    additionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    additionalUnattendContents List<WindowsVirtualMachineAdditionalUnattendContent>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    adminPassword String
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername String
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    allowExtensionOperations Boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId String
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled Boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId String

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName String
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData String
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId String
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId String
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates Boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled Boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy String

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget String
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications List<WindowsVirtualMachineGalleryApplication>
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled Boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    licenseType String
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location String
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice Double

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    name String
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds List<String>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    patchAssessmentMode String

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode String

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain Integer
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority String
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    privateIpAddress String
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses List<String>
    A list of Private IP Addresses assigned to this Virtual Machine.
    provisionVmAgent Boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId String
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    publicIpAddress String
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses List<String>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    rebootSetting String

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    resourceGroupName String
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    secrets List<WindowsVirtualMachineSecret>
    One or more secret blocks as defined below.
    secureBootEnabled Boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    size String
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    sourceImageId String

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Map<String,String>
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    timezone String
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData String
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineId String
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    virtualMachineScaleSetId String

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled Boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners List<WindowsVirtualMachineWinrmListener>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone String
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    additionalCapabilities WindowsVirtualMachineAdditionalCapabilities
    A additional_capabilities block as defined below.
    additionalUnattendContents WindowsVirtualMachineAdditionalUnattendContent[]
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    adminPassword string
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername string
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    allowExtensionOperations boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId string
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics WindowsVirtualMachineBootDiagnostics
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId string

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName string
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData string
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId string
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId string
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone string
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy string

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget string
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications WindowsVirtualMachineGalleryApplication[]
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentity
    An identity block as defined below.
    licenseType string
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location string
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice number

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    name string
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds string[]
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk WindowsVirtualMachineOsDisk
    A os_disk block as defined below.
    patchAssessmentMode string

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode string

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlan
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain number
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority string
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    privateIpAddress string
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses string[]
    A list of Private IP Addresses assigned to this Virtual Machine.
    provisionVmAgent boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId string
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    publicIpAddress string
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses string[]
    A list of the Public IP Addresses assigned to this Virtual Machine.
    rebootSetting string

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    resourceGroupName string
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    secrets WindowsVirtualMachineSecret[]
    One or more secret blocks as defined below.
    secureBootEnabled boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    size string
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    sourceImageId string

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference WindowsVirtualMachineSourceImageReference

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags {[key: string]: string}
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification WindowsVirtualMachineTerminationNotification
    A termination_notification block as defined below.
    timezone string
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData string
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineId string
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    virtualMachineScaleSetId string

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners WindowsVirtualMachineWinrmListener[]
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone string
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    additional_capabilities WindowsVirtualMachineAdditionalCapabilitiesArgs
    A additional_capabilities block as defined below.
    additional_unattend_contents Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]
    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 used for the Virtual Machine. Changing this forces a new resource to be created.
    allow_extension_operations bool
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availability_set_id str
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    boot_diagnostics WindowsVirtualMachineBootDiagnosticsArgs
    A boot_diagnostics block as defined below.
    bypass_platform_safety_checks_on_user_schedule_enabled bool

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacity_reservation_group_id str

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computer_name str
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. 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. Changing this forces a new resource to be created.
    dedicated_host_group_id str
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicated_host_id str
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edge_zone str
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enable_automatic_updates bool
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryption_at_host_enabled bool
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    eviction_policy str

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensions_time_budget str
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    gallery_applications Sequence[WindowsVirtualMachineGalleryApplicationArgs]
    One or more gallery_application blocks as defined below.
    hotpatching_enabled bool

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity WindowsVirtualMachineIdentityArgs
    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. Possible values are None, Windows_Client and Windows_Server.
    location str
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    max_bid_price float

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    name str
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    network_interface_ids Sequence[str]
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    os_disk WindowsVirtualMachineOsDiskArgs
    A os_disk block as defined below.
    patch_assessment_mode str

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patch_mode str

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan WindowsVirtualMachinePlanArgs
    A plan block as defined below. Changing this forces a new resource to be created.
    platform_fault_domain int
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority str
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    private_ip_address str
    The Primary Private IP Address assigned to this Virtual Machine.
    private_ip_addresses Sequence[str]
    A list of Private IP Addresses assigned to this Virtual Machine.
    provision_vm_agent bool

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximity_placement_group_id str
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    public_ip_address str
    The Primary Public IP Address assigned to this Virtual Machine.
    public_ip_addresses Sequence[str]
    A list of the Public IP Addresses assigned to this Virtual Machine.
    reboot_setting str

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    resource_group_name str
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    secrets Sequence[WindowsVirtualMachineSecretArgs]
    One or more secret blocks as defined below.
    secure_boot_enabled bool
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    size str
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    source_image_id str

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    source_image_reference WindowsVirtualMachineSourceImageReferenceArgs

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Mapping[str, str]
    A mapping of tags which should be assigned to this Virtual Machine.
    termination_notification WindowsVirtualMachineTerminationNotificationArgs
    A termination_notification block as defined below.
    timezone str
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. 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.
    virtual_machine_id str
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    virtual_machine_scale_set_id str

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    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[WindowsVirtualMachineWinrmListenerArgs]
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone str
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.
    additionalCapabilities Property Map
    A additional_capabilities block as defined below.
    additionalUnattendContents List<Property Map>
    One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.
    adminPassword String
    The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
    adminUsername String
    The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
    allowExtensionOperations Boolean
    Should Extension Operations be allowed on this Virtual Machine? Defaults to true.
    availabilitySetId String
    Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
    bootDiagnostics Property Map
    A boot_diagnostics block as defined below.
    bypassPlatformSafetyChecksOnUserScheduleEnabled Boolean

    Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

    NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

    capacityReservationGroupId String

    Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

    NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

    computerName String
    Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.
    customData String
    The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
    dedicatedHostGroupId String
    The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.
    dedicatedHostId String
    The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.
    edgeZone String
    Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.
    enableAutomaticUpdates Boolean
    Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.
    encryptionAtHostEnabled Boolean
    Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
    evictionPolicy String

    Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

    NOTE: This can only be configured when priority is set to Spot.

    extensionsTimeBudget String
    Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.
    galleryApplications List<Property Map>
    One or more gallery_application blocks as defined below.
    hotpatchingEnabled Boolean

    Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

    NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM's size is set to a Azure generation 2 directory within the GitHub Repository.

    identity Property Map
    An identity block as defined below.
    licenseType String
    Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.
    location String
    The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
    maxBidPrice Number

    The maximum price you're willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

    NOTE: This can only be configured when priority is set to Spot.

    name String
    The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
    networkInterfaceIds List<String>
    . A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.
    osDisk Property Map
    A os_disk block as defined below.
    patchAssessmentMode String

    Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

    NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

    patchMode String

    Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

    NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

    plan Property Map
    A plan block as defined below. Changing this forces a new resource to be created.
    platformFaultDomain Number
    Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.
    priority String
    Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.
    privateIpAddress String
    The Primary Private IP Address assigned to this Virtual Machine.
    privateIpAddresses List<String>
    A list of Private IP Addresses assigned to this Virtual Machine.
    provisionVmAgent Boolean

    Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

    NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

    proximityPlacementGroupId String
    The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
    publicIpAddress String
    The Primary Public IP Address assigned to this Virtual Machine.
    publicIpAddresses List<String>
    A list of the Public IP Addresses assigned to this Virtual Machine.
    rebootSetting String

    Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

    NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

    resourceGroupName String
    The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
    secrets List<Property Map>
    One or more secret blocks as defined below.
    secureBootEnabled Boolean
    Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    size String
    The SKU which should be used for this Virtual Machine, such as Standard_F2.
    sourceImageId String

    The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

    NOTE: One of either source_image_id or source_image_reference must be set.

    sourceImageReference Property Map

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

    NOTE: One of either source_image_id or source_image_reference must be set.

    tags Map<String>
    A mapping of tags which should be assigned to this Virtual Machine.
    terminationNotification Property Map
    A termination_notification block as defined below.
    timezone String
    Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.
    userData String
    The Base64-Encoded User Data which should be used for this Virtual Machine.
    virtualMachineId String
    A 128-bit identifier which uniquely identifies this Virtual Machine.
    virtualMachineScaleSetId String

    Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.

    NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

    vtpmEnabled Boolean
    Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
    winrmListeners List<Property Map>
    One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.
    zone String
    • zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.

    Supporting Types

    WindowsVirtualMachineAdditionalCapabilities, WindowsVirtualMachineAdditionalCapabilitiesArgs

    UltraSsdEnabled bool
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.
    UltraSsdEnabled bool
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.
    ultraSsdEnabled Boolean
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.
    ultraSsdEnabled boolean
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.
    ultra_ssd_enabled bool
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.
    ultraSsdEnabled Boolean
    Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false.

    WindowsVirtualMachineAdditionalUnattendContent, WindowsVirtualMachineAdditionalUnattendContentArgs

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

    WindowsVirtualMachineBootDiagnostics, WindowsVirtualMachineBootDiagnosticsArgs

    StorageAccountUri string

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    StorageAccountUri string

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    storageAccountUri String

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    storageAccountUri string

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    storage_account_uri str

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    storageAccountUri String

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

    NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.

    WindowsVirtualMachineGalleryApplication, WindowsVirtualMachineGalleryApplicationArgs

    VersionId string
    Specifies the Gallery Application Version resource ID.
    ConfigurationBlobUri string
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    Order int
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    Tag string
    Specifies a passthrough value for more generic context. This field can be any valid string value.
    VersionId string
    Specifies the Gallery Application Version resource ID.
    ConfigurationBlobUri string
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    Order int
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    Tag string
    Specifies a passthrough value for more generic context. This field can be any valid string value.
    versionId String
    Specifies the Gallery Application Version resource ID.
    configurationBlobUri String
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    order Integer
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    tag String
    Specifies a passthrough value for more generic context. This field can be any valid string value.
    versionId string
    Specifies the Gallery Application Version resource ID.
    configurationBlobUri string
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    order number
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    tag string
    Specifies a passthrough value for more generic context. This field can be any valid string value.
    version_id str
    Specifies the Gallery Application Version resource ID.
    configuration_blob_uri str
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    order int
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    tag str
    Specifies a passthrough value for more generic context. This field can be any valid string value.
    versionId String
    Specifies the Gallery Application Version resource ID.
    configurationBlobUri String
    Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
    order Number
    Specifies the order in which the packages have to be installed. Possible values are between 0 and 2,147,483,647.
    tag String
    Specifies a passthrough value for more generic context. This field can be any valid string value.

    WindowsVirtualMachineIdentity, WindowsVirtualMachineIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

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

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

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

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. 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.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    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. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    WindowsVirtualMachineOsDisk, WindowsVirtualMachineOsDiskArgs

    Caching string
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    StorageAccountType string
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    DiffDiskSettings WindowsVirtualMachineOsDiskDiffDiskSettings

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    DiskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    DiskSizeGb int

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    Name string
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    SecureVmDiskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    SecurityEncryptionType string

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    WriteAcceleratorEnabled bool

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    Caching string
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    StorageAccountType string
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    DiffDiskSettings WindowsVirtualMachineOsDiskDiffDiskSettings

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    DiskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    DiskSizeGb int

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    Name string
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    SecureVmDiskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    SecurityEncryptionType string

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    WriteAcceleratorEnabled bool

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    caching String
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    storageAccountType String
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    diffDiskSettings WindowsVirtualMachineOsDiskDiffDiskSettings

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    diskEncryptionSetId String

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    diskSizeGb Integer

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    name String
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    secureVmDiskEncryptionSetId String

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    securityEncryptionType String

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    writeAcceleratorEnabled Boolean

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    caching string
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    storageAccountType string
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    diffDiskSettings WindowsVirtualMachineOsDiskDiffDiskSettings

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    diskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    diskSizeGb number

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    name string
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    secureVmDiskEncryptionSetId string

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    securityEncryptionType string

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    writeAcceleratorEnabled boolean

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    caching str
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    storage_account_type str
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    diff_disk_settings WindowsVirtualMachineOsDiskDiffDiskSettings

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    disk_encryption_set_id str

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    disk_size_gb int

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    name str
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    secure_vm_disk_encryption_set_id str

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    security_encryption_type str

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    write_accelerator_enabled bool

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    caching String
    The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.
    storageAccountType String
    The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS, Premium_LRS, StandardSSD_ZRS and Premium_ZRS. Changing this forces a new resource to be created.
    diffDiskSettings Property Map

    A diff_disk_settings block as defined above. Changing this forces a new resource to be created.

    NOTE: diff_disk_settings can only be set when caching is set to ReadOnly. More information can be found here

    diskEncryptionSetId String

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with secure_vm_disk_encryption_set_id.

    NOTE: The Disk Encryption Set must have the Reader Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault

    diskSizeGb Number

    The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

    NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.

    name String
    The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
    secureVmDiskEncryptionSetId String

    The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created.

    NOTE: secure_vm_disk_encryption_set_id can only be specified when security_encryption_type is set to DiskWithVMGuestState.

    securityEncryptionType String

    Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly and DiskWithVMGuestState. Changing this forces a new resource to be created.

    NOTE: vtpm_enabled must be set to true when security_encryption_type is specified.

    NOTE: encryption_at_host_enabled cannot be set to true when security_encryption_type is set to DiskWithVMGuestState.

    writeAcceleratorEnabled Boolean

    Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

    NOTE: This requires that the storage_account_type is set to Premium_LRS and that caching is set to None.

    WindowsVirtualMachineOsDiskDiffDiskSettings, WindowsVirtualMachineOsDiskDiffDiskSettingsArgs

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

    WindowsVirtualMachinePlan, WindowsVirtualMachinePlanArgs

    Name string
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    Product string
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    Publisher string

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    Name string
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    Product string
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    Publisher string

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    name String
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    product String
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    publisher String

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    name string
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    product string
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    publisher string

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    name str
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    product str
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    publisher str

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    name String
    Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    product String
    Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
    publisher String

    Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

    NOTE: If you use the plan block with one of Microsoft's marketplace images (e.g. publisher = "MicrosoftWindowsServer"). This may prevent the purchase of the offer. An example Azure API error: The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.

    WindowsVirtualMachineSecret, WindowsVirtualMachineSecretArgs

    Certificates List<WindowsVirtualMachineSecretCertificate>
    One or more certificate blocks as defined above.
    KeyVaultId string
    The ID of the Key Vault from which all Secrets should be sourced.
    Certificates []WindowsVirtualMachineSecretCertificate
    One or more certificate blocks as defined above.
    KeyVaultId string
    The ID of the Key Vault from which all Secrets should be sourced.
    certificates List<WindowsVirtualMachineSecretCertificate>
    One or more certificate blocks as defined above.
    keyVaultId String
    The ID of the Key Vault from which all Secrets should be sourced.
    certificates WindowsVirtualMachineSecretCertificate[]
    One or more certificate blocks as defined above.
    keyVaultId string
    The ID of the Key Vault from which all Secrets should be sourced.
    certificates Sequence[WindowsVirtualMachineSecretCertificate]
    One or more certificate blocks as defined above.
    key_vault_id str
    The ID of the Key Vault from which all Secrets should be sourced.
    certificates List<Property Map>
    One or more certificate blocks as defined above.
    keyVaultId String
    The ID of the Key Vault from which all Secrets should be sourced.

    WindowsVirtualMachineSecretCertificate, WindowsVirtualMachineSecretCertificateArgs

    Store string
    The certificate store on the Virtual Machine where the certificate should be added.
    Url string

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    Store string
    The certificate store on the Virtual Machine where the certificate should be added.
    Url string

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    store String
    The certificate store on the Virtual Machine where the certificate should be added.
    url String

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    store string
    The certificate store on the Virtual Machine where the certificate should be added.
    url string

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    store str
    The certificate store on the Virtual Machine where the certificate should be added.
    url str

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    store String
    The certificate store on the Virtual Machine where the certificate should be added.
    url String

    The Secret URL of a Key Vault Certificate.

    NOTE: This can be sourced from the secret_id field within the azure.keyvault.Certificate Resource.

    WindowsVirtualMachineSourceImageReference, WindowsVirtualMachineSourceImageReferenceArgs

    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. Changing this forces a new resource to be created.
    Version string
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
    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. Changing this forces a new resource to be created.
    Version string
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
    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. Changing this forces a new resource to be created.
    version String
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
    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. Changing this forces a new resource to be created.
    version string
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
    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. Changing this forces a new resource to be created.
    version str
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
    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. Changing this forces a new resource to be created.
    version String
    Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

    WindowsVirtualMachineTerminationNotification, WindowsVirtualMachineTerminationNotificationArgs

    Enabled bool
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    Enabled bool
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    enabled Boolean
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    enabled boolean
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    enabled bool
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    enabled Boolean
    Should the termination notification be enabled on this Virtual Machine?
    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.

    NOTE: For more information about the termination notification, please refer to this doc.

    WindowsVirtualMachineWinrmListener, WindowsVirtualMachineWinrmListenerArgs

    Protocol string
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    CertificateUrl string
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.
    Protocol string
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    CertificateUrl string
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.
    protocol String
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    certificateUrl String
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.
    protocol string
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    certificateUrl string
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.
    protocol str
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    certificate_url str
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.
    protocol String
    Specifies the protocol of listener. Possible values are Http or Https. Changing this forces a new resource to be created.
    certificateUrl String
    The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https. Changing this forces a new resource to be created.

    Import

    Windows Virtual Machines can be imported using the resource id, e.g.

    $ pulumi import azure:compute/windowsVirtualMachine:WindowsVirtualMachine example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachines/machine1
    

    Package Details

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

    We recommend using Azure Native.

    Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi