subcategory | layout | page_title | description |
---|---|---|---|
Compute |
azurerm |
Azure Resource Manager: azurerm_linux_virtual_machine |
Manages a Linux Virtual Machine. |
Manages a Linux Virtual Machine.
-> Note Terraform 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. Read more about sensitive data in state.
-> Note This resource does not support Unmanaged Disks. If you need to use Unmanaged Disks you can continue to use the azurerm_virtual_machine
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 azurerm_virtual_machine
resource instead.
~> In this release there's a known issue where the public_ip_address
and public_ip_addresses
fields may not be fully populated for Dynamic Public IP's.
This example provisions a basic Linux Virtual Machine on an internal network. Additional examples of how to use the azurerm_linux_virtual_machine
resource can be found in the ./examples/virtual-machine/linux` 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_prefix = "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_linux_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"
network_interface_ids = [
azurerm_network_interface.example.id,
]
admin_ssh_key {
username = "adminuser"
public_key = file("~/.ssh/id_rsa.pub")
}
os_disk {
caching = "ReadWrite"
storage_account_type = "Standard_LRS"
}
source_image_reference {
publisher = "Canonical"
offer = "UbuntuServer"
sku = "16.04-LTS"
version = "latest"
}
}
The following arguments are supported:
-
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 Linux Virtual Machine should exist. Changing this forces a new resource to be created. -
name
- (Required) The name of the Linux Virtual Machine. Changing this forces a new resource to be created. -
network_interface_ids
- (Required). A list of Network Interface ID's 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) Aos_disk
block as defined below. -
resource_group_name
- (Required) The name of the Resource Group in which the Linux 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 asStandard_F2
.
-
additional_capabilities
- (Optional) Aadditional_capabilities
block as defined below. -
admin_password
- (Optional) The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.
-> NOTE: When an admin_password
is specified disable_password_authentication
must be set to false
.
~> NOTE: One of either admin_password
or admin_ssh_key
must be specified.
admin_ssh_key
- (Optional) One or moreadmin_ssh_key
blocks as defined below.
~> NOTE: One of either admin_password
or admin_ssh_key
must be specified.
-
allow_extension_operations
- (Optional) Should Extension Operations be allowed on this Virtual Machine? Changing this forces a new resource to be created. -
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) Aboot_diagnostics
block as defined below. -
computer_name
- (Optional) Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for thename
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
- (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. Changing this forces a new resource to be created. -
disable_password_authentication
- (Optional) Should Password Authentication be disabled on this Virtual Machine? Defaults totrue
. Changing this forces a new resource to be created.
-> In general we'd recommend using SSH Keys for authentication rather than Passwords - but there's tradeoff's to each - please see this thread for more information.
-> NOTE: When an admin_password
is specified disable_password_authentication
must be set to false
.
eviction_policy
- (Optional) Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. At this time the only supported value isDeallocate
. Changing this forces a new resource to be created.
-> NOTE: This can only be configured when priority
is set to Spot
.
-
identity
- (Optional) Anidentity
block as defined below. -
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 theeviction_policy
. Defaults to-1
, which means that the Virtual Machine should not be evicted for price reasons.
-> NOTE: This can only be configured when priority
is set to Spot
.
-
plan
- (Optional) Aplan
block as defined below. Changing this forces a new resource to be created. -
priority
- (Optional) Specifies the priority of this Virtual Machine. Possible values areRegular
andSpot
. Defaults toRegular
. 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 totrue
. 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. Changing this forces a new resource to be created. -
secret
- (Optional) One or moresecret
blocks as defined below. -
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.
-> NOTE: One of either source_image_id
or source_image_reference
must be set.
source_image_reference
- (Optional) Asource_image_reference
block as defined below. Changing this forces a new resource to be created.
-> NOTE: One of either source_image_id
or source_image_reference
must be set.
-
tags
- (Optional) A mapping of tags which should be assigned to this Virtual Machine. -
virtual_machine_scale_set_id
- (Optional) Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within. Changing this forces a new resource to be created.
~> NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azurerm_orchestrated_virtual_machine_scale_set
resource.
zone
- (Optional) The Zone in which this Virtual Machine should be created. Changing this forces a new resource to be created.
A additional_capabilities
block supports the following:
ultra_ssd_enabled
- (Optional) Should the capacity to enable Data Disks of theUltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
. Changing this forces a new resource to be created.
A admin_ssh_key
block supports the following:
-
public_key
- (Required) The Public Key which should be used for authentication, which needs to be at least 2048-bit and inssh-rsa
format. Changing this forces a new resource to be created. -
username
- (Required) The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.
-> NOTE: The Azure VM Agent only allows creating SSH Keys at the path /home/{username}/.ssh/authorized_keys
- as such this public key will be written to the authorized keys file.
A boot_diagnostics
block supports the following:
storage_account_uri
- (Required) 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:
url
- (Required) The Secret URL of a Key Vault Certificate.
-> NOTE: This can be sourced from the secret_id
field within the azurerm_key_vault_certificate
Resource.
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 isLocal
. Changing this forces a new resource to be created.
A identity
block supports the following:
-
type
- (Required) The type of Managed Identity which should be assigned to the Linux Virtual Machine. Possible values areSystemAssigned
,UserAssigned
andSystemAssigned, UserAssigned
. -
identity_ids
- (Optional) A list of User Managed Identity ID's which should be assigned to the Linux Virtual Machine.
~> NOTE: This is required when type
is set to UserAssigned
.
A os_disk
block supports the following:
-
caching
- (Required) The Type of Caching which should be used for the Internal OS Disk. Possible values areNone
,ReadOnly
andReadWrite
. -
storage_account_type
- (Required) The Type of Storage Account which should back this the Internal OS Disk. Possible values areStandard_LRS
,StandardSSD_LRS
andPremium_LRS
. Changing this forces a new resource to be created. -
diff_disk_settings
(Optional) Adiff_disk_settings
block as defined above. -
disk_encryption_set_id
- (Optional) The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk.
-> NOTE: The Disk Encryption Set must have the Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault
disk_size_gb
- (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.
-> NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
-
name
- (Optional) The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created. -
write_accelerator_enabled
- (Optional) Should Write Accelerator be Enabled for this OS Disk? Defaults tofalse
.
-> NOTE: This requires that the storage_account_type
is set to Premium_LRS
and that caching
is set to None
.
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 morecertificate
blocks as defined above. -
key_vault_id
- (Required) The ID of the Key Vault from which all Secrets should be sourced.
source_image_reference
supports the following:
-
publisher
- (Optional) Specifies the publisher of the image used to create the virtual machines. -
offer
- (Optional) Specifies the offer of the image used to create the virtual machines. -
sku
- (Optional) Specifies the SKU of the image used to create the virtual machines. -
version
- (Optional) Specifies the version of the image used to create the virtual machines.
In addition to all arguments above, the following attributes are exported:
-
id
- The ID of the Linux Virtual Machine. -
identity
- Anidentity
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 ID of the System Managed Service Principal. -
tenant_id
- The ID of the Tenant the System Managed Service Principal is assigned in.
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 45 minutes) Used when creating the Linux Virtual Machine.update
- (Defaults to 45 minutes) Used when updating the Linux Virtual Machine.delete
- (Defaults to 45 minutes) Used when deleting the Linux Virtual Machine.
Linux Virtual Machines can be imported using the resource id
, e.g.
terraform import azurerm_linux_virtual_machine.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachines/machine1