Manages a Windows Virtual Machine.
This example provisions a basic Windows Virtual Machine on an internal network. Additional examples of how to use the azurerm_windows_virtual_machine
resource can be found in the ./examples/virtual-machines/windows
directory within the GitHub Repository.
provider "azurerm" {
features {}
}
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_virtual_network" "example" {
name = "example-network"
address_space = ["10.0.0.0/16"]
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
}
resource "azurerm_subnet" "example" {
name = "internal"
resource_group_name = azurerm_resource_group.example.name
virtual_network_name = azurerm_virtual_network.example.name
address_prefixes = ["10.0.2.0/24"]
}
resource "azurerm_network_interface" "example" {
name = "example-nic"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
ip_configuration {
name = "internal"
subnet_id = azurerm_subnet.example.id
private_ip_address_allocation = "Dynamic"
}
}
resource "azurerm_windows_virtual_machine" "example" {
name = "example-machine"
resource_group_name = azurerm_resource_group.example.name
location = azurerm_resource_group.example.location
size = "Standard_F2"
admin_username = "adminuser"
admin_password = "P@$$w0rd1234!"
network_interface_ids = [
azurerm_network_interface.example.id,
]
os_disk {
caching = "ReadWrite"
storage_account_type = "Standard_LRS"
}
source_image_reference {
publisher = "MicrosoftWindowsServer"
offer = "WindowsServer"
sku = "2016-Datacenter"
version = "latest"
}
}
The following arguments are supported:
admin_password
- (Required) 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
- (Required) The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
location
- (Required) The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
name
- (Required) The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
network_interface_ids
- (Required). 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
- (Required) A os_disk
block as defined below.
resource_group_name
- (Required) 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
- (Required) The SKU which should be used for this Virtual Machine, such as Standard_F2
.
additional_capabilities
- (Optional) A additional_capabilities
block as defined below.
additional_unattend_content
- (Optional) One or more additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created.
allow_extension_operations
- (Optional) Should Extension Operations be allowed on this Virtual Machine? Defaults to true
.
availability_set_id
- (Optional) 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
- (Optional) A boot_diagnostics
block as defined below.
bypass_platform_safety_checks_on_user_schedule_enabled
- (Optional) Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false
.
capacity_reservation_group_id
- (Optional) Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.computer_name
- (Optional) Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name
field. If the value of the name
field is not a valid computer_name
, then you must specify computer_name
. Changing this forces a new resource to be created.
custom_data
- (Optional) The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
dedicated_host_id
- (Optional) The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id
.
dedicated_host_group_id
- (Optional) The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id
.
edge_zone
- (Optional) 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.
disk_controller_type
- (Optional) Specifies the Disk Controller Type used for this Virtual Machine. Possible values are SCSI
and NVMe
.
enable_automatic_updates
- (Optional) Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true
.
encryption_at_host_enabled
- (Optional) Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
eviction_policy
- (Optional) Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate
and Delete
. Changing this forces a new resource to be created.
extensions_time_budget
- (Optional) Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M
.
gallery_application
- (Optional) One or more gallery_application
blocks as defined below.
hotpatching_enabled
- (Optional) Should the VM be patched without requiring a reboot? Possible values are true
or false
. Defaults to false
. For more information about hot patching please see the product documentation.identity
- (Optional) An identity
block as defined below.
license_type
- (Optional) Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None
, Windows_Client
and Windows_Server
.
max_bid_price
- (Optional) 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.
patch_assessment_mode
- (Optional) Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform
or ImageDefault
. Defaults to ImageDefault
.patch_mode
- (Optional) Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual
, AutomaticByOS
and AutomaticByPlatform
. Defaults to AutomaticByOS
. For more information on patch modes please see the product documentation.plan
- (Optional) A plan
block as defined below. Changing this forces a new resource to be created.
platform_fault_domain
- (Optional) 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
- (Optional) Specifies the priority of this Virtual Machine. Possible values are Regular
and Spot
. Defaults to Regular
. Changing this forces a new resource to be created.
provision_vm_agent
- (Optional) 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_group_id
- (Optional) The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
reboot_setting
- (Optional) Specifies the reboot setting for platform scheduled patching. Possible values are Always
, IfRequired
and Never
.
secret
- (Optional) One or more secret
blocks as defined below.
secure_boot_enabled
- (Optional) Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
source_image_id
- (Optional) 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 and Shared Gallery Image Version ID
s.
source_image_reference
- (Optional) A source_image_reference
block as defined below. Changing this forces a new resource to be created.tags
- (Optional) A mapping of tags which should be assigned to this Virtual Machine.
os_image_notification
- (Optional) A os_image_notification
block as defined below.
termination_notification
- (Optional) A termination_notification
block as defined below.
timezone
- (Optional) 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
- (Optional) The Base64-Encoded User Data which should be used for this Virtual Machine.
virtual_machine_scale_set_id
- (Optional) Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within.
vm_agent_platform_updates_enabled
- (Optional) Specifies whether VMAgent Platform Updates is enabled. Defaults to false
.
vtpm_enabled
- (Optional) 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_listener
- (Optional) One or more winrm_listener
blocks as defined below. Changing this forces a new resource to be created.
zone
- * 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.
A additional_capabilities
block supports the following:
ultra_ssd_enabled
- (Optional) Should the capacity to enable Data Disks of the UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults to false
.
hibernation_enabled
- (Optional) Whether to enable the hibernation capability or not. Changing this forces a new Windows Virtual Machine to be created.
A additional_unattend_content
block supports the following:
content
- (Required) 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
- (Required) The name of the setting to which the content applies. Possible values are AutoLogon
and FirstLogonCommands
. Changing this forces a new resource to be created.
A boot_diagnostics
block supports the following:
storage_account_uri
- (Optional) 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.A certificate
block supports the following:
store
- (Required) The certificate store on the Virtual Machine where the certificate should be added.
url
- (Required) The Secret URL of a Key Vault Certificate.
A diff_disk_settings
block supports the following:
option
- (Required) 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
- (Optional) Specifies where to store the Ephemeral Disk. Possible values are CacheDisk
and ResourceDisk
. Defaults to CacheDisk
. Changing this forces a new resource to be created.
A gallery_application
block supports the following:
version_id
- (Required) Specifies the Gallery Application Version resource ID.
automatic_upgrade_enabled
- (Optional) Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to false
.
configuration_blob_uri
- (Optional) Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
order
- (Optional) Specifies the order in which the packages have to be installed. Possible values are between 0
and 2147483647
. Defaults to 0
.
tag
- (Optional) Specifies a passthrough value for more generic context. This field can be any valid string
value.
treat_failure_as_deployment_failure_enabled
- (Optional) Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to false
.
An identity
block supports the following:
type
- (Required) 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
- (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
A os_disk
block supports the following:
caching
- (Required) The Type of Caching which should be used for the Internal OS Disk. Possible values are None
, ReadOnly
and ReadWrite
.
storage_account_type
- (Required) The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS
, StandardSSD_LRS
, Premium_LRS
, StandardSSD_ZRS
and Premium_ZRS
. Changing this forces a new resource to be created.
diff_disk_settings
- (Optional) A diff_disk_settings
block as defined above. Changing this forces a new resource to be created.
disk_encryption_set_id
- (Optional) 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_gb
- (Optional) 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
- (Optional) The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
secure_vm_disk_encryption_set_id
- (Optional) 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_type
- (Optional) Encryption Type when the Virtual Machine is a Confidential VM. Possible values are VMGuestStateOnly
and DiskWithVMGuestState
. Changing this forces a new resource to be created.write_accelerator_enabled
- (Optional) Should Write Accelerator be Enabled for this OS Disk? Defaults to false
.A plan
block supports the following:
name
- (Required) Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
product
- (Required) Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
publisher
- (Required) Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
A secret
block supports the following:
certificate
- (Required) One or more certificate
blocks as defined above.
key_vault_id
- (Required) The ID of the Key Vault from which all Secrets should be sourced.
The source_image_reference
block supports the following:
publisher
- (Required) Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
offer
- (Required) Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku
- (Required) Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
version
- (Required) Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
A os_image_notification
block supports the following:
timeout
- (Optional) Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is PT15M
. Defaults to PT15M
.A termination_notification
block supports the following:
enabled
- (Required) Should the termination notification be enabled on this Virtual Machine?
timeout
- (Optional) Length of time (in minutes, between 5
and 15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to PT5M
.
A winrm_listener
block supports the following:
protocol
- (Required) Specifies the protocol of listener. Possible values are Http
or Https
. Changing this forces a new resource to be created.
certificate_url
- (Optional) The Secret URL of a Key Vault Certificate, which must be specified when protocol
is set to Https
. Changing this forces a new resource to be created.
In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the Windows Virtual Machine.
identity
- An identity
block as documented below.
private_ip_address
- The Primary Private IP Address assigned to this Virtual Machine.
private_ip_addresses
- A list of Private IP Addresses assigned to this Virtual Machine.
public_ip_address
- The Primary Public IP Address assigned to this Virtual Machine.
public_ip_addresses
- A list of the Public IP Addresses assigned to this Virtual Machine.
virtual_machine_id
- A 128-bit identifier which uniquely identifies this Virtual Machine.
An identity
block exports the following:
principal_id
- The Principal ID associated with this Managed Service Identity.
tenant_id
- The Tenant ID associated with this Managed Service Identity.
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 45 minutes) Used when creating the Windows Virtual Machine.update
- (Defaults to 45 minutes) Used when updating the Windows Virtual Machine.delete
- (Defaults to 45 minutes) Used when deleting the Windows Virtual Machine.read
- (Defaults to 5 minutes) Used when retrieving the Windows Virtual Machine.Windows Virtual Machines can be imported using the resource id
, e.g.
terraform import azurerm_windows_virtual_machine.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachines/machine1