Azure Classic v5.43.0, May 6 23
Azure Classic v5.43.0, May 6 23
azure.compute.WindowsVirtualMachine
Explore with Pulumi AI
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
andpublic_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 exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
{
AddressSpaces = new[]
{
"10.0.0.0/16",
},
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
{
ResourceGroupName = exampleResourceGroup.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
});
var exampleNetworkInterface = new Azure.Network.NetworkInterface("exampleNetworkInterface", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
IpConfigurations = new[]
{
new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
{
Name = "internal",
SubnetId = exampleSubnet.Id,
PrivateIpAddressAllocation = "Dynamic",
},
},
});
var exampleWindowsVirtualMachine = new Azure.Compute.WindowsVirtualMachine("exampleWindowsVirtualMachine", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.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 {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
ResourceGroupName: exampleResourceGroup.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
})
if err != nil {
return err
}
exampleNetworkInterface, err := network.NewNetworkInterface(ctx, "exampleNetworkInterface", &network.NetworkInterfaceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.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, "exampleWindowsVirtualMachine", &compute.WindowsVirtualMachineArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.addressSpaces("10.0.0.0/16")
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.build());
var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
.name("internal")
.subnetId(exampleSubnet.id())
.privateIpAddressAllocation("Dynamic")
.build())
.build());
var exampleWindowsVirtualMachine = new WindowsVirtualMachine("exampleWindowsVirtualMachine", WindowsVirtualMachineArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.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_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
address_spaces=["10.0.0.0/16"],
location=example_resource_group.location,
resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
resource_group_name=example_resource_group.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"])
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
location=example_resource_group.location,
resource_group_name=example_resource_group.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("exampleWindowsVirtualMachine",
resource_group_name=example_resource_group.name,
location=example_resource_group.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 exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
addressSpaces: ["10.0.0.0/16"],
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
resourceGroupName: exampleResourceGroup.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
ipConfigurations: [{
name: "internal",
subnetId: exampleSubnet.id,
privateIpAddressAllocation: "Dynamic",
}],
});
const exampleWindowsVirtualMachine = new azure.compute.WindowsVirtualMachine("exampleWindowsVirtualMachine", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.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:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
properties:
addressSpaces:
- 10.0.0.0/16
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
exampleSubnet:
type: azure:network:Subnet
properties:
resourceGroupName: ${exampleResourceGroup.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
exampleNetworkInterface:
type: azure:network:NetworkInterface
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
ipConfigurations:
- name: internal
subnetId: ${exampleSubnet.id}
privateIpAddressAllocation: Dynamic
exampleWindowsVirtualMachine:
type: azure:compute:WindowsVirtualMachine
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.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,
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,
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:
- Admin
Password string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface List<string>Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- Resource
Group stringName 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
.- Additional
Capabilities WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- Additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Allow
Extension boolOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- Availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- Dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- Dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- Edge
Zone 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.
- Enable
Automatic boolUpdates 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 boolHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- Gallery
Applications List<WindowsVirtual Machine Gallery Application Args> 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- Identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- License
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- Location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice 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.- Name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- Plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- Platform
Fault intDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- Provision
Vm boolAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- Proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Secrets
List<Windows
Virtual Machine Secret Args> One or more
secret
blocks as defined below.- Secure
Boot boolEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Dictionary<string, string>
A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- User
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- Vtpm
Enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners List<WindowsVirtual Machine Winrm Listener Args> 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 string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface []stringIds . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- Resource
Group stringName 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
.- Additional
Capabilities WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- Additional
Unattend []WindowsContents Virtual Machine Additional Unattend Content Args One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Allow
Extension boolOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- Availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- Dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- Dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- Edge
Zone 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.
- Enable
Automatic boolUpdates 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 boolHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- Gallery
Applications []WindowsVirtual Machine Gallery Application Args 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- Identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- License
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- Location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price 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.- Name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- Plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- Platform
Fault intDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- Provision
Vm boolAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- Proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Secrets
[]Windows
Virtual Machine Secret Args One or more
secret
blocks as defined below.- Secure
Boot boolEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- map[string]string
A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- User
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- Vtpm
Enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners []WindowsVirtual Machine Winrm Listener Args 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 String The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- resource
Group StringName 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
.- additional
Capabilities WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- allow
Extension BooleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set StringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host StringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host StringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic BooleanUpdates 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 BooleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time StringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications List<WindowsVirtual Machine Gallery Application Args> One or more
gallery_application
blocks as defined below.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license
Type String Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location String
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice 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.- name String
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault IntegerDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- provision
Vm BooleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement StringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- secrets
List<Windows
Virtual Machine Secret Args> One or more
secret
blocks as defined below.- secure
Boot BooleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Map<String,String>
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- user
Data String The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled Boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<WindowsVirtual Machine Winrm Listener Args> 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 string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface string[]Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- resource
Group stringName 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
.- additional
Capabilities WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional
Unattend WindowsContents Virtual Machine Additional Unattend Content Args[] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- allow
Extension booleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic booleanUpdates 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 booleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications WindowsVirtual Machine Gallery Application Args[] One or more
gallery_application
blocks as defined below.- hotpatching
Enabled boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice 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.- name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault numberDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- provision
Vm booleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- secrets
Windows
Virtual Machine Secret Args[] One or more
secret
blocks as defined below.- secure
Boot booleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- {[key: string]: string}
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- user
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners WindowsVirtual Machine Winrm Listener Args[] 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_ Sequence[str]ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- resource_
group_ strname 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 WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional_
unattend_ Sequence[Windowscontents Virtual Machine Additional Unattend Content Args] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- allow_
extension_ booloperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability_
set_ strid 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- 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 thename
field is not a validcomputer_name
, then you must specifycomputer_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_ strgroup_ id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated_
host_ strid 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_ boolupdates 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_ boolhost_ enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions_
time_ strbudget 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 90 minutes (
PT1H30M
).- gallery_
applications Sequence[WindowsVirtual Machine Gallery Application Args] 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license_
type str Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location str
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice 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.- name str
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch_
mode str Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform_
fault_ intdomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- provision_
vm_ boolagent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity_
placement_ strgroup_ id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- secrets
Sequence[Windows
Virtual Machine Secret Args] One or more
secret
blocks as defined below.- secure_
boot_ boolenabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source_
image_ strid 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source_
image_ Windowsreference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Mapping[str, str]
A mapping of tags which should be assigned to this Virtual Machine.
- termination_
notification WindowsVirtual Machine Termination Notification Args 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_ strscale_ set_ id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm_
enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Winrm Listener Args] 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.
- admin
Password String The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids . 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 Property Map A
os_disk
block as defined below.- resource
Group StringName 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
.- additional
Capabilities Property Map A
additional_capabilities
block as defined below.- additional
Unattend List<Property Map>Contents One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- allow
Extension BooleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set StringId 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 Property Map A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host StringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host StringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic BooleanUpdates 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 BooleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time StringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications List<Property Map> One or more
gallery_application
blocks as defined below.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity Property Map
An
identity
block as defined below.- license
Type String Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location String
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice 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.- name String
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan Property Map
A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault NumberDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- provision
Vm BooleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement StringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- secrets List<Property Map>
One or more
secret
blocks as defined below.- secure
Boot BooleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image Property MapReference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Map<String>
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification 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.
- user
Data String The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled Boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<Property Map> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- zone 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.
- Private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip List<string>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- Public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip List<string>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- Virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- Id string
The provider-assigned unique ID for this managed resource.
- Private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip []stringAddresses A list of Private IP Addresses assigned to this Virtual Machine.
- Public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip []stringAddresses A list of the Public IP Addresses assigned to this Virtual Machine.
- Virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- id String
The provider-assigned unique ID for this managed resource.
- private
Ip StringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip StringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine StringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- id string
The provider-assigned unique ID for this managed resource.
- private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip string[]Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip string[]Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- id str
The provider-assigned unique ID for this managed resource.
- private_
ip_ straddress The Primary Private IP Address assigned to this Virtual Machine.
- private_
ip_ Sequence[str]addresses A list of Private IP Addresses assigned to this Virtual Machine.
- public_
ip_ straddress The Primary Public IP Address assigned to this Virtual Machine.
- public_
ip_ Sequence[str]addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual_
machine_ strid A 128-bit identifier which uniquely identifies this Virtual Machine.
- id String
The provider-assigned unique ID for this managed resource.
- private
Ip StringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip StringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine StringId 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,
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,
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.
- Additional
Capabilities WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- Additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Admin
Password string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Allow
Extension boolOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- Availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- Dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- Dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- Edge
Zone 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.
- Enable
Automatic boolUpdates 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 boolHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- Gallery
Applications List<WindowsVirtual Machine Gallery Application Args> 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- Identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- License
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- Location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice 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.- Name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface List<string>Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- Plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- Platform
Fault intDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- Private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip List<string>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- Provision
Vm boolAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- Proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip List<string>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- Resource
Group stringName 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<Windows
Virtual Machine Secret Args> One or more
secret
blocks as defined below.- Secure
Boot boolEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Size string
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Dictionary<string, string>
A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- User
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- Virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- Vtpm
Enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners List<WindowsVirtual Machine Winrm Listener Args> 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 WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- Additional
Unattend []WindowsContents Virtual Machine Additional Unattend Content Args One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- Admin
Password string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- Admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Allow
Extension boolOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- Availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- Custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- Dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- Dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- Edge
Zone 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.
- Enable
Automatic boolUpdates 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 boolHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- Extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- Gallery
Applications []WindowsVirtual Machine Gallery Application Args 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- Identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- License
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- Location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price 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.- Name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface []stringIds . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- Plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- Platform
Fault intDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- Private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip []stringAddresses A list of Private IP Addresses assigned to this Virtual Machine.
- Provision
Vm boolAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- Proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip []stringAddresses A list of the Public IP Addresses assigned to this Virtual Machine.
- Resource
Group stringName 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
[]Windows
Virtual Machine Secret Args One or more
secret
blocks as defined below.- Secure
Boot boolEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Size string
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- map[string]string
A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- User
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- Virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- Vtpm
Enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Winrm
Listeners []WindowsVirtual Machine Winrm Listener Args 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 WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content Args> One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- admin
Password String The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension BooleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set StringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host StringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host StringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic BooleanUpdates 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 BooleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time StringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications List<WindowsVirtual Machine Gallery Application Args> One or more
gallery_application
blocks as defined below.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license
Type String Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location String
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice 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.- name String
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault IntegerDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- private
Ip StringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm BooleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement StringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip StringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- resource
Group StringName 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<Windows
Virtual Machine Secret Args> One or more
secret
blocks as defined below.- secure
Boot BooleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size String
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Map<String,String>
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- user
Data String The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine StringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled Boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<WindowsVirtual Machine Winrm Listener Args> 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 WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional
Unattend WindowsContents Virtual Machine Additional Unattend Content Args[] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- admin
Password string The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username string The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension booleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set stringId 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data string The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host stringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host stringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic booleanUpdates 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 booleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time stringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications WindowsVirtual Machine Gallery Application Args[] One or more
gallery_application
blocks as defined below.- hotpatching
Enabled boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license
Type string Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location string
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice 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.- name string
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface string[]Ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault numberDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- private
Ip stringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip string[]Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm booleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement stringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip stringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip string[]Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- resource
Group stringName 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
Windows
Virtual Machine Secret Args[] One or more
secret
blocks as defined below.- secure
Boot booleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size string
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- {[key: string]: string}
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification Args 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.
- user
Data string The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine stringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine stringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners WindowsVirtual Machine Winrm Listener Args[] 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 WindowsVirtual Machine Additional Capabilities Args A
additional_capabilities
block as defined below.- additional_
unattend_ Sequence[Windowscontents Virtual Machine Additional Unattend Content Args] One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- admin_
password str The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin_
username str The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow_
extension_ booloperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability_
set_ strid 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 WindowsVirtual Machine Boot Diagnostics Args A
boot_diagnostics
block as defined below.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- 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 thename
field is not a validcomputer_name
, then you must specifycomputer_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_ strgroup_ id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated_
host_ strid 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_ boolupdates 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_ boolhost_ enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions_
time_ strbudget 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 90 minutes (
PT1H30M
).- gallery_
applications Sequence[WindowsVirtual Machine Gallery Application Args] 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
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity
Windows
Virtual Machine Identity Args An
identity
block as defined below.- license_
type str Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location str
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice 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.- name str
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network_
interface_ Sequence[str]ids . 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 WindowsVirtual Machine Os Disk Args A
os_disk
block as defined below.- patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch_
mode str Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan
Windows
Virtual Machine Plan Args A
plan
block as defined below. Changing this forces a new resource to be created.- platform_
fault_ intdomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- private_
ip_ straddress The Primary Private IP Address assigned to this Virtual Machine.
- private_
ip_ Sequence[str]addresses A list of Private IP Addresses assigned to this Virtual Machine.
- provision_
vm_ boolagent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity_
placement_ strgroup_ id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public_
ip_ straddress The Primary Public IP Address assigned to this Virtual Machine.
- public_
ip_ Sequence[str]addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- resource_
group_ strname 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[Windows
Virtual Machine Secret Args] One or more
secret
blocks as defined below.- secure_
boot_ boolenabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size str
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- source_
image_ strid 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source_
image_ Windowsreference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Mapping[str, str]
A mapping of tags which should be assigned to this Virtual Machine.
- termination_
notification WindowsVirtual Machine Termination Notification Args 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_ strid A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual_
machine_ strscale_ set_ id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm_
enabled bool Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm_
listeners Sequence[WindowsVirtual Machine Winrm Listener Args] 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.
- additional
Capabilities Property Map A
additional_capabilities
block as defined below.- additional
Unattend List<Property Map>Contents One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.- admin
Password String The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
- admin
Username String The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension BooleanOperations Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
.- availability
Set StringId 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 Property Map A
boot_diagnostics
block as defined below.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created.- custom
Data String The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated
Host StringGroup Id The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
.- dedicated
Host StringId The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
.- edge
Zone 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.
- enable
Automatic BooleanUpdates 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 BooleanHost Enabled Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.- extensions
Time StringBudget 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 90 minutes (
PT1H30M
).- gallery
Applications List<Property Map> One or more
gallery_application
blocks as defined below.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.- identity Property Map
An
identity
block as defined below.- license
Type String Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are
None
,Windows_Client
andWindows_Server
.- location String
The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice 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.- name String
The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids . 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 Property Map A
os_disk
block as defined below.- patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.- plan Property Map
A
plan
block as defined below. Changing this forces a new resource to be created.- platform
Fault NumberDomain 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
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created.- private
Ip StringAddress The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm BooleanAgent Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to
true
. Changing this forces a new resource to be created.- proximity
Placement StringGroup Id The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip StringAddress The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses A list of the Public IP Addresses assigned to this Virtual Machine.
- resource
Group StringName 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.- secure
Boot BooleanEnabled Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size String
The SKU which should be used for this Virtual Machine, such as
Standard_F2
.- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.- source
Image Property MapReference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.- Map<String>
A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification 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.
- user
Data String The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringId A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine StringScale Set Id Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
- vtpm
Enabled Boolean Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- winrm
Listeners List<Property Map> One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created.- zone 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
- Ultra
Ssd boolEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- Ultra
Ssd boolEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- ultra
Ssd BooleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- ultra
Ssd booleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- ultra_
ssd_ boolenabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- ultra
Ssd BooleanEnabled Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
WindowsVirtualMachineAdditionalUnattendContent
- Content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- Content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content string
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting string
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content str
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting str
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
WindowsVirtualMachineBootDiagnostics
- Storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
- Storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
- storage
Account StringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
- storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
- storage_
account_ struri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
- storage
Account StringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
WindowsVirtualMachineGalleryApplication
- Version
Id string Specifies the Gallery Application Version resource ID.
- Configuration
Blob stringUri 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
and2,147,483,647
.- Tag string
Specifies a passthrough value for more generic context. This field can be any valid
string
value.
- Version
Id string Specifies the Gallery Application Version resource ID.
- Configuration
Blob stringUri 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
and2,147,483,647
.- Tag string
Specifies a passthrough value for more generic context. This field can be any valid
string
value.
- version
Id String Specifies the Gallery Application Version resource ID.
- configuration
Blob StringUri 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
and2,147,483,647
.- tag String
Specifies a passthrough value for more generic context. This field can be any valid
string
value.
- version
Id string Specifies the Gallery Application Version resource ID.
- configuration
Blob stringUri 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
and2,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_ struri 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
and2,147,483,647
.- tag str
Specifies a passthrough value for more generic context. This field can be any valid
string
value.
- version
Id String Specifies the Gallery Application Version resource ID.
- configuration
Blob StringUri 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
and2,147,483,647
.- tag String
Specifies a passthrough value for more generic context. This field can be any valid
string
value.
WindowsVirtualMachineIdentity
- 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).- Identity
Ids List<string> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- Type string
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- Identity
Ids []string Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
- Principal
Id string The Principal ID associated with this Managed Service Identity.
- Tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type String
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
- type string
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both).- identity
Ids string[] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
- principal
Id string The Principal ID associated with this Managed Service Identity.
- tenant
Id string The Tenant ID associated with this Managed Service Identity.
- type str
Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. 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.
- 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).- identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
- principal
Id String The Principal ID associated with this Managed Service Identity.
- tenant
Id String The Tenant ID associated with this Managed Service Identity.
WindowsVirtualMachineOsDisk
- Caching string
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- Storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- Diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- Disk
Size intGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- Name string
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- Secure
Vm stringDisk Encryption Set Id 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.- Security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- Write
Accelerator boolEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
- Caching string
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- Storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- Diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- Disk
Size intGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- Name string
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- Secure
Vm stringDisk Encryption Set Id 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.- Security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- Write
Accelerator boolEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
- caching String
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- storage
Account StringType The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- disk
Size IntegerGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- name String
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm StringDisk Encryption Set Id 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.- security
Encryption StringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- write
Accelerator BooleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
- caching string
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- storage
Account stringType The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- disk
Size numberGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- name string
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm stringDisk Encryption Set Id 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.- security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- write
Accelerator booleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
- caching str
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- storage_
account_ strtype The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff_
disk_ Windowssettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- disk_
encryption_ strset_ id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- disk_
size_ intgb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- name str
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure_
vm_ strdisk_ encryption_ set_ id 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.- security_
encryption_ strtype Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- write_
accelerator_ boolenabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
- caching String
The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
.- storage
Account StringType The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created.- diff
Disk Property MapSettings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.- disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.- disk
Size NumberGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
- name String
The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm StringDisk Encryption Set Id 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.- security
Encryption StringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.- write
Accelerator BooleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.
WindowsVirtualMachineOsDiskDiffDiskSettings
- Option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- Placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- Option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- Placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement String
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option string
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement string
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option str
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement str
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created.- placement String
Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
WindowsVirtualMachinePlan
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
WindowsVirtualMachineSecret
- Certificates
List<Windows
Virtual Machine Secret Certificate> One or more
certificate
blocks as defined above.- Key
Vault stringId The ID of the Key Vault from which all Secrets should be sourced.
- Certificates
[]Windows
Virtual Machine Secret Certificate One or more
certificate
blocks as defined above.- Key
Vault stringId The ID of the Key Vault from which all Secrets should be sourced.
- certificates
List<Windows
Virtual Machine Secret Certificate> One or more
certificate
blocks as defined above.- key
Vault StringId The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Windows
Virtual Machine Secret Certificate[] One or more
certificate
blocks as defined above.- key
Vault stringId The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Sequence[Windows
Virtual Machine Secret Certificate] One or more
certificate
blocks as defined above.- key_
vault_ strid The ID of the Key Vault from which all Secrets should be sourced.
- certificates List<Property Map>
One or more
certificate
blocks as defined above.- key
Vault StringId The ID of the Key Vault from which all Secrets should be sourced.
WindowsVirtualMachineSecretCertificate
WindowsVirtualMachineSourceImageReference
- 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
- Enabled bool
Should the termination notification be enabled on this Virtual Machine?
- Timeout string
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
- Enabled bool
Should the termination notification be enabled on this Virtual Machine?
- Timeout string
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
- enabled Boolean
Should the termination notification be enabled on this Virtual Machine?
- timeout String
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
- enabled boolean
Should the termination notification be enabled on this Virtual Machine?
- timeout string
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
- enabled bool
Should the termination notification be enabled on this Virtual Machine?
- timeout str
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
- enabled Boolean
Should the termination notification be enabled on this Virtual Machine?
- timeout String
Length of time (in minutes, between
5
and15
) 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 toPT5M
.
WindowsVirtualMachineWinrmListener
- Protocol string
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- Protocol string
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- Certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol string
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- certificate
Url string The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol str
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- certificate_
url str The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created.- certificate
Url String The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
Import
Windows Virtual 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.